Package org.forgerock.opendj.server.config.meta

Class TrustStoreBackendCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>

org.forgerock.opendj.server.config.meta.TrustStoreBackendCfgDefn

public final class TrustStoreBackendCfgDefn
extends ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>

An interface for querying the Trust Store Backend managed object definition meta information.

The Trust Store Backend provides an LDAP view of a file-based trust store. It is used by the administrative cryptographic framework.

Method Summary

Modifier and Type	Method	Description
TrustStoreBackendCfgClient	createClientConfiguration(ManagedObject<? extends TrustStoreBackendCfgClient> impl)	Creates a client configuration view of the provided managed object.
TrustStoreBackendCfg	createServerConfiguration(ServerManagedObject<? extends TrustStoreBackendCfg> impl)	Creates a server configuration view of the provided server managed object.
StringPropertyDefinition	getBackendIdPropertyDefinition()	Get the "backend-id" property definition.
DNPropertyDefinition	getBaseDNPropertyDefinition()	Get the "base-dn" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static TrustStoreBackendCfgDefn	getInstance()	Get the Trust Store Backend configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<TrustStoreBackendCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTrustStoreFilePropertyDefinition()	Get the "trust-store-file" property definition.
StringPropertyDefinition	getTrustStorePinEnvironmentVariablePropertyDefinition()	Get the "trust-store-pin-environment-variable" property definition.
StringPropertyDefinition	getTrustStorePinFilePropertyDefinition()	Get the "trust-store-pin-file" property definition.
StringPropertyDefinition	getTrustStorePinPropertyDefinition()	Get the "trust-store-pin" property definition.
StringPropertyDefinition	getTrustStorePinPropertyPropertyDefinition()	Get the "trust-store-pin-property" property definition.
StringPropertyDefinition	getTrustStoreTypePropertyDefinition()	Get the "trust-store-type" property definition.
EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode>	getWritabilityModePropertyDefinition()	Get the "writability-mode" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static TrustStoreBackendCfgDefn getInstance()

Get the Trust Store Backend configuration definition singleton.

Returns:

Returns the Trust Store Backend configuration definition singleton.

createClientConfiguration

public TrustStoreBackendCfgClient createClientConfiguration(ManagedObject<? extends TrustStoreBackendCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public TrustStoreBackendCfg createServerConfiguration(ServerManagedObject<? extends TrustStoreBackendCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<TrustStoreBackendCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getBackendIdPropertyDefinition

public StringPropertyDefinition getBackendIdPropertyDefinition()

Get the "backend-id" property definition.

Specifies a name to identify the associated backend.

The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.

Returns:

Returns the "backend-id" property definition.

getBaseDNPropertyDefinition

public DNPropertyDefinition getBaseDNPropertyDefinition()

Get the "base-dn" property definition.

Specifies the base DN(s) for the data that the backend handles.

A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.

Returns:

Returns the "base-dn" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the backend is enabled in the server.

If a backend is not enabled, then its contents are not accessible when processing operations.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Returns:

Returns the "java-class" property definition.

getTrustStoreFilePropertyDefinition

public StringPropertyDefinition getTrustStoreFilePropertyDefinition()

Get the "trust-store-file" property definition.

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 OpenDJ instance root.

Returns:

Returns the "trust-store-file" property definition.

getTrustStorePinPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyDefinition()

Get the "trust-store-pin" property definition.

Specifies the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the "trust-store-pin" property definition.

getTrustStorePinEnvironmentVariablePropertyDefinition

public StringPropertyDefinition getTrustStorePinEnvironmentVariablePropertyDefinition()

Get the "trust-store-pin-environment-variable" property definition.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the "trust-store-pin-environment-variable" property definition.

getTrustStorePinFilePropertyDefinition

public StringPropertyDefinition getTrustStorePinFilePropertyDefinition()

Get the "trust-store-pin-file" property definition.

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 "trust-store-pin-file" property definition.

getTrustStorePinPropertyPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyPropertyDefinition()

Get the "trust-store-pin-property" property definition.

Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Backend .

Returns:

Returns the "trust-store-pin-property" property definition.

getTrustStoreTypePropertyDefinition

public StringPropertyDefinition getTrustStoreTypePropertyDefinition()

Get the "trust-store-type" property definition.

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 "trust-store-type" property definition.

getWritabilityModePropertyDefinition

public EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()

Get the "writability-mode" property definition.

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

Returns:

Returns the "writability-mode" property definition.