org.opends.server.admin.std.client
Interface TrustStoreBackendCfgClient

All Superinterfaces:
BackendCfgClient, ConfigurationClient

public interface TrustStoreBackendCfgClient
extends BackendCfgClient

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
 ManagedObjectDefinition<? extends TrustStoreBackendCfgClient,? extends TrustStoreBackendCfg> definition()
          Get the configuration definition 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 setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setTrustStoreFile(java.lang.String value)
          Sets the "trust-store-file" property.
 void setTrustStorePin(java.lang.String value)
          Sets the "trust-store-pin" property.
 void setTrustStorePinEnvironmentVariable(java.lang.String value)
          Sets the "trust-store-pin-environment-variable" property.
 void setTrustStorePinFile(java.lang.String value)
          Sets the "trust-store-pin-file" property.
 void setTrustStorePinProperty(java.lang.String value)
          Sets the "trust-store-pin-property" property.
 void setTrustStoreType(java.lang.String value)
          Sets the "trust-store-type" property.
 void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
          Sets the "writability-mode" property.
 
Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient
getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled
 
Methods inherited from interface org.opends.server.admin.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
Returns:
Returns the configuration definition associated with this Trust Store Backend.

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setTrustStoreFile

void setTrustStoreFile(java.lang.String value)
                       throws IllegalPropertyValueException
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 OpenDS Directory Server instance root.

Parameters:
value - The value of the "trust-store-file" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setTrustStorePin

void setTrustStorePin(java.lang.String value)
                      throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setTrustStorePinEnvironmentVariable

void setTrustStorePinEnvironmentVariable(java.lang.String value)
                                         throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setTrustStorePinFile

void setTrustStorePinFile(java.lang.String value)
                          throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setTrustStorePinProperty

void setTrustStorePinProperty(java.lang.String value)
                              throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setTrustStoreType

void setTrustStoreType(java.lang.String value)
                       throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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 BackendCfgClient
Returns:
Returns the value of the "writability-mode" property.

setWritabilityMode

void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
                        throws IllegalPropertyValueException
Sets the "writability-mode" property.

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

Specified by:
setWritabilityMode in interface BackendCfgClient
Parameters:
value - The value of the "writability-mode" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.