Package de.xima.fc.entities

Class SystemAuthenticator

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<SystemAuthenticatorFile>

de.xima.fc.entities.SystemAuthenticator

All Implemented Interfaces:

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

@Entity
public class SystemAuthenticator
extends AAuthenticator<SystemAuthenticatorFile>
implements ILocalizationProviding<SystemAuthenticator,SystemAuthenticatorLocalization>

Entity model for user authenticators in system scope

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ALLOW_ALL_CLIENTS
static String	ATTR_ALLOWED_CLIENTS
static String	ATTR_DEFAULT_LOCALE
static String	ATTR_LOCALIZATIONS
static String	ATTR_OMIT_WELCOME_MAIL
static String	ATTR_VERIFY_USER_AUTOMATICALLY
static String	COL_DEFAULT_LOCALE
static String	COL_FLAG_ALLOW_ALL_CLIENTS
static String	COL_OMIT_WELCOME_MAIL
static String	COL_VERIFY_USER_AUTOMATICALLY

Fields inherited from class de.xima.fc.entities.AAuthenticator

ATTR_CALLBACK_URL_TYPE, ATTR_CALLBACK_UUID, ATTR_CONFIG_STATE, ATTR_TYPE, attributes, COL_CALLBACK_URL_TYPE, COL_UUID, fileMap

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.fc.entities.interfaces.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 de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

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

IMPORT_ID, INVALID_ID

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

ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
SystemAuthenticator()

Method Summary

Modifier and Type	Method	Description
List<Mandant>	getAllowedClients()
Map<String,String>	getAttributes()
Locale	getDefaultLocale()
String	getDisplayName(Locale locale)	Get the display name of the authenticator for the given locale.
Map<String,SystemAuthenticatorFile>	getFileMap()
Long	getId()
String	getIdentifier()
List<SystemAuthenticatorLocalization>	getLocalizations()	Gets all localization associated with this authenticator.
Locale	getLocalizationsDefaultLocale()	Gets the default locale for this providing object.
boolean	isAllowAllClients()
boolean	isAllowedForTenant(UUID tenantUuid)	Checks if the authenticator is allowed for tenant with the given UUID.
boolean	isOmitWelcomeMail()
boolean	isVerifyUserAutomatically()
SystemAuthenticatorLocalization	newLocalization()	Creates a new localization object.
void	onLoad()
SystemAuthenticatorFile	putFile(String key, SystemAuthenticatorFile file)	See Map.put(Object, Object)
void	setAllowAllClients(boolean allowAllClients)
void	setAllowedClients(List<Mandant> allowedClients)
void	setDefaultLocale(Locale defaultLocale)
void	setLocalizations(List<SystemAuthenticatorLocalization> localizations)	Sets all localization associated with this authenticator.
void	setOmitWelcomeMail(boolean omitWelcomeMail)
void	setVerifyUserAutomatically(boolean verifyUserAutomatically)

Methods inherited from class de.xima.fc.entities.AAuthenticator

getAttributeValue, getAttributeValue, getAttributeValueList, getAttributeValueMap, getBeschreibung, getCallbackUrlType, getCallbackUUID, getCallbackUUIDString, getConfigState, getDescription, getLoginButtonTitle, getName, getType, getUUID, getUUIDObject, putAttribute, putAttributes, putAttributes, removeAttribute, removeFile, setAttributes, setCallbackUrlType, setCallbackUUID, setCallbackUUIDString, setConfigState, setDescription, setFileMap, setLoginButtonTitle, setName, setType, setUUID, setUUIDObject, toString

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId, setId

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

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

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

isPersisted, setId

Methods inherited from interface de.xima.fc.entities.interfaces.i18n.ILocalizationProviding

getKeys, getLocales, getLocalization, getLocalizationData, setLocalization

Field Detail

COL_FLAG_ALLOW_ALL_CLIENTS

public static final String COL_FLAG_ALLOW_ALL_CLIENTS

See Also:

Constant Field Values

COL_OMIT_WELCOME_MAIL

public static final String COL_OMIT_WELCOME_MAIL

See Also:

Constant Field Values

COL_VERIFY_USER_AUTOMATICALLY

public static final String COL_VERIFY_USER_AUTOMATICALLY

See Also:

Constant Field Values

COL_DEFAULT_LOCALE

public static final String COL_DEFAULT_LOCALE

See Also:

Constant Field Values

ATTR_ALLOWED_CLIENTS

public static final String ATTR_ALLOWED_CLIENTS

See Also:

Constant Field Values

ATTR_ALLOW_ALL_CLIENTS

public static final String ATTR_ALLOW_ALL_CLIENTS

See Also:

Constant Field Values

ATTR_OMIT_WELCOME_MAIL

public static final String ATTR_OMIT_WELCOME_MAIL

See Also:

Constant Field Values

ATTR_VERIFY_USER_AUTOMATICALLY

public static final String ATTR_VERIFY_USER_AUTOMATICALLY

See Also:

Constant Field Values

ATTR_LOCALIZATIONS

public static final String ATTR_LOCALIZATIONS

See Also:

Constant Field Values

ATTR_DEFAULT_LOCALE

public static final String ATTR_DEFAULT_LOCALE

See Also:

Constant Field Values

Constructor Detail

SystemAuthenticator

public SystemAuthenticator()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IAuthenticator<SystemAuthenticatorFile>

Returns:

a unique key identifying this authenticator within the system, which is used in IAuthenticatorConfigs

getAllowedClients

public List<Mandant> getAllowedClients()

setAllowedClients

public void setAllowedClients(List<Mandant> allowedClients)

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface IAuthenticator<SystemAuthenticatorFile>

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

public Map<String,SystemAuthenticatorFile> getFileMap()

Specified by:

getFileMap in interface IAuthenticator<SystemAuthenticatorFile>

Returns:

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

putFile

public SystemAuthenticatorFile putFile(String key,
                                       SystemAuthenticatorFile file)

Description copied from class: AAuthenticator

See Map.put(Object, Object)

Specified by:

putFile in interface IAuthenticator<SystemAuthenticatorFile>

Overrides:

putFile in class AAuthenticator<SystemAuthenticatorFile>

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

isAllowAllClients

public boolean isAllowAllClients()

setAllowAllClients

public void setAllowAllClients(boolean allowAllClients)

isAllowedForTenant

public boolean isAllowedForTenant(UUID tenantUuid)

Checks if the authenticator is allowed for tenant with the given UUID.

Parameters:

tenantUuid - UUID of the tenant to check.

Returns:

true if the authenticator is allowed for the given tenant, false otherwise.

isOmitWelcomeMail

public boolean isOmitWelcomeMail()

setOmitWelcomeMail

public void setOmitWelcomeMail(boolean omitWelcomeMail)

isVerifyUserAutomatically

public boolean isVerifyUserAutomatically()

setVerifyUserAutomatically

public void setVerifyUserAutomatically(boolean verifyUserAutomatically)

getLocalizations

public List<SystemAuthenticatorLocalization> getLocalizations()

Gets all localization associated with this authenticator. An authenticator may contain a localized display name.

Specified by:

getLocalizations in interface ILocalizationProviding<SystemAuthenticator,SystemAuthenticatorLocalization>

Returns:

All localization associated with this authenticator.

setLocalizations

public void setLocalizations(List<SystemAuthenticatorLocalization> localizations)

Sets all localization associated with this authenticator. An authenticator may contain a localized display name.

Parameters:

localizations - All localization associated with this authenticator.

getDefaultLocale

public Locale getDefaultLocale()

setDefaultLocale

public void setDefaultLocale(Locale defaultLocale)

newLocalization

public SystemAuthenticatorLocalization newLocalization()

Description copied from interface: ILocalizationProviding

Creates a new localization object.

Specified by:

newLocalization in interface ILocalizationProviding<SystemAuthenticator,SystemAuthenticatorLocalization>

Returns:

a new localization object

getLocalizationsDefaultLocale

public Locale getLocalizationsDefaultLocale()

Description copied from interface: ILocalizationProviding

Gets the default locale for this providing object.

Specified by:

getLocalizationsDefaultLocale in interface ILocalizationProviding<SystemAuthenticator,SystemAuthenticatorLocalization>

Returns:

the default locale for this providing object

getDisplayName

public String getDisplayName(Locale locale)

Get the display name of the authenticator for the given locale. If no localization is available for the given locale, the name of the authenticator is returned.

Parameters:

locale - The locale for which the display name should be returned.

onLoad

public void onLoad()