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

Class RemoteAuthenticationResult

java.lang.Object

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

All Implemented Interfaces:

AuthenticationResult

public class RemoteAuthenticationResult
extends Object
implements AuthenticationResult

This class object is returned by authenticator with information about authentication result. This cover authentication result of a single authenticator, not the combined result of authentication with all authenticators in the set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteAuthenticationResult.RemoteErrorResult
static class	RemoteAuthenticationResult.RemoteSuccessResult
static class	RemoteAuthenticationResult.UnknownRemotePrincipalResult

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

AuthenticationResult.DenyReason, AuthenticationResult.ErrorResult, AuthenticationResult.ResolvableError, AuthenticationResult.Status, AuthenticationResult.SuccessResult

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteAuthenticationResult(RemoteAuthenticationResult toClone)

Method Summary

Modifier and Type	Method	Description
static RemoteAuthenticationResult	failed()
static RemoteAuthenticationResult	failed(Exception cause)
static RemoteAuthenticationResult	failed(RemotelyAuthenticatedPrincipal remotePrincipal, Exception cause, AuthenticationResult.ResolvableError error)
static RemoteAuthenticationResult	failed(RemotelyAuthenticatedPrincipal remotePrincipal, AuthenticationResult.ResolvableError error)
Optional<AuthenticationResult.DenyReason>	getDenyReason()
RemoteAuthenticationResult.RemoteErrorResult	getErrorResult()
LocalAuthenticationResult.NotApplicableResult	getNotApplicableResult()
RemotelyAuthenticatedPrincipal	getRemotelyAuthenticatedPrincipal()
AuthenticationResult.Status	getStatus()
RemoteAuthenticationResult.RemoteSuccessResult	getSuccessResult()
RemoteAuthenticationResult.UnknownRemotePrincipalResult	getUnknownRemotePrincipalResult()
boolean	isRemote()
static RemoteAuthenticationResult	notApplicable()
static RemoteAuthenticationResult	successful(RemotelyAuthenticatedPrincipal remotePrincipal, AuthenticatedEntity authenticatedEntity)
static RemoteAuthenticationResult	successfulPartial(RemotelyAuthenticatedPrincipal remotePrincipal, AuthenticatedEntity authenticatedEntity)
String	toString()
String	toStringFull()
static RemoteAuthenticationResult	unknownRemotePrincipal(RemotelyAuthenticatedPrincipal remotePrincipal, String formForUnknownPrincipal, boolean enableAssociation)

Methods inherited from class java.lang.Object

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

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

asLocal, asRemote

Constructor Detail

RemoteAuthenticationResult

protected RemoteAuthenticationResult(RemoteAuthenticationResult toClone)

Method Detail

notApplicable

public static RemoteAuthenticationResult notApplicable()

failed

public static RemoteAuthenticationResult failed(RemotelyAuthenticatedPrincipal remotePrincipal,
                                                Exception cause,
                                                AuthenticationResult.ResolvableError error)

failed

public static RemoteAuthenticationResult failed(RemotelyAuthenticatedPrincipal remotePrincipal,
                                                AuthenticationResult.ResolvableError error)

failed

public static RemoteAuthenticationResult failed()

failed

public static RemoteAuthenticationResult failed(Exception cause)

successful

public static RemoteAuthenticationResult successful(RemotelyAuthenticatedPrincipal remotePrincipal,
                                                    AuthenticatedEntity authenticatedEntity)

successfulPartial

public static RemoteAuthenticationResult successfulPartial(RemotelyAuthenticatedPrincipal remotePrincipal,
                                                           AuthenticatedEntity authenticatedEntity)

unknownRemotePrincipal

public static RemoteAuthenticationResult unknownRemotePrincipal(RemotelyAuthenticatedPrincipal remotePrincipal,
                                                                String formForUnknownPrincipal,
                                                                boolean enableAssociation)

getStatus

public AuthenticationResult.Status getStatus()

Specified by:

getStatus in interface AuthenticationResult

isRemote

public boolean isRemote()

Specified by:

isRemote in interface AuthenticationResult

getSuccessResult

public RemoteAuthenticationResult.RemoteSuccessResult getSuccessResult()

Specified by:

getSuccessResult in interface AuthenticationResult

getNotApplicableResult

public LocalAuthenticationResult.NotApplicableResult getNotApplicableResult()

getUnknownRemotePrincipalResult

public RemoteAuthenticationResult.UnknownRemotePrincipalResult getUnknownRemotePrincipalResult()

getErrorResult

public RemoteAuthenticationResult.RemoteErrorResult getErrorResult()

Specified by:

getErrorResult in interface AuthenticationResult

getRemotelyAuthenticatedPrincipal

public RemotelyAuthenticatedPrincipal getRemotelyAuthenticatedPrincipal()

toStringFull

public String toStringFull()

Specified by:

toStringFull in interface AuthenticationResult

toString

public String toString()

Overrides:

toString in class Object

getDenyReason

public Optional<AuthenticationResult.DenyReason> getDenyReason()

Specified by:

getDenyReason in interface AuthenticationResult