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

Class DigestMd5SaslMechanismHandlerCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<DigestMd5SaslMechanismHandlerCfgClient,DigestMd5SaslMechanismHandlerCfg>
org.forgerock.opendj.server.config.meta.DigestMd5SaslMechanismHandlerCfgDefn
public final class DigestMd5SaslMechanismHandlerCfgDefn extends ManagedObjectDefinition<DigestMd5SaslMechanismHandlerCfgClient,DigestMd5SaslMechanismHandlerCfg>
An interface for querying the DIGEST-MD5 SASL Mechanism Handler managed object definition meta information.

The DIGEST-MD5 SASL mechanism is used to perform all processing related to SASL DIGEST-MD5 authentication.

  • Method Details

    • getInstance

      public static DigestMd5SaslMechanismHandlerCfgDefn getInstance()
      Get the DIGEST-MD5 SASL Mechanism Handler configuration definition singleton.
      Returns:
      Returns the DIGEST-MD5 SASL Mechanism Handler configuration definition singleton.

    • createClientConfiguration

      public DigestMd5SaslMechanismHandlerCfgClient createClientConfiguration(ManagedObject<? extends DigestMd5SaslMechanismHandlerCfgClient> 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<DigestMd5SaslMechanismHandlerCfgClient,DigestMd5SaslMechanismHandlerCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public DigestMd5SaslMechanismHandlerCfg createServerConfiguration(ServerManagedObject<? extends DigestMd5SaslMechanismHandlerCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<DigestMd5SaslMechanismHandlerCfgClient,DigestMd5SaslMechanismHandlerCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<DigestMd5SaslMechanismHandlerCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<DigestMd5SaslMechanismHandlerCfgClient,DigestMd5SaslMechanismHandlerCfg>
      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 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.

    • getQualityOfProtectionPropertyDefinition

      public EnumPropertyDefinition<DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection> getQualityOfProtectionPropertyDefinition()
      Get the "quality-of-protection" property definition.

      The name of a property that specifies the quality of protection the server will support.

      Returns:
      Returns the "quality-of-protection" property definition.

    • getRealmPropertyDefinition

      public StringPropertyDefinition getRealmPropertyDefinition()
      Get the "realm" property definition.

      Specifies the realms that is to be used by the server for DIGEST-MD5 authentication.

      If this value is not provided, then the server defaults to use the fully qualified hostname of the machine.

      Returns:
      Returns the "realm" property definition.

    • getServerFqdnPropertyDefinition

      public StringPropertyDefinition getServerFqdnPropertyDefinition()
      Get the "server-fqdn" property definition.

      Specifies the DNS-resolvable fully-qualified domain name for the server that is used when validating the digest-uri parameter during the authentication process.

      If this configuration attribute is present, then the server expects that clients use a digest-uri equal to "ldap/" followed by the value of this attribute. For example, if the attribute has a value of "directory.example.com", then the server expects clients to use a digest-uri of "ldap/directory.example.com". If no value is provided, then the server does not attempt to validate the digest-uri provided by the client and accepts any value.

      Returns:
      Returns the "server-fqdn" property definition.