Package de.xima.fc.mdl.enums

Enum EAuthenticatorRenderType

java.lang.Object

java.lang.Enum<EAuthenticatorRenderType>

de.xima.fc.mdl.enums.EAuthenticatorRenderType

All Implemented Interfaces:

Serializable, Comparable<EAuthenticatorRenderType>

public enum EAuthenticatorRenderType
extends Enum<EAuthenticatorRenderType>
implements Serializable

Rendering type of the authenticator.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUTTON_REDIRECT	Renders the authenticator as a button that redirects to the authenticator's login page.
FORM_PASSWORD	Renders the authenticator as a form with only a password field.
FORM_USERNAME_PASSWORD	Renders the authenticator as a form with username (or email) and password fields.

Method Summary

Modifier and Type	Method	Description
static EAuthenticatorRenderType	forBackend(IClientDescriptor client)
static EAuthenticatorRenderType	forBackend(EAuthClientType authClientType)
boolean	isForm()
static EAuthenticatorRenderType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EAuthenticatorRenderType[]	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_USERNAME_PASSWORD

public static final EAuthenticatorRenderType FORM_USERNAME_PASSWORD

Renders the authenticator as a form with username (or email) and password fields.

FORM_PASSWORD

public static final EAuthenticatorRenderType FORM_PASSWORD

Renders the authenticator as a form with only a password field.

BUTTON_REDIRECT

public static final EAuthenticatorRenderType BUTTON_REDIRECT

Renders the authenticator as a button that redirects to the authenticator's login page.

Method Detail

values

public static EAuthenticatorRenderType[] 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 (EAuthenticatorRenderType c : EAuthenticatorRenderType.values())
    System.out.println(c);

Returns:

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

valueOf

public static EAuthenticatorRenderType 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

forBackend

public static EAuthenticatorRenderType forBackend(IClientDescriptor client)

Parameters:

client - The authentication client.

Returns:

The rendering type for the authenticator in the backend.

forBackend

public static EAuthenticatorRenderType forBackend(EAuthClientType authClientType)

Parameters:

authClientType - The type of the authenticator.

Returns:

The rendering type for the authenticator in the backend.

isForm

public boolean isForm()

Returns:

Whether the authenticator is rendered as a form.