Package org.forgerock.opendj.server.config.client

Interface TrustStoreBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient, LocalBackendCfgClient

public interface TrustStoreBackendCfgClient
extends LocalBackendCfgClient

A client-side interface for reading and modifying Trust Store Backend settings.

The Trust Store Backend provides an LDAP view of a file-based trust store. It is used by the administrative cryptographic framework.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends TrustStoreBackendCfgClient,? extends TrustStoreBackendCfg>	definition()	Get the configuration definition associated with this Trust Store Backend.
String	getJavaClass()	Gets the "java-class" property.
String	getTrustStoreFile()	Gets the "trust-store-file" property.
String	getTrustStorePin()	Gets the "trust-store-pin" property.
String	getTrustStorePinEnvironmentVariable()	Gets the "trust-store-pin-environment-variable" property.
String	getTrustStorePinFile()	Gets the "trust-store-pin-file" property.
String	getTrustStorePinProperty()	Gets the "trust-store-pin-property" property.
String	getTrustStoreType()	Gets the "trust-store-type" property.
LocalBackendCfgDefn.WritabilityMode	getWritabilityMode()	Gets the "writability-mode" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setTrustStoreFile(String value)	Sets the "trust-store-file" property.
void	setTrustStorePin(String value)	Sets the "trust-store-pin" property.
void	setTrustStorePinEnvironmentVariable(String value)	Sets the "trust-store-pin-environment-variable" property.
void	setTrustStorePinFile(String value)	Sets the "trust-store-pin-file" property.
void	setTrustStorePinProperty(String value)	Sets the "trust-store-pin-property" property.
void	setTrustStoreType(String value)	Sets the "trust-store-type" property.
void	setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value)	Sets the "writability-mode" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.BackendCfgClient

getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends TrustStoreBackendCfgClient,? extends TrustStoreBackendCfg> definition()

Get the configuration definition associated with this Trust Store Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LocalBackendCfgClient

Returns:

Returns the configuration definition associated with this Trust Store Backend.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Specified by:

getJavaClass in interface BackendCfgClient

Specified by:

getJavaClass in interface LocalBackendCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Specified by:

setJavaClass in interface BackendCfgClient

Specified by:

setJavaClass in interface LocalBackendCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getTrustStoreFile

String getTrustStoreFile()

Gets the "trust-store-file" property.

Specifies the path to the file that stores the trust information.

It may be an absolute path, or a path that is relative to the OpenDJ instance root.

Returns:

Returns the value of the "trust-store-file" property.

setTrustStoreFile

void setTrustStoreFile(String value)
                throws PropertyException

Sets the "trust-store-file" property.

Specifies the path to the file that stores the trust information.

It may be an absolute path, or a path that is relative to the OpenDJ instance root.

Parameters:

value - The value of the "trust-store-file" property.

Throws:

PropertyException - If the new value is invalid.

getTrustStorePin

String getTrustStorePin()

Gets the "trust-store-pin" property.

Specifies the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the value of the "trust-store-pin" property.

setTrustStorePin

void setTrustStorePin(String value)
               throws PropertyException

Sets the "trust-store-pin" property.

Specifies the clear-text PIN needed to access the Trust Store Backend .

Parameters:

value - The value of the "trust-store-pin" property.

Throws:

PropertyException - If the new value is invalid.

getTrustStorePinEnvironmentVariable

String getTrustStorePinEnvironmentVariable()

Gets the "trust-store-pin-environment-variable" property.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the value of the "trust-store-pin-environment-variable" property.

setTrustStorePinEnvironmentVariable

void setTrustStorePinEnvironmentVariable(String value)
                                  throws PropertyException

Sets the "trust-store-pin-environment-variable" property.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Backend .

Parameters:

value - The value of the "trust-store-pin-environment-variable" property.

Throws:

PropertyException - If the new value is invalid.

getTrustStorePinFile

String getTrustStorePinFile()

Gets the "trust-store-pin-file" property.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the value of the "trust-store-pin-file" property.

setTrustStorePinFile

void setTrustStorePinFile(String value)
                   throws PropertyException

Sets the "trust-store-pin-file" property.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Backend .

Parameters:

value - The value of the "trust-store-pin-file" property.

Throws:

PropertyException - If the new value is invalid.

getTrustStorePinProperty

String getTrustStorePinProperty()

Gets the "trust-store-pin-property" property.

Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the value of the "trust-store-pin-property" property.

setTrustStorePinProperty

void setTrustStorePinProperty(String value)
                       throws PropertyException

Sets the "trust-store-pin-property" property.

Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Backend .

Parameters:

value - The value of the "trust-store-pin-property" property.

Throws:

PropertyException - If the new value is invalid.

getTrustStoreType

String getTrustStoreType()

Gets the "trust-store-type" property.

Specifies the format for the data in the key store file.

Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well.

Returns:

Returns the value of the "trust-store-type" property.

setTrustStoreType

void setTrustStoreType(String value)
                throws PropertyException

Sets the "trust-store-type" property.

Specifies the format for the data in the key store file.

Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well.

Parameters:

value - The value of the "trust-store-type" property.

Throws:

PropertyException - If the new value is invalid.

getWritabilityMode

LocalBackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

Specifies the behavior that the backend should use when processing write operations.

Specified by:

getWritabilityMode in interface LocalBackendCfgClient

Returns:

Returns the value of the "writability-mode" property.

setWritabilityMode

void setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value)
                 throws PropertyException

Sets the "writability-mode" property.

Specifies the behavior that the backend should use when processing write operations.

Specified by:

setWritabilityMode in interface LocalBackendCfgClient

Parameters:

value - The value of the "writability-mode" property.

Throws:

PropertyException - If the new value is invalid.