Package org.opencms.security

Interface I_CmsSecretStore

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

CmsNullSecretStore, CmsRfsSecretStore

public interface I_CmsSecretStore
extends I_CmsConfigurationParameterHandler

Interface for a system-wide secret store, which can be used to access (string-valued) credentials like passwords or API keys for external services.

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
String	getSecret(String key)	Gets the secret for the given key.
void	initialize(CmsObject cmsObject)	The Admin CmsObject to use for Vfs operations, etc.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Details

getSecret

String getSecret(String key)

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).

Parameters:

key - the key for a secret

Returns:

the secret

initialize

void initialize(CmsObject cmsObject)

The Admin CmsObject to use for Vfs operations, etc.

Parameters:

cmsObject - the admin CmsObject