WebAuthState.Builder

java.lang.Object

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

Enclosing class:: WebAuthState

public static class WebAuthState.Builder extends Object

Builder for WebAuthState instances

Method Summary

Modifier and Type

Method

Description

WebAuthState

build()

Build the WebAuthState

String

getApp()

long

getExp()

String

getState()

boolean

isSessionless()

WebAuthState.Builder

put(String key, 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 Details
- getApp
  
  public 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 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 String key, @Nonnull 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:
  
  IllegalArgumentException - if the state or exp are null