org.opends.server.admin.std.server
Interface FileBasedTrustManagerProviderCfg

All Superinterfaces:
Configuration, TrustManagerProviderCfg

public interface FileBasedTrustManagerProviderCfg
extends TrustManagerProviderCfg

A server-side interface for querying File Based Trust Manager Provider settings.

The file-based trust manager provider determines whether to trust a presented certificate based on whether that certificate exists in a server trust store file.


Method Summary
 void addFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener)
          Register to be notified when this File Based Trust Manager Provider is changed.
 java.lang.Class<? extends FileBasedTrustManagerProviderCfg> configurationClass()
          Gets the configuration class associated with this File Based Trust Manager Provider.
 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.
 void removeFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener)
          Deregister an existing File Based Trust Manager Provider configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.TrustManagerProviderCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends FileBasedTrustManagerProviderCfg> configurationClass()
Gets the configuration class associated with this File Based Trust Manager Provider.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface TrustManagerProviderCfg
Returns:
Returns the configuration class associated with this File Based Trust Manager Provider.

addFileBasedChangeListener

void addFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener)
Register to be notified when this File Based Trust Manager Provider is changed.

Parameters:
listener - The File Based Trust Manager Provider configuration change listener.

removeFileBasedChangeListener

void removeFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener)
Deregister an existing File Based Trust Manager Provider configuration change listener.

Parameters:
listener - The File Based Trust Manager Provider configuration change listener.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

The fully-qualified name of the Java class that provides the File Based Trust Manager Provider implementation.

Specified by:
getJavaClass in interface TrustManagerProviderCfg
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 containing the trust information. It can be an absolute path or a path that is relative to the OpenDS Directory Server instance root.

Changes to this configuration attribute take effect the next time that the trust manager is accessed.

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 File Based Trust Manager Provider .

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 File Based Trust Manager Provider .

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 File Based Trust Manager Provider .

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 File Based Trust Manager Provider .

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 trust store file.

Valid values always include 'JKS' and 'PKCS12', but different implementations can allow other values as well. If no value is provided, then the JVM default value is used. Changes to this configuration attribute take effect the next time that the trust manager is accessed.

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