SystemAuthenticator (FORMCYCLE: BOM 7.3.0 API)

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>, 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>
```
Entity model for user authenticators in system scope

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary
- 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, TYPE_NAME_UUID

Constructor Summary

Constructors
Constructor Description

SystemAuthenticator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getAttributes()`
`Map<String,SystemAuthenticatorFile>`	`getFileMap()`
`Long`	`getId()`
`String`	`getIdentifier()`
`SystemAuthenticatorFile`	`putFile(String key, SystemAuthenticatorFile file)`	See `Map.put(Object, Object)`

Methods inherited from class de.xima.fc.entities.AAuthenticator
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

- Constructor Detail
  - SystemAuthenticator
```
public SystemAuthenticator()
```
- Method Detail
  - getId
```
public Long getId()
```
  - getIdentifier
```
public String getIdentifier()
```
    Returns:
    
    a unique key identifying this authenticator within the system, which is used in IAuthenticatorConfigs
  - getAttributes
```
public 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
```
public Map<String,SystemAuthenticatorFile> getFileMap()
```
    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