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(AuthenticationFlowDefinition authenticatorsFlowDefinition)	Add new authentication flow
AuthenticationFlowDefinition	getAuthenticationFlow(String name)	Get authentication flow by given name
Collection<AuthenticationFlowDefinition>	getAuthenticationFlows()
void	removeAuthenticationFlow(String toRemove)	Removes an existing authentication flow.
void	updateAuthenticationFlow(AuthenticationFlowDefinition authFlowdef)	Update existing authentication flow

Method Details

addAuthenticationFlow

void addAuthenticationFlow(AuthenticationFlowDefinition authenticatorsFlowDefinition)
                    throws EngineException

Add new authentication flow

Throws:

EngineException

removeAuthenticationFlow

void removeAuthenticationFlow(String toRemove)
                       throws 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:

EngineException

getAuthenticationFlows

Collection<AuthenticationFlowDefinition> getAuthenticationFlows()
                                                         throws EngineException

Returns:

list of currently configured authentication flow

Throws:

EngineException

getAuthenticationFlow

AuthenticationFlowDefinition getAuthenticationFlow(String name)
                                            throws EngineException

Get authentication flow by given name

Returns:

authentication flow

Throws:

EngineException

updateAuthenticationFlow

void updateAuthenticationFlow(AuthenticationFlowDefinition authFlowdef)
                       throws EngineException

Update existing authentication flow

Throws:

EngineException