AuthError AuthLogout AuthGeneric

Introduction and overview

These AuthStates are used as a helper AuthState. They do not process any authentication but generate (error) GUIs.

Description

The following table and chapters describe the characteristics of the AuthState.

Topic	Description
Class	ch.nevis.esauth.auth.states.standard.AuthError, ch.nevis.esauth.auth.states.standard.AuthGeneric, ch.nevis.esauth.auth.states.standard.AuthLogout
Logging	StdStates
Auditing	none
Marker	none
Methods	process (all events)

Properties

none

Input

none

Transitions

none (should only be used as final AuthState)

Output

The configured GUI descriptor is generated as a result of using this plug-in.

Errors

none

Notes

none

Examples

AuthLogout example

<AuthState name="Logout" class="ch.nevis.esauth.auth.states.standard.AuthLogout">
  <Response value="AUTH_DONE">
    <Gui name="LogoutDialog" label="logout.label">
       <GuiElem name="infotext" type="info"   label="logout.text"/>
       <GuiElem name="submit"   type="button" label="continue.button.label" value="continue"/>
    </Gui>
  </Response>
</AuthState>

AuthGeneric does not have its own business logic and does not execute its own functionality. It is a helper method that can be used to set a response and execute subsequent actions, such as redirects.

AuthGeneric setting AuthDone with a redirect

<AuthState class="ch.nevis.esauth.auth.states.standard.AuthGeneric" final="true" name="<some_name>">
 <Response value="AUTH_DONE">
  <Arg name="nevis.transfer.type" value="redirect"/>
  <Arg name="nevis.transfer.destination" value="<url-or-path>"/>
 </Response>
</AuthState>

In case of an AUTH_ERROR, you can also trigger a redirect using the following code snippet.

AuthGeneric setting AuthError with a redirect

<AuthState class="ch.nevis.esauth.auth.states.standard.AuthGeneric" final="true" name="<some_name>">
 <Response value="AUTH_ERROR">
  <Arg name="nevis.transfer.type" value="redirect"/>
  <Arg name="nevis.transfer.destination" value="<url-or-path>"/>
 </Response>
</AuthState>