WebAuthState.Builder

java.lang.Object
- com.inductiveautomation.ignition.gateway.auth.web.state.WebAuthState.Builder

Enclosing class:: WebAuthState

public static class WebAuthState.Builder
extends java.lang.Object

Builder for WebAuthState instances

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WebAuthState`	`build()`	Build the `WebAuthState`
`java.lang.String`	`getApp()`
`long`	`getExp()`
`java.lang.String`	`getState()`
`boolean`	`isSessionless()`
`WebAuthState.Builder`	`put(java.lang.String key, java.lang.Object value)`	Add a state param

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

- Method Detail
  - getApp
```
public java.lang.String getApp()
```
    Returns:
    
    the name of the app the user is logging into / logging out of
  - isSessionless
```
public boolean isSessionless()
```
    Returns:
    
    whether the IdP should use sessionless mode
  - getState
```
@Nonnull
public java.lang.String getState()
```
    Returns:
    
    the randomly generated state value
  - getExp
```
public long getExp()
```
    Returns:
    
    when the WebAuthState built by this WebAuthState.Builder will expire. represented as the number of seconds from the Java epoch of 1970-01-01T00:00:00Z
  - put
```
@Nonnull
public WebAuthState.Builder put(@Nonnull
                                java.lang.String key,
                                @Nonnull
                                java.lang.Object value)
```
    Add a state param
    
    Parameters:
    
    key - the state param key
    
    value - the state param value
    
    Returns:
    
    this builder
  - build
```
@Nonnull
public WebAuthState build()
```
    Build the WebAuthState
    
    Returns:
    
    the new WebAuthState
    
    Throws:
    
    java.lang.IllegalArgumentException - if the state or exp are null