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

Interface AuthenticatorManagement

public interface AuthenticatorManagement

API for authenticators management.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
AuthenticatorInfo	createAuthenticator(String id, String typeId, String config, String credentialId)	Creates a new authenticator
AuthenticatorInfo	getAuthenticator(String id)
Collection<AuthenticatorInfo>	getAuthenticators(String bindingId)
Collection<AuthenticatorTypeDescription>	getAvailableAuthenticatorsTypes()	Gets all available authenticators types
void	removeAuthenticator(String id)	Removes an existing authenticator.
void	updateAuthenticator(String id, String verificatorConfig, String localCredential)	Updates a configuration of an existing authenticator instance

Method Detail

getAuthenticators

Collection<AuthenticatorInfo> getAuthenticators(String bindingId)
                                         throws EngineException

Parameters:

bindingId - if not null allows for filtering the returned list by supported binding

Returns:

list of currently configured authenticators

Throws:

EngineException

getAuthenticator

AuthenticatorInfo getAuthenticator(String id)
                            throws EngineException

Parameters:

id -

Returns:

authenticator with given id

Throws:

EngineException

createAuthenticator

AuthenticatorInfo createAuthenticator(String id,
                                      String typeId,
                                      String config,
                                      String credentialId)
                               throws 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:

EngineException

updateAuthenticator

void updateAuthenticator(String id,
                         String verificatorConfig,
                         String localCredential)
                  throws 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:

EngineException

removeAuthenticator

void removeAuthenticator(String id)
                  throws EngineException

Removes an existing authenticator. The authenticator must not be used by any of the endpoints, to be removed.

Parameters:

id -

Throws:

EngineException

getAvailableAuthenticatorsTypes

Collection<AuthenticatorTypeDescription> getAvailableAuthenticatorsTypes()

Gets all available authenticators types