org.opends.server.admin.std.meta
Class AttributeTypeDescriptionAttributeSyntaxCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<AttributeTypeDescriptionAttributeSyntaxCfgClient,AttributeTypeDescriptionAttributeSyntaxCfg>
          extended by org.opends.server.admin.std.meta.AttributeTypeDescriptionAttributeSyntaxCfgDefn

public final class AttributeTypeDescriptionAttributeSyntaxCfgDefn
extends ManagedObjectDefinition<AttributeTypeDescriptionAttributeSyntaxCfgClient,AttributeTypeDescriptionAttributeSyntaxCfg>

An interface for querying the Attribute Type Description Attribute Syntax managed object definition meta information.

Attribute Type Description Attribute Syntaxes describe the format of the directory schema attribute type definitions.


Method Summary
 AttributeTypeDescriptionAttributeSyntaxCfgClient createClientConfiguration(ManagedObject<? extends AttributeTypeDescriptionAttributeSyntaxCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 AttributeTypeDescriptionAttributeSyntaxCfg createServerConfiguration(ServerManagedObject<? extends AttributeTypeDescriptionAttributeSyntaxCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static AttributeTypeDescriptionAttributeSyntaxCfgDefn getInstance()
          Get the Attribute Type Description Attribute Syntax configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<AttributeTypeDescriptionAttributeSyntaxCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 BooleanPropertyDefinition getStripSyntaxMinUpperBoundPropertyDefinition()
          Get the "strip-syntax-min-upper-bound" property definition.
 
Methods inherited from class org.opends.server.admin.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 AttributeTypeDescriptionAttributeSyntaxCfgDefn getInstance()
Get the Attribute Type Description Attribute Syntax configuration definition singleton.

Returns:
Returns the Attribute Type Description Attribute Syntax configuration definition singleton.

createClientConfiguration

public AttributeTypeDescriptionAttributeSyntaxCfgClient createClientConfiguration(ManagedObject<? extends AttributeTypeDescriptionAttributeSyntaxCfgClient> 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<AttributeTypeDescriptionAttributeSyntaxCfgClient,AttributeTypeDescriptionAttributeSyntaxCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public AttributeTypeDescriptionAttributeSyntaxCfg createServerConfiguration(ServerManagedObject<? extends AttributeTypeDescriptionAttributeSyntaxCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<AttributeTypeDescriptionAttributeSyntaxCfgClient,AttributeTypeDescriptionAttributeSyntaxCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<AttributeTypeDescriptionAttributeSyntaxCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<AttributeTypeDescriptionAttributeSyntaxCfgClient,AttributeTypeDescriptionAttributeSyntaxCfg>
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 Attribute Type Description Attribute Syntax is enabled.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the Attribute Type Description Attribute Syntax implementation.

Returns:
Returns the "java-class" property definition.

getStripSyntaxMinUpperBoundPropertyDefinition

public BooleanPropertyDefinition getStripSyntaxMinUpperBoundPropertyDefinition()
Get the "strip-syntax-min-upper-bound" property definition.

Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off.

When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.

Returns:
Returns the "strip-syntax-min-upper-bound" property definition.