ModelType
- The type for the model associated with the state (or Void if no model is associated with the state).public class AuthnStateSpec<ModelType> extends Object
AuthnState
instances.
This allows common definitions for authentication flow states to be shared across plugins. This class is also used
to generate documentation for a plugin's API. Once created, objects of this class are immutable.
Objects of this class are not normally returned in API responses. Instead, you create an
AuthnState
instance using the makeInstance()
method.Modifier and Type | Class and Description |
---|---|
static class |
AuthnStateSpec.Builder<ModelType>
A fluent builder for
AuthnStateSpec specs. |
Modifier and Type | Method and Description |
---|---|
List<AuthnActionSpec<?>> |
getActions()
Gets the complete list of allowed actions from this state.
|
String |
getDescription()
Gets the description of this state for API documentation.
|
Class<ModelType> |
getModelClass()
Gets the class of the model associated with this state, if there is one.
|
String |
getStatus()
Gets the status for this state.
|
AuthnState<ModelType> |
makeInstance(javax.servlet.http.HttpServletRequest request,
ModelType model)
Create a new
AuthnState instance based on this spec. |
public String getStatus()
public String getDescription()
public List<AuthnActionSpec<?>> getActions()
AuthnState
based on this spec,
actions may be removed from this list if they are not currently available to the user.public Class<ModelType> getModelClass()
public AuthnState<ModelType> makeInstance(javax.servlet.http.HttpServletRequest request, ModelType model)
AuthnState
instance based on this spec.request
- The servlet request.model
- An instance of the model for this state (optional).Copyright 2019 Ping Identity Corp. All rights reserved.