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

Class LDAPAttributeDescriptionListPluginCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<LDAPAttributeDescriptionListPluginCfgClient,LDAPAttributeDescriptionListPluginCfg>

org.forgerock.opendj.server.config.meta.LDAPAttributeDescriptionListPluginCfgDefn

public final class LDAPAttributeDescriptionListPluginCfgDefn
extends ManagedObjectDefinition<LDAPAttributeDescriptionListPluginCfgClient,LDAPAttributeDescriptionListPluginCfg>

An interface for querying the LDAP Attribute Description List Plugin managed object definition meta information.

The LDAP Attribute Description List Plugin provides the ability for clients to include an attribute list in a search request that names object classes instead of (or in addition to) attributes.

Method Summary

Modifier and Type	Method	Description
LDAPAttributeDescriptionListPluginCfgClient	createClientConfiguration(ManagedObject<? extends LDAPAttributeDescriptionListPluginCfgClient> impl)	Creates a client configuration view of the provided managed object.
LDAPAttributeDescriptionListPluginCfg	createServerConfiguration(ServerManagedObject<? extends LDAPAttributeDescriptionListPluginCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static LDAPAttributeDescriptionListPluginCfgDefn	getInstance()	Get the LDAP Attribute Description List Plugin configuration definition singleton.
BooleanPropertyDefinition	getInvokeForInternalOperationsPropertyDefinition()	Get the "invoke-for-internal-operations" property definition.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
EnumPropertyDefinition<PluginCfgDefn.PluginType>	getPluginTypePropertyDefinition()	Get the "plugin-type" property definition.
Class<LDAPAttributeDescriptionListPluginCfg>	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

Method Detail

getInstance

public static LDAPAttributeDescriptionListPluginCfgDefn getInstance()

Get the LDAP Attribute Description List Plugin configuration definition singleton.

Returns:

Returns the LDAP Attribute Description List Plugin configuration definition singleton.

createClientConfiguration

public LDAPAttributeDescriptionListPluginCfgClient createClientConfiguration(ManagedObject<? extends LDAPAttributeDescriptionListPluginCfgClient> 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<LDAPAttributeDescriptionListPluginCfgClient,LDAPAttributeDescriptionListPluginCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<LDAPAttributeDescriptionListPluginCfgClient,LDAPAttributeDescriptionListPluginCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<LDAPAttributeDescriptionListPluginCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<LDAPAttributeDescriptionListPluginCfgClient,LDAPAttributeDescriptionListPluginCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the plug-in is enabled for use.

Returns:

Returns the "enabled" property definition.

getInvokeForInternalOperationsPropertyDefinition

public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()

Get the "invoke-for-internal-operations" property definition.

Indicates whether the plug-in should be invoked for internal operations.

Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.

Returns:

Returns the "invoke-for-internal-operations" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getPluginTypePropertyDefinition

public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()

Get the "plugin-type" property definition.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Returns:

Returns the "plugin-type" property definition.