OpenIdState (Soteria 3.0.3 3.0.3 API)

java.lang.Object
- org.glassfish.soteria.mechanisms.openid.OpenIdState

All Implemented Interfaces:

Serializable
```
public class OpenIdState
extends Object
implements Serializable
```
Class to hold state of OpenId
This is used in the authentication mechanism to both help prevent CSRF and to pass data to the callback page.

Author:

Gaurav Gupta, jonathan, Rudy De Busscher

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`OpenIdState()`	Creates a new instance with a random UUID as the state.
`OpenIdState(String state)`	Creates a new instance set the state to what is in the constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`static Optional<OpenIdState>`	`from(String state)`	Factory method which creates an `OpenIdState` if the state provided is not NULL or empty.
`String`	`getValue()`	Gets the state
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OpenIdState
```
public OpenIdState()
```
    Creates a new instance with a random UUID as the state.
  - OpenIdState
```
public OpenIdState(String state)
```
    Creates a new instance set the state to what is in the constructor.
    This can be used so that the callback page knows the originating page, but is not used by the OpenIdAuthenticationMechanism by default
    
    Parameters:
    
    state - the state to encapsulate
- Method Detail
  - from
```
public static Optional<OpenIdState> from(String state)
```
    Factory method which creates an OpenIdState if the state provided is not NULL or empty.
    
    Parameters:
    
    state - the state to create an OpenIdState from
    
    Returns:
    
    an OpenIdState if the state provided is not NULL or empty
  - getValue
```
public String getValue()
```
    Gets the state
    
    Returns:
    
    the state
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object