Interface IAuthenticatorConfig

All Superinterfaces:

IStringAttributesMixin, Serializable

All Known Implementing Classes:

AAuthenticatorConfig, ProjectAuthenticatorConfig, UserPortalAuthConfig, VirtualAuthenticatorConfig, WorkflowStateAuthenticatorConfig

public interface IAuthenticatorConfig
extends IStringAttributesMixin, Serializable

Common interface for authentication config entities

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default IAuthenticator<?>	getAuthenticator()	Deprecated. since version 8.0.0 Use IClientDescriptor.getAuthenticator() instead.
default String	getAuthenticatorToken()	Deprecated. since version 8.0.0 Use IClientDescriptor.getClientName() instead.
default EAuthClientType	getAuthenticatorType()	Deprecated. since version 8.0.0 Use IClientDescriptor.getType() instead.
@NotNull IClientDescriptor	getClientDescriptor()
default String	getI18nPlaceholder()	Deprecated. since version 8.0.0 Use IClientDescriptor.getI18nAuthBtnTextPlaceholder() instead.
String	getIdentifier()

Methods inherited from interface IStringAttributesMixin

getAttributes, getAttributeValue, getAttributeValueList, getAttributeValueMap, putAttribute, putAttributes, putAttributes, removeAttribute

Method Details

getClientDescriptor

@NotNull
@NotNull IClientDescriptor getClientDescriptor()

Returns:

Descriptor of the authentication client.

Since:

8.0.0

getIdentifier

String getIdentifier()

Returns:

a unique key identifying this authenticator config

getAuthenticator

@Deprecated
default IAuthenticator<?> getAuthenticator()

Deprecated.

since version 8.0.0 Use IClientDescriptor.getAuthenticator() instead.

Returns:

persisted authenticator entity to be used. If null then a custom authenticator is defined

getAuthenticatorType

@Deprecated
default EAuthClientType getAuthenticatorType()

Deprecated.

since version 8.0.0 Use IClientDescriptor.getType() instead.

Returns:

Type of authenticator represented by this config

getAuthenticatorToken

@Deprecated
default String getAuthenticatorToken()

Deprecated.

since version 8.0.0 Use IClientDescriptor.getClientName() instead.

Returns:

name (if it is a system authenticator) or callback UUID (if it is a client authenticator)

getI18nPlaceholder

@Deprecated
default String getI18nPlaceholder()

Deprecated.

since version 8.0.0 Use IClientDescriptor.getI18nAuthBtnTextPlaceholder() instead.

Returns:

the I18N placeholder for the authenticator button name