Class AAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

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.AAuthenticator<TFile>

Type Parameters:

TFile - The type of the authenticator, i.e. either ClientAuthenticator or SystemAuthenticator.

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IAuthenticator<TFile>, IDescriptionProviding, ILockingVersionProviding, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

Direct Known Subclasses:

ClientAuthenticator, SystemAuthenticator

@MappedSuperclass
public abstract class AAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>
extends ALockableEntity
implements IAuthenticator<TFile>

Abstract base class for user authenticators

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_CALLBACK_URL_TYPE
static final String	ATTR_CALLBACK_UUID
static final String	ATTR_CONFIG_STATE
static final String	ATTR_TYPE
protected Map<String,String>	attributes
static final String	COL_CALLBACK_URL_TYPE
static final String	COL_UUID
protected Map<String,TFile>	fileMap

Fields inherited from class AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class AbstractEntity

COL_ID, id

Fields inherited from interface IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

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 INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface IUUIDEntity

ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
AAuthenticator()

Method Summary

Modifier and Type	Method	Description
String	getAttributeValue(String key)	Get the String value of the attribute with the given key
String	getAttributeValue(String key, String defaultValue)	Get the String value of the attribute with the given key
List<String>	getAttributeValueList(String key)	Get the List value of the attribute with the given key
Map<String,String>	getAttributeValueMap(String key)	Get the Map value of the attribute with the given key
String	getBeschreibung()
EAuthCallbackUrlType	getCallbackUrlType()
UUID	getCallbackUUID()
String	getCallbackUUIDString()
EAuthConfigState	getConfigState()
String	getDescription()
String	getLoginButtonTitle()
String	getName()
EAuthClientType	getType()
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	putAttribute(String key, String value)	Puts the given String value for the given key in the attribute map of this authenticator
void	putAttributes(String key, List<String> values)	Puts the given List value for the given key in the attribute map of this authenticator
void	putAttributes(String key, Map<String,String> valueMap)	Puts the given Map value for the given key in the attribute map of this authenticator
TFile	putFile(String key, TFile file)	See Map.put(Object, Object)
String	removeAttribute(String key)	Removes the attributes for the given key
TFile	removeFile(String key)	Removes the file mapping for the given key.
void	setAttributes(Map<String,String> attributes)
void	setCallbackUrlType(EAuthCallbackUrlType callbackUrlType)
void	setCallbackUUID(UUID callbackUUID)
void	setCallbackUUIDString(String uuidString)
void	setConfigState(EAuthConfigState configState)
void	setDescription(String description)
void	setFileMap(Map<String,TFile> fileMap)	DON'T USE!
void	setLoginButtonTitle(String loginButtonTitle)
void	setName(String name)
void	setType(EAuthClientType type)
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)
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 IAuthenticator

getAttributes, getFileMap, getIdentifier

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

getId, isPersisted, setId

Field Details

COL_UUID

public static final String COL_UUID

See Also:

• Constant Field Values

COL_CALLBACK_URL_TYPE

public static final String COL_CALLBACK_URL_TYPE

See Also:

• Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

• Constant Field Values

ATTR_CALLBACK_UUID

public static final String ATTR_CALLBACK_UUID

See Also:

• Constant Field Values

ATTR_CALLBACK_URL_TYPE

public static final String ATTR_CALLBACK_URL_TYPE

See Also:

• Constant Field Values

ATTR_CONFIG_STATE

public static final String ATTR_CONFIG_STATE

See Also:

• Constant Field Values

attributes

protected Map<String,String> attributes

fileMap

protected Map<String, TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>> fileMap

Constructor Details

AAuthenticator

public AAuthenticator()

Method Details

getUUID

public String getUUID()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUID in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUID

public void setUUID(String uuid)

Description copied from interface: IUUIDEntity

Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

setUUID in interface IUUIDEntity

Parameters:

uuid - The UUID of the entity.

getUUIDObject

public UUID getUUIDObject()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUIDObject in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUIDObject

public void setUUIDObject(UUID uuid)

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this object.

setName

public void setName(String name)

getBeschreibung

public String getBeschreibung()

Specified by:

getBeschreibung in interface IDescriptionProviding

getDescription

public String getDescription()

Specified by:

getDescription in interface IDescriptionProviding

Returns:

A human-readable description for this object.

setDescription

public void setDescription(String description)

getType

public EAuthClientType getType()

Specified by:

getType in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Returns:

The authenticator type as selected by the user, such as Google, Facebook or NTLM.

setType

public void setType(EAuthClientType type)

getCallbackUUID

public UUID getCallbackUUID()

Specified by:

getCallbackUUID in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Returns:

The UUID that uniquely identifies this client. It is added to the callback URL (the URL to which the identity provider redirects upon success or failure).

setCallbackUUID

public void setCallbackUUID(UUID callbackUUID)

getCallbackUrlType

public EAuthCallbackUrlType getCallbackUrlType()

Specified by:

getCallbackUrlType in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Returns:

the type of callback URL to be used by this authenticator.

setCallbackUrlType

public void setCallbackUrlType(EAuthCallbackUrlType callbackUrlType)

getCallbackUUIDString

public String getCallbackUUIDString()

setCallbackUUIDString

public void setCallbackUUIDString(String uuidString)

getLoginButtonTitle

public String getLoginButtonTitle()

Specified by:

getLoginButtonTitle in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Returns:

The name displayed on the login button that appears on the login page.

setLoginButtonTitle

public void setLoginButtonTitle(String loginButtonTitle)

getConfigState

public EAuthConfigState getConfigState()

Specified by:

getConfigState in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Returns:

The current state of this configuration, i.e. whether it still misses some configuration or was configured completely and is ready to be used.

setConfigState

public void setConfigState(EAuthConfigState configState)

setAttributes

public void setAttributes(Map<String,String> attributes)

Specified by:

setAttributes in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

getAttributeValue

public String getAttributeValue(String key)

Get the String value of the attribute with the given key

Specified by:

getAttributeValue in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

Returns:

String value of the requested attribute

See Also:

• IAuthenticator.getAttributes()

getAttributeValue

public String getAttributeValue(String key,
 String defaultValue)

Get the String value of the attribute with the given key

Specified by:

getAttributeValue in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

defaultValue - String default value

Returns:

String value of the requested attribute or the default value if the attribute does not exist

See Also:

• IAuthenticator.getAttributes()

getAttributeValueList

public List<String> getAttributeValueList(String key)

Get the List value of the attribute with the given key

Specified by:

getAttributeValueList in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

Returns:

List value of the requested attribute or null if the attribute does not exist or can't be parsed to a list.

getAttributeValueMap

public Map<String,String> getAttributeValueMap(String key)

Get the Map value of the attribute with the given key

Specified by:

getAttributeValueMap in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

Returns:

Map value of the requested attribute or null if the attribute does not exist or can't be parsed to a map.

putAttribute

public void putAttribute(String key,
 String value)

Puts the given String value for the given key in the attribute map of this authenticator

Specified by:

putAttribute in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

value - String value of the attribute

putAttributes

public void putAttributes(String key,
 List<String> values)

Puts the given List value for the given key in the attribute map of this authenticator

Specified by:

putAttributes in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

values - List value of the attribute

putAttributes

public void putAttributes(String key,
 Map<String,String> valueMap)

Puts the given Map value for the given key in the attribute map of this authenticator

Specified by:

putAttributes in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String attribute name

valueMap - Map value of the attribute

removeAttribute

public String removeAttribute(String key)

Removes the attributes for the given key

Parameters:

key - String key in the attribute map

Returns:

true if the attribute was removed

setFileMap

public void setFileMap(Map<String,TFile> fileMap)

DON'T USE! Hibernate is managing this collection, so if it is overridden, Hibernate can't keep track of it anymore. Use putFile(String, IFileEntity), removeFile(String) or IAuthenticator.getFileMap() instead to modify the map.

Specified by:

setFileMap in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

putFile

public TFile putFile(String key,
 TFile file)

See Map.put(Object, Object)

Specified by:

putFile in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String to store file under

file - the file to put into file map

Returns:

the file previously stored for the given key or null if there wasn't any

removeFile

public TFile removeFile(String key)

Removes the file mapping for the given key. See Map.remove(Object).

Specified by:

removeFile in interface IAuthenticator<TFile extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>, ? extends IFileDataEntity<?>>>

Parameters:

key - String key in the file map

Returns:

the removed file or null if there wasn't any

toString

public String toString()

Overrides:

toString in class AbstractLockableEntity