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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<UserDefinedVirtualAttributeCfgClient,UserDefinedVirtualAttributeCfg>
          extended by org.opends.server.admin.std.meta.UserDefinedVirtualAttributeCfgDefn

public final class UserDefinedVirtualAttributeCfgDefn
extends ManagedObjectDefinition<UserDefinedVirtualAttributeCfgClient,UserDefinedVirtualAttributeCfg>

An interface for querying the User Defined Virtual Attribute managed object definition meta information.

The User Defined Virtual Attribute creates virtual attributes with user-defined values in entries that match the criteria defined in the plug-in's configuration.


Method Summary
 UserDefinedVirtualAttributeCfgClient createClientConfiguration(ManagedObject<? extends UserDefinedVirtualAttributeCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 UserDefinedVirtualAttributeCfg createServerConfiguration(ServerManagedObject<? extends UserDefinedVirtualAttributeCfg> impl)
          Creates a server configuration view of the provided server managed object.
 AttributeTypePropertyDefinition getAttributeTypePropertyDefinition()
          Get the "attribute-type" property definition.
 DNPropertyDefinition getBaseDNPropertyDefinition()
          Get the "base-dn" property definition.
 EnumPropertyDefinition<VirtualAttributeCfgDefn.ConflictBehavior> getConflictBehaviorPropertyDefinition()
          Get the "conflict-behavior" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
 StringPropertyDefinition getFilterPropertyDefinition()
          Get the "filter" property definition.
 DNPropertyDefinition getGroupDNPropertyDefinition()
          Get the "group-dn" property definition.
static UserDefinedVirtualAttributeCfgDefn getInstance()
          Get the User Defined Virtual Attribute configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<UserDefinedVirtualAttributeCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 StringPropertyDefinition getValuePropertyDefinition()
          Get the "value" 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 UserDefinedVirtualAttributeCfgDefn getInstance()
Get the User Defined Virtual Attribute configuration definition singleton.

Returns:
Returns the User Defined Virtual Attribute configuration definition singleton.

createClientConfiguration

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

createServerConfiguration

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

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

getServerConfigurationClass

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

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<UserDefinedVirtualAttributeCfgClient,UserDefinedVirtualAttributeCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getAttributeTypePropertyDefinition

public AttributeTypePropertyDefinition getAttributeTypePropertyDefinition()
Get the "attribute-type" property definition.

Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.

Returns:
Returns the "attribute-type" property definition.

getBaseDNPropertyDefinition

public DNPropertyDefinition getBaseDNPropertyDefinition()
Get the "base-dn" property definition.

Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

If no values are given, then the server generates virtual attributes anywhere in the server.

Returns:
Returns the "base-dn" property definition.

getConflictBehaviorPropertyDefinition

public EnumPropertyDefinition<VirtualAttributeCfgDefn.ConflictBehavior> getConflictBehaviorPropertyDefinition()
Get the "conflict-behavior" property definition.

Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.

Returns:
Returns the "conflict-behavior" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the User Defined Virtual Attribute is enabled for use.

Returns:
Returns the "enabled" property definition.

getFilterPropertyDefinition

public StringPropertyDefinition getFilterPropertyDefinition()
Get the "filter" property definition.

Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

If no values are given, then any entry is eligible to have the value generated. If one or more filters are specified, then only entries that match at least one of those filters are allowed to have the virtual attribute.

Returns:
Returns the "filter" property definition.

getGroupDNPropertyDefinition

public DNPropertyDefinition getGroupDNPropertyDefinition()
Get the "group-dn" property definition.

Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

If no values are given, then group membership is not taken into account when generating the virtual attribute. If one or more group DNs are specified, then only members of those groups are allowed to have the virtual attribute.

Returns:
Returns the "group-dn" property definition.

getJavaClassPropertyDefinition

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

Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.

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

getValuePropertyDefinition

public StringPropertyDefinition getValuePropertyDefinition()
Get the "value" property definition.

Specifies the values to be included in the virtual attribute.

Returns:
Returns the "value" property definition.