Package com.unboundid.ldap.listener
Class PasswordEncoderOutputFormatter
- java.lang.Object
-
- com.unboundid.ldap.listener.PasswordEncoderOutputFormatter
-
- Direct Known Subclasses:
Base64PasswordEncoderOutputFormatter
,HexPasswordEncoderOutputFormatter
@Extensible @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class PasswordEncoderOutputFormatter extends java.lang.Object
This class defines an API that may be used to format and un-format encoded passwords for use with the in-memory directory server.
-
-
Constructor Summary
Constructors Constructor Description PasswordEncoderOutputFormatter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract byte[]
format(byte[] unformattedData)
Formats the provided data in accordance with this output format.java.lang.String
toString()
Retrieves a string representation of this password encoder output formatter.abstract void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this password encoder output formatter to the provided buffer.abstract byte[]
unFormat(byte[] formattedData)
Reverses the formatting that has been applied to the provided data.
-
-
-
Constructor Detail
-
PasswordEncoderOutputFormatter
public PasswordEncoderOutputFormatter()
-
-
Method Detail
-
format
@NotNull public abstract byte[] format(@NotNull byte[] unformattedData) throws LDAPException
Formats the provided data in accordance with this output format.- Parameters:
unformattedData
- The data to be formatted. It must not benull
.- Returns:
- A formatted representation of the provided data.
- Throws:
LDAPException
- If a problem is encountered while formatting the provided data.
-
unFormat
@NotNull public abstract byte[] unFormat(@NotNull byte[] formattedData) throws LDAPException
Reverses the formatting that has been applied to the provided data.- Parameters:
formattedData
- The formatted data to be un-formatted. It must not benull
.- Returns:
- The un-formatted version of the provided data.
- Throws:
LDAPException
- If the provided data does not represent a valid encoding, or if a problem is encountered while un-formatting the provided data.
-
toString
@NotNull public final java.lang.String toString()
Retrieves a string representation of this password encoder output formatter.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this password encoder output formatter.
-
-