com.inductiveautomation.ignition.gateway.auth.web.state

Class WebAuthState

java.lang.Object

com.inductiveautomation.ignition.gateway.auth.web.state.WebAuthState

public class WebAuthState
extends java.lang.Object

Wraps state which will carry over from the initial federation request to the federation response. Includes a random state String, an expiration time for the state, and a map of state params.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebAuthState.Builder Builder for WebAuthState instances

Method Summary

Modifier and Type	Method and Description
static WebAuthState.Builder	builder() Factory method for creating new WebAuthState.Builder instances
long	exp()
java.util.Optional<java.lang.Object>	get(java.lang.String key) Fetch a state param
java.lang.String	state()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

state

@Nonnull
public java.lang.String state()

Returns:

the random state string

exp

public long exp()

Returns:

return the expiration time of this state in millis since the unix epoch

get

@Nonnull
public java.util.Optional<java.lang.Object> get(@Nonnull
                                                         java.lang.String key)

Fetch a state param

Parameters:

key - the desired state param key

Returns:

an Optional containing the state param value associated with the given key or an empty Optional if no param exists for the given key

builder

@Nonnull
public static WebAuthState.Builder builder()

Factory method for creating new WebAuthState.Builder instances

Returns:

a new WebAuthState.Builder