Package org.silverpeas.core.webapi.security

Class CipherKeyResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.security.CipherKeyResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("security/cipherkey")
@Authorized
public class CipherKeyResource
extends RESTWebService

A WEB resource representing the cipher key used in Silverpeas to encrypt and decrypt content.

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	CIPHER_KEY_IMPORT_SUCCESS
protected static String	CIPHER_KEY_UPDATE_FAILURE
protected static String	CIPHER_RENEW_FAILURE
protected static String	INVALID_CIPHER_KEY
static String	WEB_PATH	The path at which this REST-based web service is published, relative to the root URI of all REST-based web services in Silverpeas.

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
CipherKeyResource()

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	getToto()
javax.ws.rs.core.Response	setCipherKey(String cipherKey)	Sets the specified cipher key to encrypt and decrypt the content in Silverpeas.
void	validateUserAuthorization(UserPrivilegeValidation validation)	Validates the authorization of the user to request this web 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.WebAuthenticationValidation

validateUserAuthentication

Field Detail

WEB_PATH

public static final String WEB_PATH

The path at which this REST-based web service is published, relative to the root URI of all REST-based web services in Silverpeas.

See Also:

Constant Field Values

INVALID_CIPHER_KEY

protected static final String INVALID_CIPHER_KEY

See Also:

Constant Field Values

CIPHER_KEY_UPDATE_FAILURE

protected static final String CIPHER_KEY_UPDATE_FAILURE

See Also:

Constant Field Values

CIPHER_RENEW_FAILURE

protected static final String CIPHER_RENEW_FAILURE

See Also:

Constant Field Values

CIPHER_KEY_IMPORT_SUCCESS

protected static final String CIPHER_KEY_IMPORT_SUCCESS

See Also:

Constant Field Values

Constructor Detail

CipherKeyResource

public CipherKeyResource()

Method Detail

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.

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.

getToto

@GET
@Produces("text/plain")
public javax.ws.rs.core.Response getToto()

setCipherKey

@PUT
@Consumes("text/plain")
@Produces("text/plain")
public javax.ws.rs.core.Response setCipherKey(String cipherKey)

Sets the specified cipher key to encrypt and decrypt the content in Silverpeas.

If a cipher key was already defined, then this new one will replace it and in a such case, any content that was encrypted with the previous key will be encrypted again but with the new key.

Parameters:

cipherKey - the cipher key in hexadecimal.

Returns:

the status of the cipher key setting.

validateUserAuthorization

public void validateUserAuthorization(UserPrivilegeValidation validation)

Description copied from interface: ProtectedWebResource

Validates the authorization of the user to request this web service. For doing, the user must have the rights to access the component instance that manages this web resource. If no such component instance exists, a Not Found HTTP error is thrown (status code 404). Otherwise the validation is delegated to the validation service by passing it the required information.

This method should be invoked for web service requiring an authorized access. For doing, the authentication of the user must be first valdiated. Otherwise, the annotation Authorized can be also used instead at class level for both authentication and authorization.

Parameters:

validation - the validation instance to use.

See Also:

UserPrivilegeValidator