pl.edu.icm.unity.engine.api.authn.remote

Class AbstractRemoteVerificator

java.lang.Object

pl.edu.icm.unity.engine.api.authn.AbstractVerificator

pl.edu.icm.unity.engine.api.authn.remote.AbstractRemoteVerificator

All Implemented Interfaces:

CredentialExchange, CredentialVerificator, StringConfigurable, pl.edu.icm.unity.types.DescribedObject, pl.edu.icm.unity.types.NamedObject

public abstract class AbstractRemoteVerificator
extends AbstractVerificator

Base class that is nearly mandatory for all remote verificators. The remote verificator should extend it by implementing a CredentialExchange of choice. The implementation should obtain the RemotelyAuthenticatedInput (the actual coding should be done here) and before returning it should be processed by #getResult(RemotelyAuthenticatedInput) to obtain the final authentication result.

Additionally (to enable compatibility with sandbox authN facility) the extension must call #startAuthnResponseProcessing(String...) at the beginning of authN response verification and #finishAuthnResponseProcessing(RemoteAuthnState, AuthenticationException, RemotelyAuthenticatedInput) in case of any exception produced during verification.

Author:

K. Benedyczak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractRemoteVerificator.RemoteAuthnState Marker interface only.

Nested classes/interfaces inherited from interface pl.edu.icm.unity.engine.api.authn.CredentialVerificator

CredentialVerificator.VerificatorType

Field Summary

Fields inherited from class pl.edu.icm.unity.engine.api.authn.AbstractVerificator

identityResolver, instanceName

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteVerificator(String name, String description, String exchangeId, RemoteAuthnResultProcessor processor)

Method Summary

Modifier and Type	Method and Description
protected void	finishAuthnResponseProcessing(AbstractRemoteVerificator.RemoteAuthnState state, Exception error) Should be called at the end of failed verification.
protected AuthenticationResult	getResult(RemotelyAuthenticatedInput input, String profile, AbstractRemoteVerificator.RemoteAuthnState state) This method is calling #processRemoteInput(RemotelyAuthenticatedInput) and then #assembleAuthenticationResult(RemotelyAuthenticatedContext).
protected AbstractRemoteVerificator.RemoteAuthnState	startAuthnResponseProcessing(SandboxAuthnResultCallback callback, String... loggingFacilities) Should be called at the beginning of authN response verification

Methods inherited from class pl.edu.icm.unity.engine.api.authn.AbstractVerificator

getDescription, getExchangeId, getName, setIdentityResolver, setInstanceName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface pl.edu.icm.unity.engine.api.authn.CredentialVerificator

getType

Methods inherited from interface pl.edu.icm.unity.engine.api.utils.StringConfigurable

getSerializedConfiguration, setSerializedConfiguration

Constructor Detail

AbstractRemoteVerificator

public AbstractRemoteVerificator(String name,
                                 String description,
                                 String exchangeId,
                                 RemoteAuthnResultProcessor processor)

Method Detail

getResult

protected AuthenticationResult getResult(RemotelyAuthenticatedInput input,
                                         String profile,
                                         AbstractRemoteVerificator.RemoteAuthnState state)
                                  throws AuthenticationException

This method is calling #processRemoteInput(RemotelyAuthenticatedInput) and then #assembleAuthenticationResult(RemotelyAuthenticatedContext). Usually it is the only one that is used in subclasses, when RemotelyAuthenticatedInput is obtained in an implementation specific way.

Parameters:

input -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

AuthenticationException

startAuthnResponseProcessing

protected AbstractRemoteVerificator.RemoteAuthnState startAuthnResponseProcessing(SandboxAuthnResultCallback callback,
                                                                                  String... loggingFacilities)

Should be called at the beginning of authN response verification

Parameters:

loggingFacilities - logging facilities relevant for the verification process

Returns:

finishAuthnResponseProcessing

protected void finishAuthnResponseProcessing(AbstractRemoteVerificator.RemoteAuthnState state,
                                             Exception error)

Should be called at the end of failed verification.

Parameters:

state -

error -

remoteInput - can be null if failure was upon input assembly.