net.shibboleth.idp.profile.context

Class MultiRelyingPartyContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.profile.context.MultiRelyingPartyContext

All Implemented Interfaces:

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

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

BaseContext representing multiple relying parties involved in a request, usually a subcontext of ProfileRequestContext.

The multiple parties may be accessed as a collection, by their name, or by "labels", which are specific to a given profile/scenario.

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 Map<String,RelyingPartyContext>	relyingPartyIdMap Map of RP contexts indexed by name.
private com.google.common.collect.ListMultimap<String,RelyingPartyContext>	relyingPartyLabelMap Multimap of RP contexts indexed by role.

Constructor Summary

Constructors

Constructor and Description
MultiRelyingPartyContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelyingPartyContext(String label, RelyingPartyContext context) Add a RP context associated with a label.
RelyingPartyContext	getRelyingPartyContextById(String id) Get a RP context by name/id.
Collection<RelyingPartyContext>	getRelyingPartyContexts() Get an immutable collection of the RP contexts.
Collection<RelyingPartyContext>	getRelyingPartyContexts(String label) Get an immutable collection of RP contexts associated with a label.
void	removeRelyingPartyContext(String label, RelyingPartyContext context) Remove a RP context associated with a label.

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

relyingPartyIdMap

@Nonnull
@NonnullElements
private Map<String,RelyingPartyContext> relyingPartyIdMap

Map of RP contexts indexed by name.

relyingPartyLabelMap

@Nonnull
@NonnullElements
private com.google.common.collect.ListMultimap<String,RelyingPartyContext> relyingPartyLabelMap

Multimap of RP contexts indexed by role.

Constructor Detail

MultiRelyingPartyContext

public MultiRelyingPartyContext()

Constructor.

Method Detail

getRelyingPartyContexts

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Collection<RelyingPartyContext> getRelyingPartyContexts()

Get an immutable collection of the RP contexts.

Returns:

immutable collection of RP contexts

getRelyingPartyContexts

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Collection<RelyingPartyContext> getRelyingPartyContexts(@Nonnull@NotEmpty
                                                                                                   String label)

Get an immutable collection of RP contexts associated with a label.

Parameters:

label - the label to search for

Returns:

corresponding RP contexts

getRelyingPartyContextById

@Nullable
public RelyingPartyContext getRelyingPartyContextById(@Nonnull@NotEmpty
                                                      String id)

Get a RP context by name/id.

Parameters:

id - the identifier to search for

Returns:

a corresponding RP context

addRelyingPartyContext

public void addRelyingPartyContext(@Nonnull@NotEmpty
                          String label,
                          @Nonnull
                          RelyingPartyContext context)

Add a RP context associated with a label.

Parameters:

label - the label to associate with the context

context - context to add

removeRelyingPartyContext

public void removeRelyingPartyContext(@Nonnull@NotEmpty
                             String label,
                             @Nonnull
                             RelyingPartyContext context)

Remove a RP context associated with a label.

Parameters:

label - the label associated with the context

context - context to remove