net.shibboleth.idp.authn.context

Class RequestedPrincipalContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.authn.context.RequestedPrincipalContext

All Implemented Interfaces:

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

public class RequestedPrincipalContext
extends org.opensaml.messaging.context.BaseContext

A BaseContext that holds information about an authentication request's requirement for a specific custom Principal.

Authentication protocols with features for requesting specific forms of authentication will populate this context type, typically as a child of the AuthenticationContext, with an expression of those requirements in the form of a protocol-specific operator string and an ordered list of custom Principal objects.

During the authentication process, interactions with PrincipalSupportingComponent-supporting objects will depend on them satisfying context requirements, via the use of registered PrincipalEvalPredicateFactory objects.

Upon successful authentication the most appropriate "matching" Principal will be saved back to this context for use in generating a protocol response.

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 Principal	matchingPrincipal The principal that satisfied the request, if any.
private String	operatorString Comparison operator specific to request protocol.
private List<Principal>	requestedPrincipals The principals reflecting the request requirements.

Constructor Summary

Constructors

Constructor and Description
RequestedPrincipalContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Principal	getMatchingPrincipal() Get the principal that matched the request's requirements, if any.
String	getOperator() Get the comparison operator for matching requested principals.
List<Principal>	getRequestedPrincipals() Get an immutable list of principals reflecting the request requirements.
void	setMatchingPrincipal(Principal principal) Set the principal that matched the request's requirements, if any.
void	setOperator(String operator) Set the comparison operator for matching requested principals.
void	setRequestedPrincipals(List<Principal> principals) Set list of principals reflecting the request requirements.

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

operatorString

@Nullable
private String operatorString

Comparison operator specific to request protocol.

requestedPrincipals

@Nonnull
@NonnullElements
private List<Principal> requestedPrincipals

The principals reflecting the request requirements.

matchingPrincipal

@Nullable
private Principal matchingPrincipal

The principal that satisfied the request, if any.

Constructor Detail

RequestedPrincipalContext

public RequestedPrincipalContext()

Constructor.

Method Detail

getOperator

@Nonnull
@NotEmpty
public String getOperator()

Get the comparison operator for matching requested principals.

Returns:

comparison operator

setOperator

public void setOperator(@Nullable
               String operator)

Set the comparison operator for matching requested principals.

Parameters:

operator - comparison operator

getRequestedPrincipals

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<Principal> getRequestedPrincipals()

Get an immutable list of principals reflecting the request requirements.

Returns:

immutable list of principals

setRequestedPrincipals

public void setRequestedPrincipals(@Nonnull@NonnullElements
                          List<Principal> principals)

Set list of principals reflecting the request requirements.

Parameters:

principals - list of principals

getMatchingPrincipal

@Nullable
public Principal getMatchingPrincipal()

Get the principal that matched the request's requirements, if any.

Returns:

a matching principal, or null

setMatchingPrincipal

public void setMatchingPrincipal(@Nullable
                        Principal principal)

Set the principal that matched the request's requirements, if any.

Parameters:

principal - a matching principal, or null