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

Class RegularExpressionIdentityMapperCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<RegularExpressionIdentityMapperCfgClient,RegularExpressionIdentityMapperCfg>

org.forgerock.opendj.server.config.meta.RegularExpressionIdentityMapperCfgDefn

public final class RegularExpressionIdentityMapperCfgDefn
extends ManagedObjectDefinition<RegularExpressionIdentityMapperCfgClient,RegularExpressionIdentityMapperCfg>

An interface for querying the Regular Expression Identity Mapper managed object definition meta information.

The Regular Expression Identity Mapper provides a way to use a regular expression to translate the provided identifier when searching for the appropriate user entry.

Method Summary

Modifier and Type	Method	Description
RegularExpressionIdentityMapperCfgClient	createClientConfiguration(ManagedObject<? extends RegularExpressionIdentityMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
RegularExpressionIdentityMapperCfg	createServerConfiguration(ServerManagedObject<? extends RegularExpressionIdentityMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static RegularExpressionIdentityMapperCfgDefn	getInstance()	Get the Regular Expression Identity Mapper configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
AttributeTypePropertyDefinition	getMatchAttributePropertyDefinition()	Get the "match-attribute" property definition.
DnPropertyDefinition	getMatchBaseDnPropertyDefinition()	Get the "match-base-dn" property definition.
StringPropertyDefinition	getMatchPatternPropertyDefinition()	Get the "match-pattern" property definition.
StringPropertyDefinition	getReplacePatternPropertyDefinition()	Get the "replace-pattern" property definition.
Class<RegularExpressionIdentityMapperCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static RegularExpressionIdentityMapperCfgDefn getInstance()

Get the Regular Expression Identity Mapper configuration definition singleton.

Returns:

Returns the Regular Expression Identity Mapper configuration definition singleton.

createClientConfiguration

public RegularExpressionIdentityMapperCfgClient createClientConfiguration(ManagedObject<? extends RegularExpressionIdentityMapperCfgClient> 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<RegularExpressionIdentityMapperCfgClient,RegularExpressionIdentityMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<RegularExpressionIdentityMapperCfgClient,RegularExpressionIdentityMapperCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<RegularExpressionIdentityMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<RegularExpressionIdentityMapperCfgClient,RegularExpressionIdentityMapperCfg>

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 Regular Expression Identity Mapper is enabled for use.

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 Regular Expression Identity Mapper implementation.

Returns:

Returns the "java-class" property definition.

getMatchAttributePropertyDefinition

public AttributeTypePropertyDefinition getMatchAttributePropertyDefinition()

Get the "match-attribute" property definition.

Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression.

All values must refer to the name or OID of an attribute type defined in the directory server schema. If multiple attributes or OIDs are provided, at least one of those attributes must contain the provided ID string value in exactly one entry.

Returns:

Returns the "match-attribute" property definition.

getMatchBaseDnPropertyDefinition

public DnPropertyDefinition getMatchBaseDnPropertyDefinition()

Get the "match-base-dn" property definition.

Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs.

Returns:

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

getMatchPatternPropertyDefinition

public StringPropertyDefinition getMatchPatternPropertyDefinition()

Get the "match-pattern" property definition.

Specifies the regular expression pattern that is used to identify portions of the ID string that will be replaced.

Any portion of the ID string that matches this pattern is replaced in accordance with the provided replace pattern (or is removed if no replace pattern is specified). If multiple substrings within the given ID string match this pattern, all occurrences are replaced. If no part of the given ID string matches this pattern, the ID string is not altered. Exactly one match pattern value must be provided, and it must be a valid regular expression as described in the API documentation for the java.util.regex.Pattern class, including support for capturing groups.

Returns:

Returns the "match-pattern" property definition.

getReplacePatternPropertyDefinition

public StringPropertyDefinition getReplacePatternPropertyDefinition()

Get the "replace-pattern" property definition.

Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern.

If no replacement pattern is provided, then any matching portions of the ID string will be removed (i.e., replaced with an empty string). The replacement pattern may include a string from a capturing group by using a dollar sign ($) followed by an integer value that indicates which capturing group should be used.

Returns:

Returns the "replace-pattern" property definition.