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

Class UserTemplateVirtualAttributeCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<UserTemplateVirtualAttributeCfgClient,UserTemplateVirtualAttributeCfg>

org.forgerock.opendj.server.config.meta.UserTemplateVirtualAttributeCfgDefn

public final class UserTemplateVirtualAttributeCfgDefn
extends ManagedObjectDefinition<UserTemplateVirtualAttributeCfgClient,UserTemplateVirtualAttributeCfg>

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

The User Template Virtual Attribute generates attribute values using a customizable template whose expressions are replaced by values from referenced attributes in the target entry.

Method Summary

Modifier and Type	Method	Description
UserTemplateVirtualAttributeCfgClient	createClientConfiguration(ManagedObject<? extends UserTemplateVirtualAttributeCfgClient> impl)	Creates a client configuration view of the provided managed object.
UserTemplateVirtualAttributeCfg	createServerConfiguration(ServerManagedObject<? extends UserTemplateVirtualAttributeCfg> 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 UserTemplateVirtualAttributeCfgDefn	getInstance()	Get the User Template Virtual Attribute configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
EnumPropertyDefinition<VirtualAttributeCfgDefn.Scope>	getScopePropertyDefinition()	Get the "scope" property definition.
Class<UserTemplateVirtualAttributeCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTemplatePropertyDefinition()	Get the "template" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 UserTemplateVirtualAttributeCfgDefn getInstance()

Get the User Template Virtual Attribute configuration definition singleton.

Returns:

Returns the User Template Virtual Attribute configuration definition singleton.

createClientConfiguration

public UserTemplateVirtualAttributeCfgClient createClientConfiguration(ManagedObject<? extends UserTemplateVirtualAttributeCfgClient> 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 class ManagedObjectDefinition<UserTemplateVirtualAttributeCfgClient,UserTemplateVirtualAttributeCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<UserTemplateVirtualAttributeCfgClient,UserTemplateVirtualAttributeCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<UserTemplateVirtualAttributeCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<UserTemplateVirtualAttributeCfgClient,UserTemplateVirtualAttributeCfg>

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 Template 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.

getScopePropertyDefinition

public EnumPropertyDefinition<VirtualAttributeCfgDefn.Scope> getScopePropertyDefinition()

Get the "scope" property definition.

Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.

Returns:

Returns the "scope" property definition.

getTemplatePropertyDefinition

public StringPropertyDefinition getTemplatePropertyDefinition()

Get the "template" property definition.

Specifies the template that is used to generate a value(s) to be included in the virtual attribute. A string possibly containing reference attribute names surrounded by `{` and `}` whose values are to be used for building the virtual attribute. Ex: '{uid}' Default values for missing references can be specified by separating with '|' the reference attribute name and the default value. Ex: '{domain|example.com}' When '{' have to appear in the final value, they can be escaped with '\\'.

Returns:

Returns the "template" property definition.