org.opends.server.schema

Class UserPasswordSyntax

java.lang.Object

org.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>

org.opends.server.schema.UserPasswordSyntax

public class UserPasswordSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class defines an attribute syntax used for storing values that have been encoded using a password storage scheme. The format for attribute values with this syntax is the concatenation of the following elements in the given order:

• An opening curly brace ("{ private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); ") character.
• The name of the storage scheme used to encode the value.
• A closing curly brace ("}") character.
• The encoded value.

Constructor Summary

Constructors

Constructor and Description
UserPasswordSyntax() Creates a new instance of this syntax.

Method Summary

Methods

Modifier and Type	Method and Description
static String[]	decodeUserPassword(String userPasswordValue) Decodes the provided user password value into its component parts.
String	getDescription() Retrieves a description for this attribute syntax.
String	getName() Retrieves the common name for this attribute syntax.
String	getOID() Retrieves the OID for this attribute syntax.
org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.
static boolean	isEncoded(org.forgerock.opendj.ldap.ByteSequence value) Indicates whether the provided value is encoded using the user password syntax.

Methods inherited from class org.opends.server.api.AttributeSyntax

equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, initializeSyntax, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserPasswordSyntax

public UserPasswordSyntax()

Creates a new instance of this syntax. Note that the only thing that should be done here is to invoke the default constructor for the superclass. All initialization should be performed in the initializeSyntax method.

Method Detail

getSDKSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)

Returns the SDK Syntax equivalent to this syntax.

This method allow smooth migration to SDK syntax. It will disappear once the the migration to SDK schema is complete, together with this class and all its implementation.

Specified by:

getSDKSyntax in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

getName

public String getName()

Retrieves the common name for this attribute syntax.

Specified by:

getName in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The common name for this attribute syntax.

getOID

public String getOID()

Retrieves the OID for this attribute syntax.

Specified by:

getOID in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The OID for this attribute syntax.

getDescription

public String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

decodeUserPassword

public static String[] decodeUserPassword(String userPasswordValue)
                                   throws DirectoryException

Decodes the provided user password value into its component parts.

Parameters:

userPasswordValue - The user password value to be decoded.

Returns:

A two-element string array whose elements are the storage scheme name (in all lowercase characters) and the encoded value, in that order.

Throws:

DirectoryException - If a problem is encountered while attempting to decode the value.

isEncoded

public static boolean isEncoded(org.forgerock.opendj.ldap.ByteSequence value)

Indicates whether the provided value is encoded using the user password syntax.

Parameters:

value - The value for which to make the determination.

Returns:

true if the value appears to be encoded using the user password syntax, or false if not.