Class HexPasswordEncoderOutputFormatter

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] format​(byte[] unformattedData)
      Formats the provided data in accordance with this output format.
      static HexPasswordEncoderOutputFormatter getLowercaseInstance()
      Retrieves a singleton instance of this hex password encoder that will represent the hexadecimal digits 'A' through 'F' as lowercase letters.
      static HexPasswordEncoderOutputFormatter getUppercaseInstance()
      Retrieves a singleton instance of this hex password encoder that will represent the hexadecimal digits 'A' through 'F' as uppercase letters.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this password encoder output formatter to the provided buffer.
      byte[] unFormat​(byte[] formattedData)
      Reverses the formatting that has been applied to the provided data.
      boolean useLowercaseLetters()
      Indicates whether to represent the hexadecimal digits 'A' through 'F' as lowercase letters or uppercase letters.
      • Methods inherited from class java.lang.Object

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

      • getLowercaseInstance

        public static HexPasswordEncoderOutputFormatter getLowercaseInstance()
        Retrieves a singleton instance of this hex password encoder that will represent the hexadecimal digits 'A' through 'F' as lowercase letters.
        Returns:
        The hex password encoder instance.
      • getUppercaseInstance

        public static HexPasswordEncoderOutputFormatter getUppercaseInstance()
        Retrieves a singleton instance of this hex password encoder that will represent the hexadecimal digits 'A' through 'F' as uppercase letters.
        Returns:
        The hex password encoder instance.
      • useLowercaseLetters

        public boolean useLowercaseLetters()
        Indicates whether to represent the hexadecimal digits 'A' through 'F' as lowercase letters or uppercase letters. Note that this setting only applies when formatting an encoded password. When un-formatting a password, either uppercase or lowercase letters will be properly handled.
        Returns:
        true if hexadecimal digits 'A' through 'F' should be represented as lowercase letters, or false if they should be represented as uppercase letters.
      • format

        public byte[] format​(byte[] unformattedData)
                      throws LDAPException
        Formats the provided data in accordance with this output format.
        Specified by:
        format in class PasswordEncoderOutputFormatter
        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 byte[] unFormat​(byte[] formattedData)
                        throws LDAPException
        Reverses the formatting that has been applied to the provided data.
        Specified by:
        unFormat in class PasswordEncoderOutputFormatter
        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 void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this password encoder output formatter to the provided buffer.
        Specified by:
        toString in class PasswordEncoderOutputFormatter
        Parameters:
        buffer - The buffer to which the information should be appended.