Class 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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • format

        public abstract byte[] format​(byte[] unformattedData)
                               throws LDAPException
        Formats the provided data in accordance with this output format.
        Parameters:
        unformattedData - The data to be formatted. It must not be null.
        Returns:
        A formatted representation of the provided data.
        Throws:
        LDAPException - If a problem is encountered while formatting the provided data.
      • unFormat

        public abstract byte[] unFormat​(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 be null.
        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

        public final java.lang.String toString()
        Retrieves a string representation of this password encoder output formatter.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this password encoder output formatter.
      • toString

        public abstract void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this password encoder output formatter to the provided buffer.
        Parameters:
        buffer - The buffer to which the information should be appended.