Package org.silverpeas.core.webapi.session

Class SilverpeasUserSessionTokenResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.session.SilverpeasUserSessionTokenResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("session/token")
@Authenticated
public class SilverpeasUserSessionTokenResource
extends RESTWebService

This REST Web Service permits to get a SilverpeasWebTokenService.WebToken value linked to the current User Session.

Author:

silveryocha

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService

RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	PATH

Fields inherited from class org.silverpeas.core.web.rs.RESTWebService

RESPONSE_HEADER_ARRAYSIZE

Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource

BASE_PATH

Constructor Summary

Constructors

Constructor	Description
SilverpeasUserSessionTokenResource()

Method Summary

Modifier and Type	Method	Description
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
javax.ws.rs.core.Response	getToken()	Gets a SilverpeasWebTokenService.WebToken value linked to the current user session.
void	validateUserAuthentication(UserPrivilegeValidation validation)	Validates the authentication of the user requesting currently a web endpoint by using the specified user privilege validation service.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService

createWebResourceUri, fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource

validateUserAuthorization

Field Detail

PATH

protected static final String PATH

See Also:

Constant Field Values

Constructor Detail

SilverpeasUserSessionTokenResource

public SilverpeasUserSessionTokenResource()

Method Detail

validateUserAuthentication

public void validateUserAuthentication(UserPrivilegeValidation validation)

Description copied from interface: WebAuthenticationValidation

Validates the authentication of the user requesting currently a web endpoint by using the specified user privilege validation service. If no session was opened for the user, then open a new one.

This method should be invoked for web services requiring an authenticated user. Otherwise, the annotation Authenticated can be also used instead at class level.

Parameters:

validation - the validation instance to use.

See Also:

UserPrivilegeValidator

getToken

@GET
public javax.ws.rs.core.Response getToken()

Gets a SilverpeasWebTokenService.WebToken value linked to the current user session.

Returns:

a JSON object containing the token into 'token' attribute.

getComponentId

public String getComponentId()

Description copied from interface: SilverpeasWebResource

Gets the identifier of the component instance to which the requested resource belongs to.

Returns:

the identifier of the Silverpeas component instance.

getResourceBasePath

protected String getResourceBasePath()

Description copied from class: RESTWebService

Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().

Specified by:

getResourceBasePath in class RESTWebService

Returns:

the relative path that identifies this REST web service among all other REST web services.