net.shibboleth.idp.authn.context

Class ExternalAuthenticationContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.authn.context.ExternalAuthenticationContext

All Implemented Interfaces:

Iterable<org.opensaml.messaging.context.BaseContext>

public final class ExternalAuthenticationContext
extends org.opensaml.messaging.context.BaseContext

A context representing the state of an externalized authentication attempt, a case where authentication happens outside of a web flow.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

org.opensaml.messaging.context.BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private String	authnError Error message.
private Exception	authnException Exception.
private DateTime	authnInstant Time of authentication.
private boolean	doNotCache Flag preventing caching of result for SSO.
private String	flowExecutionUrl Value of flowExecutionUrl on branching from flow.
private Principal	principal A Principal that was authenticated.
private String	principalName Name of a principal that was authenticated.
private Subject	subject Name of a Subject that was authenticated.

Constructor Summary

Constructors

Constructor and Description
ExternalAuthenticationContext()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doNotCache() Get the "do not cache" flag.
String	getAuthnError() Get an error message from the authentication process.
Exception	getAuthnException() Get an exception from the authentication process.
DateTime	getAuthnInstant() Get the time of authentication.
String	getFlowExecutionUrl() Get the flow execution URL to return control to.
Principal	getPrincipal() Get a Principal that was authenticated.
String	getPrincipalName() Get the name of a principal that was authenticated.
Subject	getSubject() Get a Subject that was authenticated.
void	setAuthnError(String message) Set an error message from the authentication process.
void	setAuthnException(Exception exception) Set an exception from the authentication process.
void	setAuthnInstant(DateTime instant) Set the time of authentication.
void	setDoNotCache(boolean flag) Set the "do not cache" flag.
void	setFlowExecutionUrl(String url) Set the flow execution URL to return control to.
void	setPrincipal(Principal prin) Set a Principal that was authenticated.
void	setPrincipalName(String name) Set the name of a principal that was authenticated.
void	setSubject(Subject sub) Set a Subject that was authenticated.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

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

Field Detail

flowExecutionUrl

@Nullable
private String flowExecutionUrl

Value of flowExecutionUrl on branching from flow.

principal

@Nullable
private Principal principal

A Principal that was authenticated.

principalName

@Nullable
private String principalName

Name of a principal that was authenticated.

subject

@Nullable
private Subject subject

Name of a Subject that was authenticated.

authnInstant

@Nullable
private DateTime authnInstant

Time of authentication.

authnError

@Nullable
private String authnError

Error message.

authnException

@Nullable
private Exception authnException

Exception.

doNotCache

private boolean doNotCache

Flag preventing caching of result for SSO.

Constructor Detail

ExternalAuthenticationContext

public ExternalAuthenticationContext()

Method Detail

getFlowExecutionUrl

@Nullable
public String getFlowExecutionUrl()

Get the flow execution URL to return control to.

Returns:

return location

setFlowExecutionUrl

public void setFlowExecutionUrl(@Nullable
                       String url)

Set the flow execution URL to return control to.

Parameters:

url - return location

getPrincipal

@Nullable
public Principal getPrincipal()

Get a Principal that was authenticated.

Returns:

the principal

setPrincipal

public void setPrincipal(@Nullable
                Principal prin)

Set a Principal that was authenticated.

Parameters:

prin - principal to set

getPrincipalName

@Nullable
public String getPrincipalName()

Get the name of a principal that was authenticated.

Returns:

name of a principal

setPrincipalName

public void setPrincipalName(@Nullable
                    String name)

Set the name of a principal that was authenticated.

Parameters:

name - name of principal to set

getSubject

@Nullable
public Subject getSubject()

Get a Subject that was authenticated.

Returns:

subject that was authenticated

setSubject

public void setSubject(@Nullable
              Subject sub)

Set a Subject that was authenticated.

Parameters:

sub - The subject to set.

getAuthnInstant

@Nullable
public DateTime getAuthnInstant()

Get the time of authentication.

Returns:

time of authentication

setAuthnInstant

public void setAuthnInstant(DateTime instant)

Set the time of authentication.

Parameters:

instant - time of authentication to set

getAuthnError

@Nullable
public String getAuthnError()

Get an error message from the authentication process.

Returns:

an error message

setAuthnError

public void setAuthnError(String message)

Set an error message from the authentication process.

Parameters:

message - message to set

getAuthnException

@Nullable
public Exception getAuthnException()

Get an exception from the authentication process.

Returns:

an exception

setAuthnException

public void setAuthnException(Exception exception)

Set an exception from the authentication process.

Parameters:

exception - exception to set

doNotCache

public boolean doNotCache()

Get the "do not cache" flag.

Returns:

true iff the result of the authentication should not be cached

setDoNotCache

public void setDoNotCache(boolean flag)

Set the "do not cache" flag.

Parameters:

flag - flag to set