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

All Superinterfaces:
ConfigurationClient, TrustManagerProviderCfgClient

public interface FileBasedTrustManagerProviderCfgClient
extends TrustManagerProviderCfgClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends FileBasedTrustManagerProviderCfgClient,? extends FileBasedTrustManagerProviderCfg> definition()
          Get the configuration definition 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 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.
 
Methods inherited from interface org.opends.server.admin.std.client.TrustManagerProviderCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends FileBasedTrustManagerProviderCfgClient,? extends FileBasedTrustManagerProviderCfg> definition()
Get the configuration definition associated with this File Based Trust Manager Provider.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface TrustManagerProviderCfgClient
Returns:
Returns the configuration definition associated with this File Based Trust Manager Provider.

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface TrustManagerProviderCfgClient
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 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.

setTrustStoreFile

void setTrustStoreFile(java.lang.String value)
                       throws IllegalPropertyValueException
Sets 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.

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

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

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

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

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

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

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

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

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

setTrustStoreType

void setTrustStoreType(java.lang.String value)
                       throws IllegalPropertyValueException
Sets 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.

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