Package 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:

Predicate<ProfileRequestContext>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class RelyingPartyConfiguration
extends AbstractIdentifiableInitializableComponent
implements IdentifiedComponent, Predicate<ProfileRequestContext>

The configuration that applies to a given relying party.

Field Summary

Fields

Modifier and Type	Field	Description
private Predicate<ProfileRequestContext>	activationCondition	Predicate that must be true for this configuration to be active for a given request.
private Predicate<ProfileRequestContext>	detailedErrorsPredicate	Controls whether detailed information about errors should be exposed.
private org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,Map<String,ProfileConfiguration>>	profileConfigurationsLookupStrategy	Lookup function to supply profileConfigurations property.
private Function<ProfileRequestContext,String>	responderIdLookupStrategy	Lookup function to supply responderId property.

Constructor Summary

Constructors

Constructor	Description
RelyingPartyConfiguration()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
ProfileConfiguration	getProfileConfiguration(ProfileRequestContext profileRequestContext, String profileId)	Get the profile configuration, for the relying party, for the given profile.
Map<String,ProfileConfiguration>	getProfileConfigurations(ProfileRequestContext profileRequestContext)	Get the unmodifiable set of profile configurations for this relying party.
String	getResponderId(ProfileRequestContext profileRequestContext)	Get the self-referential ID to use when responding to requests.
boolean	isDetailedErrors(ProfileRequestContext profileRequestContext)	Get whether detailed information about errors should be exposed.
void	setActivationCondition(Predicate<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	setDetailedErrorsPredicate(Predicate<ProfileRequestContext> condition)	Set a condition to determine whether detailed information about errors should be exposed.
void	setProfileConfigurations(Collection<ProfileConfiguration> configs)	Set the profile configurations for this relying party.
void	setProfileConfigurationsLookupStrategy(Function<ProfileRequestContext,Map<String,ProfileConfiguration>> strategy)	Set a lookup strategy for the profileConfigurations property.
void	setResponderId(String responder)	Set the self-referential ID to use when responding to messages.
void	setResponderIdLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set a lookup strategy for the responderId property.
boolean	test(ProfileRequestContext input)

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 java.util.function.Predicate

and, negate, or

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

responderIdLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> responderIdLookupStrategy

Lookup function to supply responderId property.

detailedErrorsPredicate

@Nonnull
private Predicate<ProfileRequestContext> detailedErrorsPredicate

Controls whether detailed information about errors should be exposed.

profileConfigurationsLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Map<String,ProfileConfiguration>> profileConfigurationsLookupStrategy

Lookup function to supply profileConfigurations property.

activationCondition

@Nonnull
private Predicate<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(@Nullable
                             ProfileRequestContext profileRequestContext)

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

Parameters:

profileRequestContext - current profile request context

Returns:

ID to use when responding

setResponderId

public void setResponderId(@Nonnull @NotEmpty
                           String responder)

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

Parameters:

responder - ID to use when responding to messages

setResponderIdLookupStrategy

public void setResponderIdLookupStrategy(@Nonnull
                                         Function<ProfileRequestContext,String> strategy)

Set a lookup strategy for the responderId property.

Parameters:

strategy - lookup strategy

Since:

3.4.0

isDetailedErrors

public boolean isDetailedErrors(@Nullable
                                ProfileRequestContext profileRequestContext)

Get whether detailed information about errors should be exposed.

Parameters:

profileRequestContext - current profile request context

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

setDetailedErrorsPredicate

public void setDetailedErrorsPredicate(@Nonnull
                                       Predicate<ProfileRequestContext> condition)

Set a condition to determine whether detailed information about errors should be exposed.

Parameters:

condition - condition to set

getProfileConfigurations

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

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

Parameters:

profileRequestContext - current profile request context

Returns:

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

getProfileConfiguration

@Nullable
public ProfileConfiguration getProfileConfiguration(@Nullable
                                                    ProfileRequestContext profileRequestContext,
                                                    @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(ProfileRequestContext). This map contains no null entries, keys, or values.

Parameters:

profileRequestContext - current profile request context

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(@Nullable @NonnullElements
                                     Collection<ProfileConfiguration> configs)

Set the profile configurations for this relying party.

Parameters:

configs - the configurations to set

setProfileConfigurationsLookupStrategy

public void setProfileConfigurationsLookupStrategy(@Nonnull
                                                   Function<ProfileRequestContext,Map<String,ProfileConfiguration>> strategy)

Set a lookup strategy for the profileConfigurations property.

Parameters:

strategy - lookup strategy

Since:

4.0.0

setActivationCondition

public void setActivationCondition(@Nonnull
                                   Predicate<ProfileRequestContext> condition)

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

Parameters:

condition - the activation condition

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

test

public boolean test(@Nullable
                    ProfileRequestContext input)

Specified by:

test in interface Predicate<ProfileRequestContext>