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

Class ExternalSaslMechanismHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ExternalSaslMechanismHandlerCfgClient,ExternalSaslMechanismHandlerCfg>

org.forgerock.opendj.server.config.meta.ExternalSaslMechanismHandlerCfgDefn

public final class ExternalSaslMechanismHandlerCfgDefn
extends ManagedObjectDefinition<ExternalSaslMechanismHandlerCfgClient,ExternalSaslMechanismHandlerCfg>

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

The External SASL Mechanism Handler performs all processing related to SASL EXTERNAL authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalSaslMechanismHandlerCfgDefn.CertificateValidationPolicy	Defines the set of permissible values for the "certificate-validation-policy" property.

Method Summary

Modifier and Type	Method	Description
ExternalSaslMechanismHandlerCfgClient	createClientConfiguration(ManagedObject<? extends ExternalSaslMechanismHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
ExternalSaslMechanismHandlerCfg	createServerConfiguration(ServerManagedObject<? extends ExternalSaslMechanismHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
AttributeTypePropertyDefinition	getCertificateAttributePropertyDefinition()	Get the "certificate-attribute" property definition.
AggregationPropertyDefinition<CertificateMapperCfgClient,CertificateMapperCfg>	getCertificateMapperPropertyDefinition()	Get the "certificate-mapper" property definition.
EnumPropertyDefinition<ExternalSaslMechanismHandlerCfgDefn.CertificateValidationPolicy>	getCertificateValidationPolicyPropertyDefinition()	Get the "certificate-validation-policy" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static ExternalSaslMechanismHandlerCfgDefn	getInstance()	Get the External SASL Mechanism Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<ExternalSaslMechanismHandlerCfg>	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 ExternalSaslMechanismHandlerCfgDefn getInstance()

Get the External SASL Mechanism Handler configuration definition singleton.

Returns:

Returns the External SASL Mechanism Handler configuration definition singleton.

createClientConfiguration

public ExternalSaslMechanismHandlerCfgClient createClientConfiguration(ManagedObject<? extends ExternalSaslMechanismHandlerCfgClient> 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<ExternalSaslMechanismHandlerCfgClient,ExternalSaslMechanismHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ExternalSaslMechanismHandlerCfgClient,ExternalSaslMechanismHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ExternalSaslMechanismHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ExternalSaslMechanismHandlerCfgClient,ExternalSaslMechanismHandlerCfg>

Returns:

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

getCertificateAttributePropertyDefinition

public AttributeTypePropertyDefinition getCertificateAttributePropertyDefinition()

Get the "certificate-attribute" property definition.

Specifies the name of the attribute to hold user certificates.

This property must specify the name of a valid attribute type defined in the server schema.

Returns:

Returns the "certificate-attribute" property definition.

getCertificateMapperPropertyDefinition

public AggregationPropertyDefinition<CertificateMapperCfgClient,CertificateMapperCfg> getCertificateMapperPropertyDefinition()

Get the "certificate-mapper" property definition.

Specifies the name(s) of the certificate mapper(s) that should be used to match client certificates to user entries.

Returns:

Returns the "certificate-mapper" property definition.

getCertificateValidationPolicyPropertyDefinition

public EnumPropertyDefinition<ExternalSaslMechanismHandlerCfgDefn.CertificateValidationPolicy> getCertificateValidationPolicyPropertyDefinition()

Get the "certificate-validation-policy" property definition.

Indicates whether to attempt to validate the peer certificate against a certificate held in the user's entry.

Returns:

Returns the "certificate-validation-policy" property 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.

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.