pl.edu.icm.unity.engine.api

Interface AuthenticatorManagement

public interface AuthenticatorManagement

API for authenticators management.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method and Description
pl.edu.icm.unity.types.authn.AuthenticatorInstance	createAuthenticator(String id, String typeId, String verificatorConfig, String retrievalConfig, String credentialId) Creates a new authenticator instance
Collection<pl.edu.icm.unity.types.authn.AuthenticatorInstance>	getAuthenticators(String bindingId)
Collection<pl.edu.icm.unity.types.authn.AuthenticatorTypeDescription>	getAuthenticatorTypes(String bindingId)
void	removeAuthenticator(String id) Removes an existing authenticator.
void	updateAuthenticator(String id, String verificatorConfig, String retrievalConfig, String localCredential) Updates a configuration of an existing authenticator instance

Method Detail

getAuthenticatorTypes

Collection<pl.edu.icm.unity.types.authn.AuthenticatorTypeDescription> getAuthenticatorTypes(String bindingId)
                                                                                     throws pl.edu.icm.unity.exceptions.EngineException

Parameters:

bindingId - can be null to return all available authenticators. Otherwise filters the result to include only authenticators supporting the specified binding

Returns:

list of available authenticators

Throws:

pl.edu.icm.unity.exceptions.EngineException

getAuthenticators

Collection<pl.edu.icm.unity.types.authn.AuthenticatorInstance> getAuthenticators(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

createAuthenticator

pl.edu.icm.unity.types.authn.AuthenticatorInstance createAuthenticator(String id,
                                                                       String typeId,
                                                                       String verificatorConfig,
                                                                       String retrievalConfig,
                                                                       String credentialId)
                                                                throws pl.edu.icm.unity.exceptions.EngineException

Creates a new authenticator instance

Parameters:

typeId - authenticator type id

verificatorConfig - configuration of verificator as string. Should be given only for remote verificators. Otherwise should be null and the credentialId must be set.

retrievalConfig - configuration of retrieval as string

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

Updates a configuration of an existing authenticator instance

Parameters:

id -

verificatorConfig - configuration of verificator as string

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(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