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

Interface AuthenticationFlowManagement

public interface AuthenticationFlowManagement
API for authentication flow management.
Author:
P.Piernik

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAuthenticationFlow(pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition authenticatorsFlowDefinition)
    Add new authentication flow
    pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition
    getAuthenticationFlow(String name)
    Get authentication flow by given name
    Collection<pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition>
    getAuthenticationFlows()
     
    void
    removeAuthenticationFlow(String toRemove)
    Removes an existing authentication flow.
    void
    updateAuthenticationFlow(pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition authFlowdef)
    Update existing authentication flow

  • Method Details

    • addAuthenticationFlow

      void addAuthenticationFlow(pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition authenticatorsFlowDefinition) throws pl.edu.icm.unity.base.exceptions.EngineException
      Add new authentication flow
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • removeAuthenticationFlow

      void removeAuthenticationFlow(String toRemove) throws pl.edu.icm.unity.base.exceptions.EngineException
      Removes an existing authentication flow. The authentication flow must not be used by any of the endpoints, to be removed.
      Parameters:
      toRemove - authentication flow id
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • getAuthenticationFlows

      Collection<pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition> getAuthenticationFlows() throws pl.edu.icm.unity.base.exceptions.EngineException
      Returns:
      list of currently configured authentication flow
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • getAuthenticationFlow

      pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition getAuthenticationFlow(String name) throws pl.edu.icm.unity.base.exceptions.EngineException
      Get authentication flow by given name
      Returns:
      authentication flow
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • updateAuthenticationFlow

      void updateAuthenticationFlow(pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition authFlowdef) throws pl.edu.icm.unity.base.exceptions.EngineException
      Update existing authentication flow
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException