Package org.forgerock.opendj.server.config.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 obtains the trusted certificates from a trust store file.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FileBasedTrustManagerProviderCfgClient,? extends FileBasedTrustManagerProviderCfg>	definition()	Get the configuration definition associated with this File Based Trust Manager Provider.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getTrustStoreFile()	Gets the "trust-store-file" property.
ValueOrExpression<String>	getTrustStorePin()	Gets the "trust-store-pin" property.
ValueOrExpression<String>	getTrustStoreType()	Gets the "trust-store-type" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setTrustStoreFile(ValueOrExpression<String> value)	Sets the "trust-store-file" property.
void	setTrustStorePin(ValueOrExpression<String> value)	Sets the "trust-store-pin" property.
void	setTrustStoreType(ValueOrExpression<String> value)	Sets the "trust-store-type" property.

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

commit, properties

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

isEnabled, setEnabled

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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.FileBasedTrustManagerProvider

Specified by:

getJavaClass in interface TrustManagerProviderCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.

getTrustStoreFile

@MandatoryProperty
ValueOrExpression<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 OpenDJ 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

@MandatoryProperty
void setTrustStoreFile(ValueOrExpression<String> value)
                throws PropertyException

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 OpenDJ 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:

PropertyException - If the new value is invalid.

getTrustStorePin

ValueOrExpression<String> getTrustStorePin()

Gets the "trust-store-pin" property.

Specifies the clear-text PIN needed to access the File Based Trust Manager Provider .

Default value is undefined

Returns:

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

setTrustStorePin

void setTrustStorePin(ValueOrExpression<String> value)
               throws PropertyException

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:

PropertyException - If the new value is invalid.

getTrustStoreType

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

Default value is undefined

Returns:

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

setTrustStoreType

void setTrustStoreType(ValueOrExpression<String> value)
                throws PropertyException

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:

PropertyException - If the new value is invalid.