Package org.wildfly.security.mechanism

Enum Class ScramServerErrorCode

java.lang.Object
java.lang.Enum<ScramServerErrorCode>
org.wildfly.security.mechanism.ScramServerErrorCode
All Implemented Interfaces:
Serializable, Comparable<ScramServerErrorCode>, Constable
public enum ScramServerErrorCode extends Enum<ScramServerErrorCode>
This enum lists server error codes for SCRAM authentication mechanism.
Author:
David M. Lloyd

  • Enum Constant Details

  • Method Details

    • values

      public static ScramServerErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ScramServerErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getText

      public String getText()
      Returns the String representation of the error code.
      Returns:
      String representation of the error code.

    • getMessageBytes

      public byte[] getMessageBytes()
      Returns the copy of the byte array representing the error message.
      Returns:
      copy of the byte array representing the error message.

    • fromErrorString

      public static ScramServerErrorCode fromErrorString(String value)
      Convert the error string to the respective ScramServerErrorCode enum value, or to the OTHER_ERROR value if can't match.
      Parameters:
      value - the error value as string
      Returns:
      the respective ScramServerErrorCode enum value from error string, OTHER_ERROR otherwise

    • isFull

      public static boolean isFull(EnumSet<ScramServerErrorCode> set)
      Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.
      Parameters:
      set - the set
      Returns:
      true if the set is full, false otherwise

    • in

      public boolean in(ScramServerErrorCode v1)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      v1 - the first instance
      Returns:
      true if one of the instances matches this one, false otherwise

    • in

      public boolean in(ScramServerErrorCode v1, ScramServerErrorCode v2)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      v1 - the first instance
      v2 - the second instance
      Returns:
      true if one of the instances matches this one, false otherwise

    • in

      public boolean in(ScramServerErrorCode v1, ScramServerErrorCode v2, ScramServerErrorCode v3)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      v1 - the first instance
      v2 - the second instance
      v3 - the third instance
      Returns:
      true if one of the instances matches this one, false otherwise

    • in

      public boolean in(ScramServerErrorCode... values)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      values - the possible values
      Returns:
      true if one of the instances matches this one, false otherwise