Class AAuthenticatorConfig

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.ALockableEntity

de.xima.fc.entities.AAuthenticatorConfig

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IAuthenticatorConfig, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IStringAttributesMixin, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

Direct Known Subclasses:

ProjectAuthenticatorConfig, UserPortalAuthConfig, WorkflowStateAuthenticatorConfig

@MappedSuperclass
public abstract class AAuthenticatorConfig
extends ALockableEntity
implements IAuthenticatorConfig

Abstract base class for authenticator configurations

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_AUTHENTICATOR_TYPE
static final String	ATTR_CLIENTAUTHENTICATOR
static final String	ATTR_ORDER_IDX
static final String	ATTR_SYSTEMAUTHENTICATOR
protected @NotNull EAuthClientType	authenticatorType
protected ClientAuthenticator	clientAuthenticator
protected SystemAuthenticator	systemAuthenticator

Fields inherited from class AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface ITransferableEntity

IMPORT_ID, INVALID_ID

Constructor Summary

Constructors

Constructor	Description
AAuthenticatorConfig()

Method Summary

Modifier and Type	Method	Description
IAuthenticator<?>	getAuthenticator()
String	getAuthenticatorToken()	Deprecated. Use IClientDescriptor.getClientName() instead.
EAuthClientType	getAuthenticatorType()
ClientAuthenticator	getClientAuthenticator()
IClientDescriptor	getClientDescriptor()
String	getDisplayName(Locale locale)
String	getI18nPlaceholder()	Deprecated. Use IClientDescriptor.getI18nAuthBtnTextPlaceholder()
String	getIdentifier()
SystemAuthenticator	getSystemAuthenticator()
void	setAuthenticator(IAuthenticator<?> authenticator)
void	setAuthenticatorType(EAuthClientType authenticatorType)
void	setClientAuthenticator(ClientAuthenticator clientAuthenticator)
void	setClientDescriptor(IClientDescriptor clientDescriptor)
void	setSystemAuthenticator(SystemAuthenticator systemAuthenticator)
String	toString()

Methods inherited from class AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion

Methods inherited from class AbstractEntity

asIntValue, isPersisted, setId, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Comparable

compareTo

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

getId, isPersisted, setId

Methods inherited from interface IStringAttributesMixin

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

Field Details

ATTR_CLIENTAUTHENTICATOR

public static final String ATTR_CLIENTAUTHENTICATOR

See Also:

• Constant Field Values

ATTR_SYSTEMAUTHENTICATOR

public static final String ATTR_SYSTEMAUTHENTICATOR

See Also:

• Constant Field Values

ATTR_AUTHENTICATOR_TYPE

public static final String ATTR_AUTHENTICATOR_TYPE

See Also:

• Constant Field Values

ATTR_ORDER_IDX

public static final String ATTR_ORDER_IDX

See Also:

• Constant Field Values

authenticatorType

@NotNull
protected @NotNull EAuthClientType authenticatorType

clientAuthenticator

protected ClientAuthenticator clientAuthenticator

systemAuthenticator

protected SystemAuthenticator systemAuthenticator

Constructor Details

AAuthenticatorConfig

public AAuthenticatorConfig()

Method Details

getClientAuthenticator

public ClientAuthenticator getClientAuthenticator()

setClientAuthenticator

public void setClientAuthenticator(ClientAuthenticator clientAuthenticator)

getSystemAuthenticator

public SystemAuthenticator getSystemAuthenticator()

setSystemAuthenticator

public void setSystemAuthenticator(SystemAuthenticator systemAuthenticator)

getClientDescriptor

public IClientDescriptor getClientDescriptor()

Specified by:

getClientDescriptor in interface IAuthenticatorConfig

Returns:

Descriptor of the authentication client.

setClientDescriptor

public void setClientDescriptor(IClientDescriptor clientDescriptor)

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IAuthenticatorConfig

Returns:

a unique key identifying this authenticator config

getAuthenticator

public IAuthenticator<?> getAuthenticator()

Specified by:

getAuthenticator in interface IAuthenticatorConfig

Returns:

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

setAuthenticator

public void setAuthenticator(IAuthenticator<?> authenticator)

getAuthenticatorType

public EAuthClientType getAuthenticatorType()

Specified by:

getAuthenticatorType in interface IAuthenticatorConfig

Returns:

Type of authenticator represented by this config

setAuthenticatorType

public void setAuthenticatorType(EAuthClientType authenticatorType)

getAuthenticatorToken

@Deprecated
public String getAuthenticatorToken()

Deprecated.

Use IClientDescriptor.getClientName() instead.

Specified by:

getAuthenticatorToken in interface IAuthenticatorConfig

Returns:

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

getI18nPlaceholder

@Deprecated
public String getI18nPlaceholder()

Deprecated.

Use IClientDescriptor.getI18nAuthBtnTextPlaceholder()

Specified by:

getI18nPlaceholder in interface IAuthenticatorConfig

Returns:

the I18N placeholder for the authenticator button name

getDisplayName

public String getDisplayName(Locale locale)

toString

public String toString()

Overrides:

toString in class AbstractLockableEntity