Package de.xima.fc.mdl.enums

Enum EAuthRenderType

java.lang.Object

java.lang.Enum<EAuthRenderType>

de.xima.fc.mdl.enums.EAuthRenderType

All Implemented Interfaces:

Serializable, Comparable<EAuthRenderType>

public enum EAuthRenderType
extends Enum<EAuthRenderType>

Enum for the different types of authentication renderers. The type determines how the authenticator is rendered. The types listed here are the default types. Custom types may be added in the future by implementing via plugins.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUTTON_REDIRECT	The authenticator is rendered as a button that redirects to a third-party identity provider.
FORM_INPUT_PASSWORD	The authenticator is rendered as an input form with a single password field.
FORM_INPUT_USERNAME_PASSWORD	The authenticator is rendered as an input form with a username and password field.

Method Summary

Modifier and Type	Method	Description
String	getId()
static EAuthRenderType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EAuthRenderType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FORM_INPUT_USERNAME_PASSWORD

public static final EAuthRenderType FORM_INPUT_USERNAME_PASSWORD

The authenticator is rendered as an input form with a username and password field. The username may also be another type of identifier, such as an email address.

FORM_INPUT_PASSWORD

public static final EAuthRenderType FORM_INPUT_PASSWORD

The authenticator is rendered as an input form with a single password field.

BUTTON_REDIRECT

public static final EAuthRenderType BUTTON_REDIRECT

The authenticator is rendered as a button that redirects to a third-party identity provider.

Method Detail

values

public static EAuthRenderType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EAuthRenderType c : EAuthRenderType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EAuthRenderType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getId

public String getId()