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

Type Parameters:
TFile - Type of the authenticator file, i.e. either ClientAuthenticatorFile or SystemAuthenticatorFile.
All Superinterfaces:
IDescriptionProviding, INameProviding, IUUIDEntity
All Known Implementing Classes:
AAuthenticator, ClientAuthenticator, SystemAuthenticator
public interface IAuthenticator<TFile 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

  • Method Details

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

    • getCallbackUrlType

      EAuthCallbackUrlType getCallbackUrlType()
      Returns:
      the type of callback URL to be used by this authenticator.

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

    • getIdentifier

      String getIdentifier()
      Returns:
      a unique key identifying this authenticator within the system, which is used in IAuthenticatorConfigs

    • 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,TFile> 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 or null if the attribute does not exist.
      See Also:

    • getAttributeValue

      String getAttributeValue(String key, String defaultValue)
      Parameters:
      key - Key of an attribute to fetch.
      defaultValue - Default value to return if the attribute does not exist.
      Returns:
      The value of the attribute with the given key or the default value if the attribute does not exist.
      See Also:

    • setFileMap

      void setFileMap(Map<String,TFile> fileMap)

    • removeFile

      TFile removeFile(String key)

    • putFile

      TFile putFile(String key, TFile 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)

    • getAttributeValueList

      List<String> getAttributeValueList(String key)
      Get the List value of the attribute with the given key
      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.