com.nimbusds.srp6
Enum SRP6ServerSession.State

java.lang.Object
  extended by java.lang.Enum<SRP6ServerSession.State>
      extended by com.nimbusds.srp6.SRP6ServerSession.State
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SRP6ServerSession.State>
Enclosing class:
SRP6ServerSession

public static enum SRP6ServerSession.State
extends java.lang.Enum<SRP6ServerSession.State>

Enumerates the states of a server-side SRP-6a authentication session.


Enum Constant Summary
INIT
          The session is initialised and ready to begin authentication, by proceeding to STEP_1.
STEP_1
          The user identity 'I' is received from the client and the server has returned its public value 'B' based on the matching password verifier 'v'.
STEP_2
          The client public key 'A' and evidence message 'M1' are received and the server has replied with its own evidence message 'M2'.
 
Method Summary
static SRP6ServerSession.State valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SRP6ServerSession.State[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

INIT

public static final SRP6ServerSession.State INIT
The session is initialised and ready to begin authentication, by proceeding to STEP_1.


STEP_1

public static final SRP6ServerSession.State STEP_1
The user identity 'I' is received from the client and the server has returned its public value 'B' based on the matching password verifier 'v'. The session is ready to proceed to STEP_2.


STEP_2

public static final SRP6ServerSession.State STEP_2
The client public key 'A' and evidence message 'M1' are received and the server has replied with its own evidence message 'M2'. The session is finished (authentication was successful or failed).

Method Detail

values

public static SRP6ServerSession.State[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SRP6ServerSession.State c : SRP6ServerSession.State.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SRP6ServerSession.State valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null