Package org.forgerock.opendj.config

Class ManagedObjectDefinition<C extends ConfigurationClient,S extends Configuration>

java.lang.Object

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

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

Type Parameters:

C - The type of client managed object configuration that this definition represents.

S - The type of server managed object configuration that this definition represents.

Direct Known Subclasses:

AccessControlHandlerCfgDefn, AccessLogFilteringCriteriaCfgDefn, AccessLogPublisherCfgDefn, AccountStatusNotificationHandlerCfgDefn, AdminDataTrustManagerProviderCfgDefn, AdminEndpointCfgDefn, AdministrationConnectorCfgDefn, AesPasswordStorageSchemeCfgDefn, AlertHandlerCfgDefn, AliveEndpointCfgDefn, AnonymousSaslMechanismHandlerCfgDefn, Argon2PasswordStorageSchemeCfgDefn, AttributeCleanupPluginCfgDefn, AttributeValuePasswordValidatorCfgDefn, BackendCfgDefn, BackendIndexCfgDefn, BackendVlvIndexCfgDefn, Base64PasswordStorageSchemeCfgDefn, BcryptPasswordStorageSchemeCfgDefn, BlindTrustManagerProviderCfgDefn, BlowfishPasswordStorageSchemeCfgDefn, CancelExtendedOperationHandlerCfgDefn, CertificateMapperCfgDefn, ChangeNumberControlPluginCfgDefn, CharacterSetPasswordValidatorCfgDefn, ClearPasswordStorageSchemeCfgDefn, CollectiveAttributeSubentriesVirtualAttributeCfgDefn, ConnectionHandlerCfgDefn, ConsoleErrorLogPublisherCfgDefn, CoreSchemaCfgDefn, CramMd5SaslMechanismHandlerCfgDefn, CrestMetricsEndpointCfgDefn, CryptoManagerCfgDefn, CryptPasswordStorageSchemeCfgDefn, CsvFileAccessLogPublisherCfgDefn, CsvFileHttpAccessLogPublisherCfgDefn, DebugLogPublisherCfgDefn, DebugTargetCfgDefn, DictionaryPasswordValidatorCfgDefn, DigestMd5SaslMechanismHandlerCfgDefn, DseeCompatAccessControlHandlerCfgDefn, EntityTagPluginCfgDefn, EntityTagVirtualAttributeCfgDefn, EntryCacheCfgDefn, EntryDnVirtualAttributeCfgDefn, EntryUuidPluginCfgDefn, EntryUuidVirtualAttributeCfgDefn, ErrorLogAccountStatusNotificationHandlerCfgDefn, ErrorLogPublisherCfgDefn, ExactMatchIdentityMapperCfgDefn, ExtendedOperationHandlerCfgDefn, ExternalAccessLogPublisherCfgDefn, ExternalHttpAccessLogPublisherCfgDefn, ExternalSaslMechanismHandlerCfgDefn, FifoEntryCacheCfgDefn, FileBasedAccessLogPublisherCfgDefn, FileBasedAuditLogPublisherCfgDefn, FileBasedDebugLogPublisherCfgDefn, FileBasedErrorLogPublisherCfgDefn, FileBasedHttpAccessLogPublisherCfgDefn, FileBasedKeyManagerProviderCfgDefn, FileBasedTrustManagerProviderCfgDefn, FileCountLogRetentionPolicyCfgDefn, FingerprintCertificateMapperCfgDefn, FixedTimeLogRotationPolicyCfgDefn, FractionalLdifImportPluginCfgDefn, FreeDiskSpaceLogRetentionPolicyCfgDefn, GetConnectionIdExtendedOperationHandlerCfgDefn, GetSymmetricKeyExtendedOperationHandlerCfgDefn, GlobalAccessControlPolicyCfgDefn, GlobalCfgDefn, GoverningStructureRuleVirtualAttributeCfgDefn, GraphiteMonitorReporterPluginCfgDefn, GssapiSaslMechanismHandlerCfgDefn, HasSubordinatesVirtualAttributeCfgDefn, HealthyEndpointCfgDefn, HttpAccessLogPublisherCfgDefn, HttpAnonymousAuthorizationMechanismCfgDefn, HttpBasicAuthorizationMechanismCfgDefn, HttpConnectionHandlerCfgDefn, HttpEndpointCfgDefn, HttpOauth2CtsAuthorizationMechanismCfgDefn, HttpOauth2FileAuthorizationMechanismCfgDefn, HttpOauth2OpenamAuthorizationMechanismCfgDefn, HttpOauth2TokenIntrospectionAuthorizationMechanismCfgDefn, IdentityMapperCfgDefn, IsMemberOfVirtualAttributeCfgDefn, JeBackendCfgDefn, JmxAlertHandlerCfgDefn, JmxConnectionHandlerCfgDefn, JsonEqualityMatchingRuleCfgDefn, JsonFileAccessLogPublisherCfgDefn, JsonFileHttpAccessLogPublisherCfgDefn, JsonOrderingMatchingRuleCfgDefn, JsonQueryEqualityMatchingRuleCfgDefn, KeyManagerProviderCfgDefn, LastModPluginCfgDefn, LdapAttributeDescriptionListPluginCfgDefn, LdapConnectionHandlerCfgDefn, LdapKeyManagerProviderCfgDefn, LdapPassThroughAuthenticationPolicyCfgDefn, LdapTrustManagerProviderCfgDefn, LdifBackendCfgDefn, LdifConnectionHandlerCfgDefn, LengthBasedPasswordValidatorCfgDefn, LogRetentionPolicyCfgDefn, LogRotationPolicyCfgDefn, MailServerCfgDefn, Md5PasswordStorageSchemeCfgDefn, MemberVirtualAttributeCfgDefn, MemoryBackendCfgDefn, MonitorBackendCfgDefn, NullBackendCfgDefn, NumSubordinatesVirtualAttributeCfgDefn, PasswordExpirationTimeVirtualAttributeCfgDefn, PasswordGeneratorCfgDefn, PasswordModifyExtendedOperationHandlerCfgDefn, PasswordPolicyCfgDefn, PasswordPolicyImportPluginCfgDefn, PasswordPolicyStateExtendedOperationHandlerCfgDefn, PasswordPolicySubentryVirtualAttributeCfgDefn, PasswordStorageSchemeCfgDefn, PasswordValidatorCfgDefn, Pbkdf2HmacSha256PasswordStorageSchemeCfgDefn, Pbkdf2HmacSha512PasswordStorageSchemeCfgDefn, Pbkdf2PasswordStorageSchemeCfgDefn, PemKeyManagerProviderCfgDefn, PemTrustManagerProviderCfgDefn, Pkcs11KeyManagerProviderCfgDefn, Pkcs11TrustManagerProviderCfgDefn, Pkcs5s2PasswordStorageSchemeCfgDefn, PlainSaslMechanismHandlerCfgDefn, PluginCfgDefn, PluginRootCfgDefn, PolicyBasedAccessControlHandlerCfgDefn, PrometheusEndpointCfgDefn, ProxyBackendCfgDefn, RandomPasswordGeneratorCfgDefn, Rc4PasswordStorageSchemeCfgDefn, ReferentialIntegrityPluginCfgDefn, RegularExpressionIdentityMapperCfgDefn, RepeatedCharactersPasswordValidatorCfgDefn, ReplicationDomainCfgDefn, ReplicationServerCfgDefn, ReplicationServiceDiscoveryMechanismCfgDefn, ReplicationSynchronizationProviderCfgDefn, Rest2ldapEndpointCfgDefn, RootCfgDefn, RootDseBackendCfgDefn, SaltedMd5PasswordStorageSchemeCfgDefn, SaltedSha1PasswordStorageSchemeCfgDefn, SaltedSha256PasswordStorageSchemeCfgDefn, SaltedSha384PasswordStorageSchemeCfgDefn, SaltedSha512PasswordStorageSchemeCfgDefn, SambaPasswordPluginCfgDefn, SaslMechanismHandlerCfgDefn, SchemaBackendCfgDefn, SchemaProviderCfgDefn, ScramSha256PasswordStorageSchemeCfgDefn, ScramSha256SaslMechanismHandlerCfgDefn, ScramSha512PasswordStorageSchemeCfgDefn, ScramSha512SaslMechanismHandlerCfgDefn, ServiceDiscoveryMechanismCfgDefn, SevenBitCleanPluginCfgDefn, Sha1PasswordStorageSchemeCfgDefn, SimilarityBasedPasswordValidatorCfgDefn, SizeLimitLogRetentionPolicyCfgDefn, SizeLimitLogRotationPolicyCfgDefn, SmtpAccountStatusNotificationHandlerCfgDefn, SmtpAlertHandlerCfgDefn, SnmpConnectionHandlerCfgDefn, SoftReferenceEntryCacheCfgDefn, StartTlsExtendedOperationHandlerCfgDefn, StaticServiceDiscoveryMechanismCfgDefn, StructuralObjectClassVirtualAttributeCfgDefn, SubjectAttributeToUserAttributeCertificateMapperCfgDefn, SubjectDnToUserAttributeCertificateMapperCfgDefn, SubjectEqualsDnCertificateMapperCfgDefn, SubschemaSubentryVirtualAttributeCfgDefn, SynchronizationProviderCfgDefn, TaskBackendCfgDefn, TimeLimitLogRotationPolicyCfgDefn, TraditionalWorkQueueCfgDefn, TripleDesPasswordStorageSchemeCfgDefn, TrustManagerProviderCfgDefn, UniqueAttributePluginCfgDefn, UniqueCharactersPasswordValidatorCfgDefn, UserDefinedVirtualAttributeCfgDefn, UserTemplateVirtualAttributeCfgDefn, VirtualAttributeCfgDefn, WhoAmIExtendedOperationHandlerCfgDefn, WorkQueueCfgDefn

public abstract class ManagedObjectDefinition<C extends ConfigurationClient,S extends Configuration>
extends AbstractManagedObjectDefinition<C,S>

Defines the structure of a managed object which can be instantiated.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ManagedObjectDefinition(String name, AbstractManagedObjectDefinition<? super C,? super S> parent)	Create a new managed object definition.

Method Summary

Modifier and Type	Method	Description
abstract C	createClientConfiguration(ManagedObject<? extends C> managedObject)	Creates a client configuration view of the provided managed object.
abstract S	createServerConfiguration(ServerManagedObject<? extends S> managedObject)	Creates a server configuration view of the provided server managed object.
abstract Class<S>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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

Constructor Detail

ManagedObjectDefinition

protected ManagedObjectDefinition(String name,
                                  AbstractManagedObjectDefinition<? super C,? super S> parent)

Create a new managed object definition.

Parameters:

name - The name of the definition.

parent - The parent definition, or null if there is no parent.

Method Detail

createClientConfiguration

public abstract C createClientConfiguration(ManagedObject<? extends C> managedObject)

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.

Parameters:

managedObject - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public abstract S createServerConfiguration(ServerManagedObject<? extends S> managedObject)

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

Parameters:

managedObject - The server managed object.

Returns:

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

getServerConfigurationClass

public abstract Class<S> getServerConfigurationClass()

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

Returns:

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