Package de.xima.fc.entities.interfaces

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

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

      • 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,​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)

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