net.shibboleth.idp.attribute.resolver.context

Class AttributeResolutionContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext

All Implemented Interfaces:

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

@NotThreadSafe
public class AttributeResolutionContext
extends org.opensaml.messaging.context.BaseContext

A context supplying input to the AttributeResolver interface.

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	attributeIssuerID The attribute source identity.
private String	attributeRecipientID The attribute recipient identity.
private String	principal The principal associated with this resolution.
private String	principalAuthenticationMethod How was the principal Authenticated?
private Set<String>	requestedAttributeNames (internal) Names of the attributes that have been requested to be resolved.
private Map<String,IdPAttribute>	resolvedAttributes Attributes which were resolved and released by the attribute resolver.

Constructor Summary

Constructors

Constructor and Description
AttributeResolutionContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeIssuerID() Get the attribute issuer (me) associated with this resolution.
String	getAttributeRecipientID() Get the attribute recipient (her) associated with this resolution.
String	getPrincipal() Set the principal associated with this resolution.
String	getPrincipalAuthenticationMethod() Set how the principal was authenticated.
Collection<String>	getRequestedIdPAttributeNames() Get the (internal) names of the attributes requested to be resolved.
Map<String,IdPAttribute>	getResolvedIdPAttributes() Get the collection of resolved attributes.
void	setAttributeIssuerID(String value) Set the attribute issuer (me) associated with this resolution.
void	setAttributeRecipientID(String value) Set the attribute recipient (her) associated with this resolution.
void	setPrincipal(String who) Get the principal associated with this resolution.
void	setPrincipalAuthenticationMethod(String method) Get how the principal was authenticated.
void	setRequestedIdPAttributeNames(Collection<String> names) Set the (internal) names of the attributes requested to be resolved.
void	setResolvedIdPAttributes(Collection<IdPAttribute> attributes) Set the set of resolved attributes.

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

requestedAttributeNames

@Nonnull
@NonnullElements
private Set<String> requestedAttributeNames

(internal) Names of the attributes that have been requested to be resolved.

principal

@Nullable
private String principal

The principal associated with this resolution.

attributeIssuerID

@Nullable
private String attributeIssuerID

The attribute source identity.

attributeRecipientID

@Nullable
private String attributeRecipientID

The attribute recipient identity.

principalAuthenticationMethod

@Nullable
private String principalAuthenticationMethod

How was the principal Authenticated?

resolvedAttributes

@Nonnull
@NonnullElements
private Map<String,IdPAttribute> resolvedAttributes

Attributes which were resolved and released by the attribute resolver.

Constructor Detail

AttributeResolutionContext

public AttributeResolutionContext()

Constructor.

Method Detail

getAttributeIssuerID

@Nullable
public String getAttributeIssuerID()

Get the attribute issuer (me) associated with this resolution.

Returns:

the attribute issuer associated with this resolution.

setAttributeIssuerID

@Nullable
public void setAttributeIssuerID(@Nullable
                                 String value)

Set the attribute issuer (me) associated with this resolution.

Parameters:

value - the attribute issuer associated with this resolution.

getAttributeRecipientID

@Nullable
public String getAttributeRecipientID()

Get the attribute recipient (her) associated with this resolution.

Returns:

the attribute recipient associated with this resolution.

setAttributeRecipientID

@Nullable
public void setAttributeRecipientID(@Nullable
                                    String value)

Set the attribute recipient (her) associated with this resolution.

Parameters:

value - the attribute recipient associated with this resolution.

getPrincipalAuthenticationMethod

@Nullable
public String getPrincipalAuthenticationMethod()

Set how the principal was authenticated.

Returns:

Returns the principalAuthenticationMethod.

setPrincipalAuthenticationMethod

public void setPrincipalAuthenticationMethod(@Nullable
                                    String method)

Get how the principal was authenticated.

Parameters:

method - The principalAuthenticationMethod to set.

getPrincipal

@Nullable
public String getPrincipal()

Set the principal associated with this resolution.

Returns:

Returns the principal.

setPrincipal

public void setPrincipal(@Nullable
                String who)

Get the principal associated with this resolution.

Parameters:

who - The principal to set.

getRequestedIdPAttributeNames

@Nonnull
@NonnullElements
public Collection<String> getRequestedIdPAttributeNames()

Get the (internal) names of the attributes requested to be resolved.

Returns:

set of attributes requested to be resolved

setRequestedIdPAttributeNames

public void setRequestedIdPAttributeNames(@Nonnull@NonnullElements
                                 Collection<String> names)

Set the (internal) names of the attributes requested to be resolved.

Parameters:

names - the (internal) names of the attributes requested to be resolved

getResolvedIdPAttributes

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Map<String,IdPAttribute> getResolvedIdPAttributes()

Get the collection of resolved attributes.

Returns:

set of resolved attributes

setResolvedIdPAttributes

public void setResolvedIdPAttributes(@Nullable@NullableElements
                            Collection<IdPAttribute> attributes)

Set the set of resolved attributes.

Parameters:

attributes - set of resolved attributes