AuthPassword (OpenAM Server Only 7.4.1 Documentation)

java.lang.Object
- org.forgerock.opendj.ldap.AuthPassword

All Implemented Interfaces:

Password
```
public final class AuthPassword
extends Object
implements Password
```
An authentication password, it has a storage scheme, authentication info and authentication value. The authentication password syntax is defined in RFC 3112.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAuthInfo()`	Returns the authentication info.
`String`	`getAuthValue()`	Returns the authentication value.
`String`	`getStorageScheme()`	Returns the storage scheme name.
`static boolean`	`isEncoded(ByteString value)`	Indicates whether the provided value is encoded using the auth password syntax.
`static AuthPassword`	`valueOf(String authPasswordValue)`	Converts the provided encoded String authentication password to an `AuthPassword`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - valueOf
```
public static AuthPassword valueOf(String authPasswordValue)
                            throws DecodeException
```
    Converts the provided encoded String authentication password to an AuthPassword.
    
    Parameters:
    
    authPasswordValue - The encoded authentication password value to be converted.
    
    Returns:
    
    An AuthPassword.
    
    Throws:
    
    DecodeException - If the provided value does not comply with the authentication password format.
  - isEncoded
```
public static boolean isEncoded(ByteString value)
```
    Indicates whether the provided value is encoded using the auth password syntax.
    
    Parameters:
    
    value - The value for which to make the determination.
    
    Returns:
    
    true if the value appears to be encoded using the auth password syntax, or false if not.
  - getStorageScheme
```
public String getStorageScheme()
```
    Description copied from interface: Password
    
    Returns the storage scheme name.
    
    Specified by:
    
    getStorageScheme in interface Password
    
    Returns:
    
    The storage scheme name.
  - getAuthInfo
```
public String getAuthInfo()
```
    Returns the authentication info.
    
    Returns:
    
    The authentication info.
  - getAuthValue
```
public String getAuthValue()
```
    Returns the authentication value.
    
    Returns:
    
    The authentication value.