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

Class CramMd5SaslMechanismHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<CramMd5SaslMechanismHandlerCfgClient,CramMd5SaslMechanismHandlerCfg>

org.forgerock.opendj.server.config.meta.CramMd5SaslMechanismHandlerCfgDefn

public final class CramMd5SaslMechanismHandlerCfgDefn
extends ManagedObjectDefinition<CramMd5SaslMechanismHandlerCfgClient,CramMd5SaslMechanismHandlerCfg>

An interface for querying the CRAM-MD5 SASL Mechanism Handler managed object definition meta information.

The CRAM-MD5 SASL mechanism provides the ability for clients to perform password-based authentication in a manner that does not expose their password in the clear.

Method Summary

Modifier and Type	Method	Description
CramMd5SaslMechanismHandlerCfgClient	createClientConfiguration(ManagedObject<? extends CramMd5SaslMechanismHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
CramMd5SaslMechanismHandlerCfg	createServerConfiguration(ServerManagedObject<? extends CramMd5SaslMechanismHandlerCfg> 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 CramMd5SaslMechanismHandlerCfgDefn	getInstance()	Get the CRAM-MD5 SASL Mechanism Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<CramMd5SaslMechanismHandlerCfg>	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 CramMd5SaslMechanismHandlerCfgDefn getInstance()

Get the CRAM-MD5 SASL Mechanism Handler configuration definition singleton.

Returns:

Returns the CRAM-MD5 SASL Mechanism Handler configuration definition singleton.

createClientConfiguration

public CramMd5SaslMechanismHandlerCfgClient createClientConfiguration(ManagedObject<? extends CramMd5SaslMechanismHandlerCfgClient> 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<CramMd5SaslMechanismHandlerCfgClient,CramMd5SaslMechanismHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<CramMd5SaslMechanismHandlerCfgClient,CramMd5SaslMechanismHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<CramMd5SaslMechanismHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<CramMd5SaslMechanismHandlerCfgClient,CramMd5SaslMechanismHandlerCfg>

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) used with this SASL mechanism handler to match the authentication 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.