public final class TrustStoreBackendCfgDefn extends ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>
The Trust Store Backend provides an LDAP view of a file-based trust store. It is used by the administrative cryptographic framework.
Modifier and Type | Method and 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<BackendCfgDefn.WritabilityMode> |
getWritabilityModePropertyDefinition()
Get the "writability-mode" property definition.
|
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
public static TrustStoreBackendCfgDefn getInstance()
public TrustStoreBackendCfgClient createClientConfiguration(ManagedObject<? extends TrustStoreBackendCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>
impl
- The managed object.public TrustStoreBackendCfg createServerConfiguration(ServerManagedObject<? extends TrustStoreBackendCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>
impl
- The server managed object.public Class<TrustStoreBackendCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<TrustStoreBackendCfgClient,TrustStoreBackendCfg>
public StringPropertyDefinition getBackendIdPropertyDefinition()
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.
public DNPropertyDefinition getBaseDNPropertyDefinition()
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.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
public StringPropertyDefinition getTrustStoreFilePropertyDefinition()
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.
public StringPropertyDefinition getTrustStorePinPropertyDefinition()
Specifies the clear-text PIN needed to access the Trust Store Backend .
public StringPropertyDefinition getTrustStorePinEnvironmentVariablePropertyDefinition()
Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Backend .
public StringPropertyDefinition getTrustStorePinFilePropertyDefinition()
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 .
public StringPropertyDefinition getTrustStorePinPropertyPropertyDefinition()
Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Backend .
public StringPropertyDefinition getTrustStoreTypePropertyDefinition()
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.
public EnumPropertyDefinition<BackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
Specifies the behavior that the backend should use when processing write operations.
Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.