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

Interface AuthenticatorManagement

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

  • Method Details

    • getAuthenticators

      Collection<AuthenticatorInfo> getAuthenticators(String bindingId) throws pl.edu.icm.unity.base.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.base.exceptions.EngineException

    • getAuthenticator

      AuthenticatorInfo getAuthenticator(String id) throws pl.edu.icm.unity.base.exceptions.EngineException
      Parameters:
      id -
      Returns:
      authenticator with given id
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • createAuthenticator

      AuthenticatorInfo createAuthenticator(String id, String typeId, String config, String credentialId) throws pl.edu.icm.unity.base.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.base.exceptions.EngineException

    • updateAuthenticator

      void updateAuthenticator(String id, String verificatorConfig, String localCredential) throws pl.edu.icm.unity.base.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.base.exceptions.EngineException

    • removeAuthenticator

      void removeAuthenticator(String id) throws pl.edu.icm.unity.base.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.base.exceptions.EngineException

    • getAvailableAuthenticatorsTypes

      Collection<AuthenticatorTypeDescription> getAvailableAuthenticatorsTypes()
      Gets all available authenticators types