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<ProfileRequestContext>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class RelyingPartyConfiguration
extends AbstractIdentifiableInitializableComponent
implements IdentifiedComponent, com.google.common.base.Predicate<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<ProfileRequestContext>	activationCondition Predicate that must be true for this configuration to be active for a given request.
private com.google.common.base.Predicate<ProfileRequestContext>	detailedErrorsPredicate Controls whether detailed information about errors should be exposed.
private Logger	log Class logger.
private Map<String,ProfileConfiguration>	profileConfigurations Registered and usable communication profile configurations for this relying party.
private com.google.common.base.Function<ProfileRequestContext,Map<String,ProfileConfiguration>>	profileConfigurationsLookupStrategy Lookup function to supply profileConfigurations property.
private String	responderId Self-referential ID to use when responding to messages.
private com.google.common.base.Function<ProfileRequestContext,String>	responderIdLookupStrategy Lookup function to supply responderId property.
private javax.servlet.ServletRequest	servletRequest Access to servlet request.

Constructor Summary

Constructors

Constructor and Description
RelyingPartyConfiguration() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(ProfileRequestContext input)
protected void	doInitialize()
com.google.common.base.Predicate<ProfileRequestContext>	getDetailedErrorsPredicate() Get a condition to determine whether detailed information about errors should be exposed.
protected <T> T	getIndirectProperty(com.google.common.base.Function<ProfileRequestContext,T> lookupStrategy, T staticValue) Get a property, possibly through indirection via a lookup function.
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.
protected ProfileRequestContext	getProfileRequestContext() Get the current ProfileRequestContext.
String	getResponderId() Get the self-referential ID to use when responding to requests.
boolean	isDetailedErrors() Deprecated. Use getDetailedErrorsPredicate() instead.
void	setActivationCondition(com.google.common.base.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(com.google.common.base.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(com.google.common.base.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(com.google.common.base.Function<ProfileRequestContext,String> strategy) Set a lookup strategy for the responderId property.
void	setServletRequest(javax.servlet.ServletRequest request) Set the ServletRequest from which to obtain a reference to the current ProfileRequestContext.

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

log

@Nonnull
private final Logger log

Class logger.

servletRequest

@Nullable
private javax.servlet.ServletRequest servletRequest

Access to servlet request.

responderIdLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,String> responderIdLookupStrategy

Lookup function to supply responderId property.

responderId

@Nullable
@NotEmpty
private String responderId

Self-referential ID to use when responding to messages.

detailedErrorsPredicate

@Nonnull
private com.google.common.base.Predicate<ProfileRequestContext> detailedErrorsPredicate

Controls whether detailed information about errors should be exposed.

profileConfigurationsLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,Map<String,ProfileConfiguration>> profileConfigurationsLookupStrategy

Lookup function to supply profileConfigurations property.

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

setServletRequest

public void setServletRequest(@Nullable
                     javax.servlet.ServletRequest request)

Set the ServletRequest from which to obtain a reference to the current ProfileRequestContext.

Generally this would be expected to be a proxy to the actual object.

Parameters:

request - servlet request

Since:

3.3.0

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(@Nullable
                  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(@Nullable
                                com.google.common.base.Function<ProfileRequestContext,String> strategy)

Set a lookup strategy for the responderId property.

Parameters:

strategy - lookup strategy

Since:

3.3.0

isDetailedErrors

public boolean isDetailedErrors()

Deprecated. Use getDetailedErrorsPredicate() instead.

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

getDetailedErrorsPredicate

@Nonnull
public com.google.common.base.Predicate<ProfileRequestContext> getDetailedErrorsPredicate()

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

Returns:

a condition to evaluate

Since:

3.3.0

setDetailedErrorsPredicate

public void setDetailedErrorsPredicate(@Nonnull
                              com.google.common.base.Predicate<ProfileRequestContext> condition)

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

Parameters:

condition - condition to set

Since:

3.3.0

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

Set the profile configurations for this relying party.

Parameters:

configs - the configurations to set

setProfileConfigurationsLookupStrategy

public void setProfileConfigurationsLookupStrategy(@Nullable
                                          com.google.common.base.Function<ProfileRequestContext,Map<String,ProfileConfiguration>> strategy)

Set a lookup strategy for the profileConfigurations property.

Parameters:

strategy - lookup strategy

Since:

3.3.0

setActivationCondition

public void setActivationCondition(@Nonnull
                          com.google.common.base.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

apply

public boolean apply(@Nullable
            ProfileRequestContext input)

Specified by:

apply in interface com.google.common.base.Predicate<ProfileRequestContext>

getProfileRequestContext

@Nullable
protected ProfileRequestContext getProfileRequestContext()

Get the current ProfileRequestContext.

Returns:

current profile request context

Since:

3.3.0

getIndirectProperty

@Nullable
protected <T> T getIndirectProperty(@Nullable
                                 com.google.common.base.Function<ProfileRequestContext,T> lookupStrategy,
                                 @Nullable
                                 T staticValue)

Get a property, possibly through indirection via a lookup function.

Type Parameters:

T - type of property

Parameters:

lookupStrategy - lookup strategy function for indirect access

staticValue - static value to return in the absence of a lookup function or if null is returned

Returns:

a dynamic or static result, if any

Since:

3.3.0