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

Class PlainSaslMechanismHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<PlainSaslMechanismHandlerCfgClient,PlainSaslMechanismHandlerCfg>

org.forgerock.opendj.server.config.meta.PlainSaslMechanismHandlerCfgDefn

public final class PlainSaslMechanismHandlerCfgDefn
extends ManagedObjectDefinition<PlainSaslMechanismHandlerCfgClient,PlainSaslMechanismHandlerCfg>

An interface for querying the Plain SASL Mechanism Handler managed object definition meta information.

The Plain SASL Mechanism Handler performs all processing related to SASL PLAIN authentication.

Method Summary

Modifier and Type	Method	Description
PlainSaslMechanismHandlerCfgClient	createClientConfiguration(ManagedObject<? extends PlainSaslMechanismHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
PlainSaslMechanismHandlerCfg	createServerConfiguration(ServerManagedObject<? extends PlainSaslMechanismHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg>	getIdentityMapperPropertyDefinition()	Get the "identity-mapper" property definition.
static PlainSaslMechanismHandlerCfgDefn	getInstance()	Get the Plain SASL Mechanism Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<PlainSaslMechanismHandlerCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, 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 Details

getInstance

public static PlainSaslMechanismHandlerCfgDefn getInstance()

Get the Plain SASL Mechanism Handler configuration definition singleton.

Returns:

Returns the Plain SASL Mechanism Handler configuration definition singleton.

createClientConfiguration

public PlainSaslMechanismHandlerCfgClient createClientConfiguration(ManagedObject<? extends PlainSaslMechanismHandlerCfgClient> 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<PlainSaslMechanismHandlerCfgClient,PlainSaslMechanismHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<PlainSaslMechanismHandlerCfgClient,PlainSaslMechanismHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<PlainSaslMechanismHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<PlainSaslMechanismHandlerCfgClient,PlainSaslMechanismHandlerCfg>

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 SASL mechanism handler is enabled for use.

Returns:

Returns the "enabled" property definition.

getIdentityMapperPropertyDefinition

public AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getIdentityMapperPropertyDefinition()

Get the "identity-mapper" property definition.

Specifies the name(s) of the identity mapper(s) that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory.

Returns:

Returns the "identity-mapper" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

Returns:

Returns the "java-class" property definition.