Package org.opencms.security

Class CmsRfsSecretStore

java.lang.Object

org.opencms.security.CmsRfsSecretStore

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsSecretStore

public class CmsRfsSecretStore
extends Object
implements I_CmsSecretStore

RFS secret store which just loads secrets from a .properties file, whose path is configured via the 'path' parameter.

This class already initializes itself in the initConfiguration() method, which means it can return secrets before the initialize() method (which does nothing) is even called.

When OpenCms is running, this class will also track modifications in the configured secrets file and reload it.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_PASSWORD	The parameter for the encryption password (use no encryption if not set) .
static final String	PARAM_PATH	The parameter used to configure the path of the properties file.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsRfsSecretStore()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String key, String value)	Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
String	getSecret(String key)	Gets the secret for the given key.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	initialize(CmsObject cmsObject)	The Admin CmsObject to use for Vfs operations, etc.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_PATH

public static final String PARAM_PATH

The parameter used to configure the path of the properties file.

See Also:

• Constant Field Values

PARAM_PASSWORD

public static final String PARAM_PASSWORD

The parameter for the encryption password (use no encryption if not set) .

See Also:

• Constant Field Values

Constructor Details

CmsRfsSecretStore

public CmsRfsSecretStore()

Method Details

addConfigurationParameter

public void addConfigurationParameter(String key,
 String value)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

key - the name of the parameter

value - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getSecret

public String getSecret(String key)

Description copied from interface: I_CmsSecretStore

Gets the secret for the given key.

If no secret is found, null will be returned.

Note: this may be called before the initialize() method, and in that case, it should not throw any exceptions (whether it can actually return something meaningful depends on the implementation).

Specified by:

getSecret in interface I_CmsSecretStore

Parameters:

key - the key for a secret

Returns:

the secret

See Also:

• I_CmsSecretStore.getSecret(java.lang.String)

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

Throws:

CmsConfigurationException - if something goes wrong

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject cmsObject)

Description copied from interface: I_CmsSecretStore

The Admin CmsObject to use for Vfs operations, etc.

Specified by:

initialize in interface I_CmsSecretStore

Parameters:

cmsObject - the admin CmsObject

See Also:

• I_CmsSecretStore.initialize(org.opencms.file.CmsObject)