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

Class ScramSha256SaslMechanismHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ScramSha256SaslMechanismHandlerCfgClient,ScramSha256SaslMechanismHandlerCfg>

org.forgerock.opendj.server.config.meta.ScramSha256SaslMechanismHandlerCfgDefn

public final class ScramSha256SaslMechanismHandlerCfgDefn
extends ManagedObjectDefinition<ScramSha256SaslMechanismHandlerCfgClient,ScramSha256SaslMechanismHandlerCfg>

An interface for querying the SCRAM-SHA-256 SASL Mechanism Handler managed object definition meta information.

The SCRAM-SHA-256 SASL mechanism performs all processing related to SASL SCRAM-SHA-256 authentication.

Method Summary

Modifier and Type	Method	Description
ScramSha256SaslMechanismHandlerCfgClient	createClientConfiguration(ManagedObject<? extends ScramSha256SaslMechanismHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
ScramSha256SaslMechanismHandlerCfg	createServerConfiguration(ServerManagedObject<? extends ScramSha256SaslMechanismHandlerCfg> 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 ScramSha256SaslMechanismHandlerCfgDefn	getInstance()	Get the SCRAM-SHA-256 SASL Mechanism Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<ScramSha256SaslMechanismHandlerCfg>	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, 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 ScramSha256SaslMechanismHandlerCfgDefn getInstance()

Get the SCRAM-SHA-256 SASL Mechanism Handler configuration definition singleton.

Returns:

Returns the SCRAM-SHA-256 SASL Mechanism Handler configuration definition singleton.

createClientConfiguration

public ScramSha256SaslMechanismHandlerCfgClient createClientConfiguration(ManagedObject<? extends ScramSha256SaslMechanismHandlerCfgClient> 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<ScramSha256SaslMechanismHandlerCfgClient,ScramSha256SaslMechanismHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ScramSha256SaslMechanismHandlerCfgClient,ScramSha256SaslMechanismHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ScramSha256SaslMechanismHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ScramSha256SaslMechanismHandlerCfgClient,ScramSha256SaslMechanismHandlerCfg>

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 mappers that are to be used with this SASL mechanism handler for matching the authentication or authorization ID included in SASL bind requests with users 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.