org.opends.server.admin.std.server
Interface TrustStoreBackendCfg

All Superinterfaces:
BackendCfg, Configuration

public interface TrustStoreBackendCfg
extends BackendCfg

A server-side interface for querying 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
 void addTrustStoreChangeListener(ConfigurationChangeListener<TrustStoreBackendCfg> listener)
          Register to be notified when this Trust Store Backend is changed.
 java.lang.Class<? extends TrustStoreBackendCfg> configurationClass()
          Gets the configuration class associated with this Trust Store Backend.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getTrustStoreFile()
          Gets the "trust-store-file" property.
 java.lang.String getTrustStorePin()
          Gets the "trust-store-pin" property.
 java.lang.String getTrustStorePinEnvironmentVariable()
          Gets the "trust-store-pin-environment-variable" property.
 java.lang.String getTrustStorePinFile()
          Gets the "trust-store-pin-file" property.
 java.lang.String getTrustStorePinProperty()
          Gets the "trust-store-pin-property" property.
 java.lang.String getTrustStoreType()
          Gets the "trust-store-type" property.
 BackendCfgDefn.WritabilityMode getWritabilityMode()
          Gets the "writability-mode" property.
 void removeTrustStoreChangeListener(ConfigurationChangeListener<TrustStoreBackendCfg> listener)
          Deregister an existing Trust Store Backend configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.BackendCfg
addChangeListener, getBackendId, getBaseDN, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends TrustStoreBackendCfg> configurationClass()
Gets the configuration class associated with this Trust Store Backend.

Specified by:
configurationClass in interface BackendCfg
Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Trust Store Backend.

addTrustStoreChangeListener

void addTrustStoreChangeListener(ConfigurationChangeListener<TrustStoreBackendCfg> listener)
Register to be notified when this Trust Store Backend is changed.

Parameters:
listener - The Trust Store Backend configuration change listener.

removeTrustStoreChangeListener

void removeTrustStoreChangeListener(ConfigurationChangeListener<TrustStoreBackendCfg> listener)
Deregister an existing Trust Store Backend configuration change listener.

Parameters:
listener - The Trust Store Backend configuration change listener.

getJavaClass

java.lang.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 BackendCfg
Returns:
Returns the value of the "java-class" property.

getTrustStoreFile

java.lang.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 OpenDS Directory Server instance root.

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

getTrustStorePin

java.lang.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.

getTrustStorePinEnvironmentVariable

java.lang.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.

getTrustStorePinFile

java.lang.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.

getTrustStorePinProperty

java.lang.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.

getTrustStoreType

java.lang.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.

getWritabilityMode

BackendCfgDefn.WritabilityMode getWritabilityMode()
Gets the "writability-mode" property.

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

Specified by:
getWritabilityMode in interface BackendCfg
Returns:
Returns the value of the "writability-mode" property.