Class ScramSha256PasswordStorageSchemeCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<ScramSha256PasswordStorageSchemeCfgClient,ScramSha256PasswordStorageSchemeCfg>
-
- org.forgerock.opendj.server.config.meta.ScramSha256PasswordStorageSchemeCfgDefn
-
public final class ScramSha256PasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<ScramSha256PasswordStorageSchemeCfgClient,ScramSha256PasswordStorageSchemeCfg>
An interface for querying the SCRAM-SHA-256 Password Storage Scheme managed object definition meta information.The SCRAM-SHA-256 Password Storage Scheme provides a mechanism for encoding user passwords for use with the SASL SCRAM authentication mechanism defined in RFC 5802.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ScramSha256PasswordStorageSchemeCfgClient
createClientConfiguration(ManagedObject<? extends ScramSha256PasswordStorageSchemeCfgClient> impl)
Creates a client configuration view of the provided managed object.ScramSha256PasswordStorageSchemeCfg
createServerConfiguration(ServerManagedObject<? extends ScramSha256PasswordStorageSchemeCfg> impl)
Creates a server configuration view of the provided server managed object.BooleanPropertyDefinition
getEnabledPropertyDefinition()
Get the "enabled" property definition.static ScramSha256PasswordStorageSchemeCfgDefn
getInstance()
Get the SCRAM-SHA-256 Password Storage Scheme configuration definition singleton.ClassPropertyDefinition
getJavaClassPropertyDefinition()
Get the "java-class" property definition.IntegerPropertyDefinition
getScramIterationsPropertyDefinition()
Get the "scram-iterations" property definition.Class<ScramSha256PasswordStorageSchemeCfg>
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
-
-
-
-
Method Detail
-
getInstance
public static ScramSha256PasswordStorageSchemeCfgDefn getInstance()
Get the SCRAM-SHA-256 Password Storage Scheme configuration definition singleton.- Returns:
- Returns the SCRAM-SHA-256 Password Storage Scheme configuration definition singleton.
-
createClientConfiguration
public ScramSha256PasswordStorageSchemeCfgClient createClientConfiguration(ManagedObject<? extends ScramSha256PasswordStorageSchemeCfgClient> 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 classManagedObjectDefinition<ScramSha256PasswordStorageSchemeCfgClient,ScramSha256PasswordStorageSchemeCfg>
- Parameters:
impl
- The managed object.- Returns:
- Returns a client configuration view of the provided managed object.
-
createServerConfiguration
public ScramSha256PasswordStorageSchemeCfg createServerConfiguration(ServerManagedObject<? extends ScramSha256PasswordStorageSchemeCfg> impl)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<ScramSha256PasswordStorageSchemeCfgClient,ScramSha256PasswordStorageSchemeCfg>
- Parameters:
impl
- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
public Class<ScramSha256PasswordStorageSchemeCfg> getServerConfigurationClass()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<ScramSha256PasswordStorageSchemeCfgClient,ScramSha256PasswordStorageSchemeCfg>
- 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 SCRAM-SHA-256 Password Storage Scheme 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 SCRAM-SHA-256 Password Storage Scheme implementation.
- Returns:
- Returns the "java-class" property definition.
-
getScramIterationsPropertyDefinition
public IntegerPropertyDefinition getScramIterationsPropertyDefinition()
Get the "scram-iterations" property definition.The number of iterations to use when deriving the salted password.
- Returns:
- Returns the "scram-iterations" property definition.
-
-