de.xima.fc.entities.interfaces

Interface IAuthenticator<T extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>

Type Parameters:

T - Type of the authenticator entity that implements this interface, i.e. either ClientAuthenticator or SystemAuthenticator.

All Superinterfaces:

IDescriptionProviding, INameProviding, IUUIDEntity

All Known Implementing Classes:

AAuthenticator, ClientAuthenticator, SystemAuthenticator

public interface IAuthenticator<T extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>
extends INameProviding, IDescriptionProviding, IUUIDEntity

Common interface for user authenticator entities. These entities store the configuration of an authenticator, as entered by the user.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, TYPE_NAME_UUID

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes()
String	getAttributeValue(String key)
Map<String,String>	getAttributeValueMap(String key) Some keys of the getAttributes() may be mapped to another key-value map of attributes.
UUID	getCallbackUUID()
EAuthConfigState	getConfigState()
Map<String,T>	getFileMap()
String	getLoginButtonTitle()
EAuthClientType	getType()
void	putAttribute(String key, String value)
void	putAttributes(String key, List<String> values)
void	putAttributes(String key, Map<String,String> valueMap)
T	putFile(String key, T file)
T	removeFile(String key)
void	setAttributes(Map<String,String> attributes)
void	setFileMap(Map<String,T> fileMap)

Methods inherited from interface de.xima.fc.entities.interfaces.INameProviding

getName

Methods inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

getBeschreibung, getDescription

Methods inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

getUUID, getUUIDObject, setUUID

Method Detail

getType

EAuthClientType getType()

Returns:

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

getCallbackUUID

UUID getCallbackUUID()

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).

getLoginButtonTitle

String getLoginButtonTitle()

Returns:

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

getConfigState

EAuthConfigState getConfigState()

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.

getAttributes

Map<String,String> getAttributes()

Returns:

A map of all key-value pairs as configured by the user for this authenticator. Please note that the value may be a JSON object, depending on the key.

getFileMap

Map<String,T> getFileMap()

Returns:

A map of files the user uploaded when they configured this authenticator, such as SSL certificates or configuration files.

getAttributeValue

String getAttributeValue(String key)

Parameters:

key - Key of an attribute to fetch.

Returns:

The value of the attribute with the given key.

See Also:

getAttributes()

setFileMap

void setFileMap(Map<String,T> fileMap)

removeFile

T removeFile(String key)

putFile

T putFile(String key,
          T file)

setAttributes

void setAttributes(Map<String,String> attributes)

getAttributeValueMap

Map<String,String> getAttributeValueMap(String key)

Some keys of the getAttributes() may be mapped to another key-value map of attributes. These are stored as a stringified JSON object. This is a convenience method that parses the JSON string and return the map. Please note that modifications of the returned map are not stored and do not modify the original getAttributes() map.

Parameters:

key - Key of a an attribute to fetch.

Returns:

The list of key-value pairs for the given key.

putAttribute

void putAttribute(String key,
                  String value)

putAttributes

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

putAttributes

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