Class UserPassword

  • All Implemented Interfaces:
    Password

    public final class UserPassword
    extends Object
    implements Password
    An encoded user password that contains a storage scheme and an encoded vaulue.
    • Method Detail

      • valueOf

        public static UserPassword valueOf​(String userPasswordValue)
                                    throws DecodeException
        Converts the provided encoded String user password into a UserPassword.
        Parameters:
        userPasswordValue - The encoded user password to be converted.
        Returns:
        A UserPassword.
        Throws:
        DecodeException - If the provided value does not comply with the authentication password format.
      • isEncoded

        public static boolean isEncoded​(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.
      • getStorageScheme

        public String getStorageScheme()
        Returns the storage scheme name in lowercase.
        Specified by:
        getStorageScheme in interface Password
        Returns:
        The storage scheme name in lowercase.
      • getEncodedValue

        public String getEncodedValue()
        Returns the encoded value.
        Returns:
        The encoded value.