org.opends.server.admin.std.meta

Class DirectoryStringAttributeSyntaxCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<DirectoryStringAttributeSyntaxCfgClient,DirectoryStringAttributeSyntaxCfg>

org.opends.server.admin.std.meta.DirectoryStringAttributeSyntaxCfgDefn

public final class DirectoryStringAttributeSyntaxCfgDefn
extends ManagedObjectDefinition<DirectoryStringAttributeSyntaxCfgClient,DirectoryStringAttributeSyntaxCfg>

An interface for querying the Directory String Attribute Syntax managed object definition meta information.

The Directory String Attribute Syntax defines an attribute syntax for storing arbitrary string (and sometimes binary) data.

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryStringAttributeSyntaxCfgClient	createClientConfiguration(ManagedObject<? extends DirectoryStringAttributeSyntaxCfgClient> impl) Creates a client configuration view of the provided managed object.
DirectoryStringAttributeSyntaxCfg	createServerConfiguration(ServerManagedObject<? extends DirectoryStringAttributeSyntaxCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getAllowZeroLengthValuesPropertyDefinition() Get the "allow-zero-length-values" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static DirectoryStringAttributeSyntaxCfgDefn	getInstance() Get the Directory String Attribute Syntax configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
Class<DirectoryStringAttributeSyntaxCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object 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 DirectoryStringAttributeSyntaxCfgDefn getInstance()

Get the Directory String Attribute Syntax configuration definition singleton.

Returns:

Returns the Directory String Attribute Syntax configuration definition singleton.

createClientConfiguration

public DirectoryStringAttributeSyntaxCfgClient createClientConfiguration(ManagedObject<? extends DirectoryStringAttributeSyntaxCfgClient> 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<DirectoryStringAttributeSyntaxCfgClient,DirectoryStringAttributeSyntaxCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<DirectoryStringAttributeSyntaxCfgClient,DirectoryStringAttributeSyntaxCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<DirectoryStringAttributeSyntaxCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<DirectoryStringAttributeSyntaxCfgClient,DirectoryStringAttributeSyntaxCfg>

Returns:

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

getAllowZeroLengthValuesPropertyDefinition

public BooleanPropertyDefinition getAllowZeroLengthValuesPropertyDefinition()

Get the "allow-zero-length-values" property definition.

Indicates whether zero-length (that is, an empty string) values are allowed.

This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.

Returns:

Returns the "allow-zero-length-values" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Directory String 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 Directory String Attribute Syntax implementation.

Returns:

Returns the "java-class" property definition.