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
-
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
-
-
-
-
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)
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 classManagedObjectDefinition<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)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<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()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<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.
-
-