Package pl.edu.icm.unity.engine.api

Interface AuthenticatorManagement

  • public interface AuthenticatorManagement
    API for authenticators management.
    Author:
    K. Benedyczak

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      pl.edu.icm.unity.types.authn.AuthenticatorInfo createAuthenticator​(java.lang.String id, java.lang.String typeId, java.lang.String config, java.lang.String credentialId)
      Creates a new authenticator
      pl.edu.icm.unity.types.authn.AuthenticatorInfo getAuthenticator​(java.lang.String id)  
      java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticatorInfo> getAuthenticators​(java.lang.String bindingId)  
      java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticatorTypeDescription> getAvailableAuthenticatorsTypes()
      Gets all available authenticators types
      void removeAuthenticator​(java.lang.String id)
      Removes an existing authenticator.
      void updateAuthenticator​(java.lang.String id, java.lang.String verificatorConfig, java.lang.String localCredential)
      Updates a configuration of an existing authenticator instance

    • Method Detail

      • getAuthenticators

        java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticatorInfo> getAuthenticators​(java.lang.String bindingId)
                                                                                throws pl.edu.icm.unity.exceptions.EngineException
        Parameters:
        bindingId - if not null allows for filtering the returned list by supported binding
        Returns:
        list of currently configured authenticators
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getAuthenticator

        pl.edu.icm.unity.types.authn.AuthenticatorInfo getAuthenticator​(java.lang.String id)
                                                         throws pl.edu.icm.unity.exceptions.EngineException
        Parameters:
        id -
        Returns:
        authenticator with given id
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • createAuthenticator

        pl.edu.icm.unity.types.authn.AuthenticatorInfo createAuthenticator​(java.lang.String id,
                                                                   java.lang.String typeId,
                                                                   java.lang.String config,
                                                                   java.lang.String credentialId)
                                                            throws pl.edu.icm.unity.exceptions.EngineException
        Creates a new authenticator
        Parameters:
        typeId - authenticator type id
        config - configuration of authenticator as string. Should be given only for remote verificators. Otherwise should be null and the credentialId must be set.
        credentialId - name of the local credential, in case when the verificator used is validating local credentials. Otherwise ignored, can be null.
        Returns:
        the created authenticator
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • updateAuthenticator

        void updateAuthenticator​(java.lang.String id,
                         java.lang.String verificatorConfig,
                         java.lang.String localCredential)
                  throws pl.edu.icm.unity.exceptions.EngineException
        Updates a configuration of an existing authenticator instance
        Parameters:
        id -
        retrievalConfig - configuration of retrieval as string
        localCredential - name of local credential in case of local authenticator
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • removeAuthenticator

        void removeAuthenticator​(java.lang.String id)
                  throws pl.edu.icm.unity.exceptions.EngineException
        Removes an existing authenticator. The authenticator must not be used by any of the endpoints, to be removed.
        Parameters:
        id -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getAvailableAuthenticatorsTypes

        java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticatorTypeDescription> getAvailableAuthenticatorsTypes()
        Gets all available authenticators types