org.silverpeas.security.web
Class CipherKeyResource

java.lang.Object
  com.silverpeas.web.RESTWebService
      org.silverpeas.security.web.CipherKeyResource

@Service
@Scope(value="request")
@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 com.silverpeas.web.RESTWebService

RESTWebService.WebProcess<RETURN_VALUE>, RESTWebService.WebTreatment<RETURN_VALUE>

Field Summary

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 com.silverpeas.web.RESTWebService

RESPONSE_HEADER_ARRAYSIZE, REST_WEB_SERVICES_URI_BASE

Constructor Summary

CipherKeyResource()

Method Summary

String	getComponentId() Gets the identifier of the component instance to which the requested resource belongs to.
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.

Methods inherited from class com.silverpeas.web.RESTWebService

getBundle, getBundleLocation, getGreaterUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getUriInfo, getUserDetail, getUserPreferences, getUserRoles, process, validateUserAuthentication, validateUserAuthorization

Methods inherited from class java.lang.Object

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

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

getComponentId

public String getComponentId()

Description copied from class: RESTWebService

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

Specified by:

getComponentId in class RESTWebService

Returns:

the identifier of the Silverpeas component instance.

getToto

public javax.ws.rs.core.Response getToto()

setCipherKey

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.