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

Interface RemoteAuthnResultProcessor

public interface RemoteAuthnResultProcessor

Processes RemotelyAuthenticatedInput by applying a translation profile to it and returns RemotelyAuthenticatedContext or AuthenticationResult depending whether caller wants to have a possibility to postprocess the translation profile output or not.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
AuthenticationResult	assembleAuthenticationResult(RemotelyAuthenticatedContext remoteContext)	Tries to resolve the primary identity from the previously created RemotelyAuthenticatedContext (usually via #processRemoteInput(RemotelyAuthenticatedInput)) and returns a final AuthenticationResult depending on the success of this action.
AuthenticationResult	getResult(RemotelyAuthenticatedInput input, java.lang.String profile, boolean dryRun, java.util.Optional<pl.edu.icm.unity.types.basic.IdentityTaV> identity)	This method is calling #processRemoteInput(RemotelyAuthenticatedInput) and then assembleAuthenticationResult(RemotelyAuthenticatedContext).
AuthenticationResult	getResult(RemotelyAuthenticatedInput input, pl.edu.icm.unity.types.translation.TranslationProfile profile, boolean dryRun, java.util.Optional<pl.edu.icm.unity.types.basic.IdentityTaV> identity)	Equivalent togetResult(RemotelyAuthenticatedInput, String, boolean, Optional) but translation profile is given directly
RemotelyAuthenticatedContext	processRemoteInput(RemotelyAuthenticatedInput input, pl.edu.icm.unity.types.translation.TranslationProfile profile, boolean dryRun, java.util.Optional<pl.edu.icm.unity.types.basic.IdentityTaV> identity)	Invokes the configured translation profile on the remotely obtained authentication input.

Method Detail

getResult

AuthenticationResult getResult(RemotelyAuthenticatedInput input,
                               java.lang.String profile,
                               boolean dryRun,
                               java.util.Optional<pl.edu.icm.unity.types.basic.IdentityTaV> identity)
                        throws AuthenticationException

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

Parameters:

input -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

AuthenticationException

getResult

AuthenticationResult getResult(RemotelyAuthenticatedInput input,
                               pl.edu.icm.unity.types.translation.TranslationProfile profile,
                               boolean dryRun,
                               java.util.Optional<pl.edu.icm.unity.types.basic.IdentityTaV> identity)
                        throws AuthenticationException

Equivalent togetResult(RemotelyAuthenticatedInput, String, boolean, Optional) but translation profile is given directly

Parameters:

input -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

AuthenticationException

assembleAuthenticationResult

AuthenticationResult assembleAuthenticationResult(RemotelyAuthenticatedContext remoteContext)
                                           throws AuthenticationException

Tries to resolve the primary identity from the previously created RemotelyAuthenticatedContext (usually via #processRemoteInput(RemotelyAuthenticatedInput)) and returns a final AuthenticationResult depending on the success of this action.

Parameters:

remoteContext -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

AuthenticationException

processRemoteInput

RemotelyAuthenticatedContext processRemoteInput(RemotelyAuthenticatedInput input,
                                                pl.edu.icm.unity.types.translation.TranslationProfile profile,
                                                boolean dryRun,
                                                java.util.Optional<pl.edu.icm.unity.types.basic.IdentityTaV> identity)
                                         throws pl.edu.icm.unity.exceptions.EngineException

Invokes the configured translation profile on the remotely obtained authentication input. Then assembles the RemotelyAuthenticatedContext from the processed input containing the information about what from the remote data is or can be meaningful in the local DB.

Parameters:

input -

identity - if not empty then fixes the identity for which the profile is executed.

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException