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

Class RootCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<RootCfgClient,RootCfg>

org.forgerock.opendj.server.config.meta.RootCfgDefn

public final class RootCfgDefn
extends ManagedObjectDefinition<RootCfgClient,RootCfg>

An interface for querying the Root managed object definition meta information.

The root configuration provides an entry point to the rest of the OpenDJ configuration.

Method Summary

Modifier and Type	Method	Description
RootCfgClient	createClientConfiguration(ManagedObject<? extends RootCfgClient> impl)	Creates a client configuration view of the provided managed object.
RootCfg	createServerConfiguration(ServerManagedObject<? extends RootCfg> impl)	Creates a server configuration view of the provided server managed object.
OptionalRelationDefinition<AccessControlHandlerCfgClient,AccessControlHandlerCfg>	getAccessControlHandlerRelationDefinition()	Get the "access-control-handler" relation definition.
InstantiableRelationDefinition<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg>	getAccountStatusNotificationHandlersRelationDefinition()	Get the "account-status-notification-handlers" relation definition.
SingletonRelationDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg>	getAdministrationConnectorRelationDefinition()	Get the "administration-connector" relation definition.
InstantiableRelationDefinition<AlertHandlerCfgClient,AlertHandlerCfg>	getAlertHandlersRelationDefinition()	Get the "alert-handlers" relation definition.
InstantiableRelationDefinition<BackendCfgClient,BackendCfg>	getBackendsRelationDefinition()	Get the "backends" relation definition.
InstantiableRelationDefinition<CertificateMapperCfgClient,CertificateMapperCfg>	getCertificateMappersRelationDefinition()	Get the "certificate-mappers" relation definition.
InstantiableRelationDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>	getConnectionHandlersRelationDefinition()	Get the "connection-handlers" relation definition.
SingletonRelationDefinition<CryptoManagerCfgClient,CryptoManagerCfg>	getCryptoManagerRelationDefinition()	Get the "crypto-manager" relation definition.
InstantiableRelationDefinition<EntryCacheCfgClient,EntryCacheCfg>	getEntryCachesRelationDefinition()	Get the "entry-caches" relation definition.
InstantiableRelationDefinition<ExtendedOperationHandlerCfgClient,ExtendedOperationHandlerCfg>	getExtendedOperationHandlersRelationDefinition()	Get the "extended-operation-handlers" relation definition.
SingletonRelationDefinition<GlobalCfgClient,GlobalCfg>	getGlobalConfigurationRelationDefinition()	Get the "global-configuration" relation definition.
InstantiableRelationDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg>	getHttpAuthorizationMechanismsRelationDefinition()	Get the "http-authorization-mechanisms" relation definition.
InstantiableRelationDefinition<HttpEndpointCfgClient,HttpEndpointCfg>	getHttpEndpointsRelationDefinition()	Get the "http-endpoints" relation definition.
InstantiableRelationDefinition<IdentityMapperCfgClient,IdentityMapperCfg>	getIdentityMappersRelationDefinition()	Get the "identity-mappers" relation definition.
static RootCfgDefn	getInstance()	Get the Root configuration definition singleton.
InstantiableRelationDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>	getKeyManagerProvidersRelationDefinition()	Get the "key-manager-providers" relation definition.
InstantiableRelationDefinition<LogPublisherCfgClient,LogPublisherCfg>	getLogPublishersRelationDefinition()	Get the "log-publishers" relation definition.
InstantiableRelationDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>	getLogRetentionPoliciesRelationDefinition()	Get the "log-retention-policies" relation definition.
InstantiableRelationDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg>	getLogRotationPoliciesRelationDefinition()	Get the "log-rotation-policies" relation definition.
InstantiableRelationDefinition<MailServerCfgClient,MailServerCfg>	getMailServersRelationDefinition()	Get the "mail-servers" relation definition.
InstantiableRelationDefinition<PasswordGeneratorCfgClient,PasswordGeneratorCfg>	getPasswordGeneratorsRelationDefinition()	Get the "password-generators" relation definition.
InstantiableRelationDefinition<AuthenticationPolicyCfgClient,AuthenticationPolicyCfg>	getPasswordPoliciesRelationDefinition()	Get the "password-policies" relation definition.
InstantiableRelationDefinition<PasswordStorageSchemeCfgClient,PasswordStorageSchemeCfg>	getPasswordStorageSchemesRelationDefinition()	Get the "password-storage-schemes" relation definition.
InstantiableRelationDefinition<PasswordValidatorCfgClient,PasswordValidatorCfg>	getPasswordValidatorsRelationDefinition()	Get the "password-validators" relation definition.
SingletonRelationDefinition<PluginRootCfgClient,PluginRootCfg>	getPluginRootRelationDefinition()	Get the "plugin-root" relation definition.
SingletonRelationDefinition<RootDseBackendCfgClient,RootDseBackendCfg>	getRootDseBackendRelationDefinition()	Get the "root-dse-backend" relation definition.
InstantiableRelationDefinition<SaslMechanismHandlerCfgClient,SaslMechanismHandlerCfg>	getSaslMechanismHandlersRelationDefinition()	Get the "sasl-mechanism-handlers" relation definition.
InstantiableRelationDefinition<SchemaProviderCfgClient,SchemaProviderCfg>	getSchemaProvidersRelationDefinition()	Get the "schema-providers" relation definition.
Class<RootCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
InstantiableRelationDefinition<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg>	getServiceDiscoveryMechanismsRelationDefinition()	Get the "service-discovery-mechanisms" relation definition.
InstantiableRelationDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg>	getSynchronizationProvidersRelationDefinition()	Get the "synchronization-providers" relation definition.
InstantiableRelationDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg>	getTrustManagerProvidersRelationDefinition()	Get the "trust-manager-providers" relation definition.
InstantiableRelationDefinition<VirtualAttributeCfgClient,VirtualAttributeCfg>	getVirtualAttributesRelationDefinition()	Get the "virtual-attributes" relation definition.
SingletonRelationDefinition<WorkQueueCfgClient,WorkQueueCfg>	getWorkQueueRelationDefinition()	Get the "work-queue" relation definition.

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

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 Details

getInstance

public static RootCfgDefn getInstance()

Get the Root configuration definition singleton.

Returns:

Returns the Root configuration definition singleton.

createClientConfiguration

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

Description copied from class: ManagedObjectDefinition

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<RootCfgClient,RootCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<RootCfgClient,RootCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<RootCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<RootCfgClient,RootCfg>

Returns:

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

getAccessControlHandlerRelationDefinition

public OptionalRelationDefinition<AccessControlHandlerCfgClient,AccessControlHandlerCfg> getAccessControlHandlerRelationDefinition()

Get the "access-control-handler" relation definition.

Returns:

Returns the "access-control-handler" relation definition.

getAccountStatusNotificationHandlersRelationDefinition

public InstantiableRelationDefinition<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg> getAccountStatusNotificationHandlersRelationDefinition()

Get the "account-status-notification-handlers" relation definition.

Returns:

Returns the "account-status-notification-handlers" relation definition.

getAdministrationConnectorRelationDefinition

public SingletonRelationDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg> getAdministrationConnectorRelationDefinition()

Get the "administration-connector" relation definition.

Returns:

Returns the "administration-connector" relation definition.

getAlertHandlersRelationDefinition

public InstantiableRelationDefinition<AlertHandlerCfgClient,AlertHandlerCfg> getAlertHandlersRelationDefinition()

Get the "alert-handlers" relation definition.

Returns:

Returns the "alert-handlers" relation definition.

getBackendsRelationDefinition

public InstantiableRelationDefinition<BackendCfgClient,BackendCfg> getBackendsRelationDefinition()

Get the "backends" relation definition.

Returns:

Returns the "backends" relation definition.

getCertificateMappersRelationDefinition

public InstantiableRelationDefinition<CertificateMapperCfgClient,CertificateMapperCfg> getCertificateMappersRelationDefinition()

Get the "certificate-mappers" relation definition.

Returns:

Returns the "certificate-mappers" relation definition.

getConnectionHandlersRelationDefinition

public InstantiableRelationDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg> getConnectionHandlersRelationDefinition()

Get the "connection-handlers" relation definition.

Returns:

Returns the "connection-handlers" relation definition.

getCryptoManagerRelationDefinition

public SingletonRelationDefinition<CryptoManagerCfgClient,CryptoManagerCfg> getCryptoManagerRelationDefinition()

Get the "crypto-manager" relation definition.

Returns:

Returns the "crypto-manager" relation definition.

getEntryCachesRelationDefinition

public InstantiableRelationDefinition<EntryCacheCfgClient,EntryCacheCfg> getEntryCachesRelationDefinition()

Get the "entry-caches" relation definition.

Returns:

Returns the "entry-caches" relation definition.

getExtendedOperationHandlersRelationDefinition

public InstantiableRelationDefinition<ExtendedOperationHandlerCfgClient,ExtendedOperationHandlerCfg> getExtendedOperationHandlersRelationDefinition()

Get the "extended-operation-handlers" relation definition.

Returns:

Returns the "extended-operation-handlers" relation definition.

getGlobalConfigurationRelationDefinition

public SingletonRelationDefinition<GlobalCfgClient,GlobalCfg> getGlobalConfigurationRelationDefinition()

Get the "global-configuration" relation definition.

Returns:

Returns the "global-configuration" relation definition.

getHttpAuthorizationMechanismsRelationDefinition

public InstantiableRelationDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg> getHttpAuthorizationMechanismsRelationDefinition()

Get the "http-authorization-mechanisms" relation definition.

Returns:

Returns the "http-authorization-mechanisms" relation definition.

getHttpEndpointsRelationDefinition

public InstantiableRelationDefinition<HttpEndpointCfgClient,HttpEndpointCfg> getHttpEndpointsRelationDefinition()

Get the "http-endpoints" relation definition.

Returns:

Returns the "http-endpoints" relation definition.

getIdentityMappersRelationDefinition

public InstantiableRelationDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getIdentityMappersRelationDefinition()

Get the "identity-mappers" relation definition.

Returns:

Returns the "identity-mappers" relation definition.

getKeyManagerProvidersRelationDefinition

public InstantiableRelationDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProvidersRelationDefinition()

Get the "key-manager-providers" relation definition.

Returns:

Returns the "key-manager-providers" relation definition.

getLogPublishersRelationDefinition

public InstantiableRelationDefinition<LogPublisherCfgClient,LogPublisherCfg> getLogPublishersRelationDefinition()

Get the "log-publishers" relation definition.

Returns:

Returns the "log-publishers" relation definition.

getLogRetentionPoliciesRelationDefinition

public InstantiableRelationDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg> getLogRetentionPoliciesRelationDefinition()

Get the "log-retention-policies" relation definition.

Returns:

Returns the "log-retention-policies" relation definition.

getLogRotationPoliciesRelationDefinition

public InstantiableRelationDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg> getLogRotationPoliciesRelationDefinition()

Get the "log-rotation-policies" relation definition.

Returns:

Returns the "log-rotation-policies" relation definition.

getMailServersRelationDefinition

public InstantiableRelationDefinition<MailServerCfgClient,MailServerCfg> getMailServersRelationDefinition()

Get the "mail-servers" relation definition.

Returns:

Returns the "mail-servers" relation definition.

getPasswordGeneratorsRelationDefinition

public InstantiableRelationDefinition<PasswordGeneratorCfgClient,PasswordGeneratorCfg> getPasswordGeneratorsRelationDefinition()

Get the "password-generators" relation definition.

Returns:

Returns the "password-generators" relation definition.

getPasswordPoliciesRelationDefinition

public InstantiableRelationDefinition<AuthenticationPolicyCfgClient,AuthenticationPolicyCfg> getPasswordPoliciesRelationDefinition()

Get the "password-policies" relation definition.

Returns:

Returns the "password-policies" relation definition.

getPasswordStorageSchemesRelationDefinition

public InstantiableRelationDefinition<PasswordStorageSchemeCfgClient,PasswordStorageSchemeCfg> getPasswordStorageSchemesRelationDefinition()

Get the "password-storage-schemes" relation definition.

Returns:

Returns the "password-storage-schemes" relation definition.

getPasswordValidatorsRelationDefinition

public InstantiableRelationDefinition<PasswordValidatorCfgClient,PasswordValidatorCfg> getPasswordValidatorsRelationDefinition()

Get the "password-validators" relation definition.

Returns:

Returns the "password-validators" relation definition.

getPluginRootRelationDefinition

public SingletonRelationDefinition<PluginRootCfgClient,PluginRootCfg> getPluginRootRelationDefinition()

Get the "plugin-root" relation definition.

Returns:

Returns the "plugin-root" relation definition.

getRootDseBackendRelationDefinition

public SingletonRelationDefinition<RootDseBackendCfgClient,RootDseBackendCfg> getRootDseBackendRelationDefinition()

Get the "root-dse-backend" relation definition.

Returns:

Returns the "root-dse-backend" relation definition.

getSaslMechanismHandlersRelationDefinition

public InstantiableRelationDefinition<SaslMechanismHandlerCfgClient,SaslMechanismHandlerCfg> getSaslMechanismHandlersRelationDefinition()

Get the "sasl-mechanism-handlers" relation definition.

Returns:

Returns the "sasl-mechanism-handlers" relation definition.

getSchemaProvidersRelationDefinition

public InstantiableRelationDefinition<SchemaProviderCfgClient,SchemaProviderCfg> getSchemaProvidersRelationDefinition()

Get the "schema-providers" relation definition.

Returns:

Returns the "schema-providers" relation definition.

getServiceDiscoveryMechanismsRelationDefinition

public InstantiableRelationDefinition<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg> getServiceDiscoveryMechanismsRelationDefinition()

Get the "service-discovery-mechanisms" relation definition.

Returns:

Returns the "service-discovery-mechanisms" relation definition.

getSynchronizationProvidersRelationDefinition

public InstantiableRelationDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg> getSynchronizationProvidersRelationDefinition()

Get the "synchronization-providers" relation definition.

Returns:

Returns the "synchronization-providers" relation definition.

getTrustManagerProvidersRelationDefinition

public InstantiableRelationDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg> getTrustManagerProvidersRelationDefinition()

Get the "trust-manager-providers" relation definition.

Returns:

Returns the "trust-manager-providers" relation definition.

getVirtualAttributesRelationDefinition

public InstantiableRelationDefinition<VirtualAttributeCfgClient,VirtualAttributeCfg> getVirtualAttributesRelationDefinition()

Get the "virtual-attributes" relation definition.

Returns:

Returns the "virtual-attributes" relation definition.

getWorkQueueRelationDefinition

public SingletonRelationDefinition<WorkQueueCfgClient,WorkQueueCfg> getWorkQueueRelationDefinition()

Get the "work-queue" relation definition.

Returns:

Returns the "work-queue" relation definition.