net.shibboleth.idp.relyingparty

Class RelyingPartyConfiguration

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.relyingparty.RelyingPartyConfiguration

All Implemented Interfaces:

com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

public class RelyingPartyConfiguration
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
implements net.shibboleth.utilities.java.support.component.IdentifiedComponent, com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>

The configuration that applies to a given relying party.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>	activationCondition Predicate that must be true for this configuration to be active for a given request.
private boolean	detailedErrors Controls whether detailed information about errors should be exposed.
private Map<String,ProfileConfiguration>	profileConfigurations Registered and usable communication profile configurations for this relying party.
private String	responderId The entity ID of the IdP.

Constructor Summary

Constructors

Constructor and Description
RelyingPartyConfiguration() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(org.opensaml.profile.context.ProfileRequestContext input)
protected void	doInitialize()
ProfileConfiguration	getProfileConfiguration(String profileId) Get the profile configuration, for the relying party, for the given profile.
Map<String,ProfileConfiguration>	getProfileConfigurations() Get the unmodifiable set of profile configurations for this relying party.
String	getResponderId() Get the self-referential ID to use when responding to requests.
boolean	isDetailedErrors() Get whether detailed information about errors should be exposed.
void	setActivationCondition(com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set the condition under which the relying party configuration should be active.
void	setDetailedErrors(boolean flag) Set whether detailed information about errors should be exposed.
void	setProfileConfigurations(Collection<ProfileConfiguration> configs) Set the profile configurations for this relying party.
void	setResponderId(String responder) Set the self-referential ID to use when responding to requests.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface com.google.common.base.Predicate

equals

Field Detail

responderId

@NonnullAfterInit
@NotEmpty
private String responderId

The entity ID of the IdP.

detailedErrors

private boolean detailedErrors

Controls whether detailed information about errors should be exposed.

profileConfigurations

@Nonnull
@NonnullElements
private Map<String,ProfileConfiguration> profileConfigurations

Registered and usable communication profile configurations for this relying party.

activationCondition

@Nonnull
private com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> activationCondition

Predicate that must be true for this configuration to be active for a given request.

Constructor Detail

RelyingPartyConfiguration

public RelyingPartyConfiguration()

Constructor.

Method Detail

getResponderId

@Nonnull
@NotEmpty
public String getResponderId()

Get the self-referential ID to use when responding to requests.

Returns:

ID to use when responding

setResponderId

public void setResponderId(@Nonnull@NotEmpty
                  String responder)

Set the self-referential ID to use when responding to requests.

Parameters:

responder - ID to use when responding

isDetailedErrors

public boolean isDetailedErrors()

Get whether detailed information about errors should be exposed.

Returns:

true iff it is acceptable to expose detailed error information

setDetailedErrors

public void setDetailedErrors(boolean flag)

Set whether detailed information about errors should be exposed.

Parameters:

flag - flag to set

getProfileConfigurations

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Map<String,ProfileConfiguration> getProfileConfigurations()

Get the unmodifiable set of profile configurations for this relying party.

Returns:

unmodifiable set of profile configurations for this relying party, never null

getProfileConfiguration

@Nullable
public ProfileConfiguration getProfileConfiguration(@Nullable
                                                    String profileId)

Get the profile configuration, for the relying party, for the given profile. This is a convenience method and is equivalent to calling Map.get(Object) on the return of getProfileConfigurations(). This map contains no null entries, keys, or values.

Parameters:

profileId - the ID of the profile

Returns:

the configuration for the profile or null if the profile ID was null or empty or there is no configuration for the given profile

setProfileConfigurations

public void setProfileConfigurations(@Nonnull@NonnullElements
                            Collection<ProfileConfiguration> configs)

Set the profile configurations for this relying party.

Parameters:

configs - the configurations to set

setActivationCondition

public void setActivationCondition(@Nonnull
                          com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set the condition under which the relying party configuration should be active.

Parameters:

condition - the activation condition

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

apply

public boolean apply(@Nullable
            org.opensaml.profile.context.ProfileRequestContext input)

Specified by:

apply in interface com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>