net.shibboleth.idp.profile.config

Class AbstractProfileConfiguration

java.lang.Object

net.shibboleth.idp.profile.config.AbstractProfileConfiguration

All Implemented Interfaces:

ProfileConfiguration, Component, IdentifiedComponent

Direct Known Subclasses:

AbstractConditionalProfileConfiguration

public abstract class AbstractProfileConfiguration
extends Object
implements ProfileConfiguration

Base class for ProfileConfiguration implementations.

Field Summary

Fields

Modifier and Type	Field and Description
private int	disallowedFeatures Bitmask of request features to disallow.
private com.google.common.base.Function<ProfileRequestContext,Integer>	disallowedFeaturesLookupStrategy Lookup function to return a bitmask of request features to disallow.
private List<String>	inboundFlows Enables inbound interceptor flows.
private com.google.common.base.Function<ProfileRequestContext,List<String>>	inboundFlowsLookupStrategy Lookup function to supply inboundFlows property.
private Logger	log Class logger.
private List<String>	outboundFlows Enables outbound interceptor flows.
private com.google.common.base.Function<ProfileRequestContext,List<String>>	outboundFlowsLookupStrategy Lookup function to supply outboundFlows property.
private String	profileId ID of the profile configured.
private SecurityConfiguration	securityConfiguration The security configuration for this profile.
private com.google.common.base.Function<ProfileRequestContext,SecurityConfiguration>	securityConfigurationLookupStrategy Lookup function to supply securityConfiguration property.
private javax.servlet.ServletRequest	servletRequest Access to servlet request.

Constructor Summary

Constructors

Constructor and Description
AbstractProfileConfiguration(String id) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getDisallowedFeatures() Get a bitmask of disallowed features to block.
String	getId()
List<String>	getInboundInterceptorFlows() Get an ordered list of interceptor flows to run for this profile after an inbound message is decoded.
protected <T> T	getIndirectProperty(com.google.common.base.Function<ProfileRequestContext,T> lookupStrategy, T staticValue) Get a property, possibly through indirection via a lookup function.
List<String>	getOutboundInterceptorFlows() Get an ordered list of interceptor flows to run for this profile before a final outbound message is generated.
protected ProfileRequestContext	getProfileRequestContext() Get the current ProfileRequestContext.
SecurityConfiguration	getSecurityConfiguration() Get the SecurityConfiguration to use with this profile.
int	hashCode()
boolean	isFeatureDisallowed(int feature) Return true iff the input feature constant is disallowed.
void	setDisallowedFeatures(int mask) Set a bitmask of disallowed features to block.
void	setDisallowedFeaturesLookupStrategy(com.google.common.base.Function<ProfileRequestContext,Integer> strategy) Set a lookup strategy for the bitmask of disallowed features to block.
void	setInboundFlowsLookupStrategy(com.google.common.base.Function<ProfileRequestContext,List<String>> strategy) Set a lookup strategy for the inboundFlows property.
void	setInboundInterceptorFlows(Collection<String> flows) Set the ordered collection of inbound interceptor flows to enable.
void	setOutboundFlowsLookupStrategy(com.google.common.base.Function<ProfileRequestContext,List<String>> strategy) Set a lookup strategy for the outboundFlows property.
void	setOutboundInterceptorFlows(Collection<String> flows) Set the ordered collection of outbound interceptor flows to enable.
void	setSecurityConfiguration(SecurityConfiguration configuration) Sets the security configuration for this profile.
void	setSecurityConfigurationLookupStrategy(com.google.common.base.Function<ProfileRequestContext,SecurityConfiguration> strategy) Set a lookup strategy for the securityConfiguration property.
void	setServletRequest(javax.servlet.ServletRequest request) Set the ServletRequest from which to obtain a reference to the current ProfileRequestContext.

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

servletRequest

@Nullable
private javax.servlet.ServletRequest servletRequest

Access to servlet request.

profileId

@Nonnull
@NotEmpty
private final String profileId

ID of the profile configured.

inboundFlowsLookupStrategy

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

Lookup function to supply inboundFlows property.

inboundFlows

@Nonnull
@NonnullElements
private List<String> inboundFlows

Enables inbound interceptor flows.

outboundFlowsLookupStrategy

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

Lookup function to supply outboundFlows property.

outboundFlows

@Nonnull
@NonnullElements
private List<String> outboundFlows

Enables outbound interceptor flows.

securityConfigurationLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,SecurityConfiguration> securityConfigurationLookupStrategy

Lookup function to supply securityConfiguration property.

securityConfiguration

@Nullable
private SecurityConfiguration securityConfiguration

The security configuration for this profile.

disallowedFeaturesLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,Integer> disallowedFeaturesLookupStrategy

Lookup function to return a bitmask of request features to disallow.

disallowedFeatures

private int disallowedFeatures

Bitmask of request features to disallow.

Constructor Detail

AbstractProfileConfiguration

public AbstractProfileConfiguration(@Nonnull@NotEmpty@ParameterName(name="id")
                            String id)

Constructor.

Parameters:

id - ID of the communication profile, never null or empty

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

getId

@Nonnull
@NotEmpty
public String getId()

Specified by:

getId in interface IdentifiedComponent

getSecurityConfiguration

@Nullable
public SecurityConfiguration getSecurityConfiguration()

Get the SecurityConfiguration to use with this profile.

Specified by:

getSecurityConfiguration in interface ProfileConfiguration

Returns:

security configuration to use with this profile

setSecurityConfiguration

public void setSecurityConfiguration(@Nullable
                            SecurityConfiguration configuration)

Sets the security configuration for this profile.

Parameters:

configuration - security configuration for this profile

setSecurityConfigurationLookupStrategy

public void setSecurityConfigurationLookupStrategy(@Nullable
                                          com.google.common.base.Function<ProfileRequestContext,SecurityConfiguration> strategy)

Set a lookup strategy for the securityConfiguration property.

Parameters:

strategy - lookup strategy

Since:

3.3.0

getInboundInterceptorFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getInboundInterceptorFlows()

Get an ordered list of interceptor flows to run for this profile after an inbound message is decoded.

The flow IDs returned MUST NOT contain the ProfileInterceptorFlowDescriptor.FLOW_ID_PREFIX prefix common to all interceptor flows.

Specified by:

getInboundInterceptorFlows in interface ProfileConfiguration

Returns:

a set of interceptor flow IDs to enable

setInboundInterceptorFlows

public void setInboundInterceptorFlows(@Nullable@NonnullElements
                              Collection<String> flows)

Set the ordered collection of inbound interceptor flows to enable.

Parameters:

flows - flow identifiers to enable

setInboundFlowsLookupStrategy

public void setInboundFlowsLookupStrategy(@Nullable
                                 com.google.common.base.Function<ProfileRequestContext,List<String>> strategy)

Set a lookup strategy for the inboundFlows property.

Parameters:

strategy - lookup strategy

Since:

3.3.0

getOutboundInterceptorFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getOutboundInterceptorFlows()

Get an ordered list of interceptor flows to run for this profile before a final outbound message is generated.

The flow IDs returned MUST NOT contain the ProfileInterceptorFlowDescriptor.FLOW_ID_PREFIX prefix common to all interceptor flows.

Specified by:

getOutboundInterceptorFlows in interface ProfileConfiguration

Returns:

a set of interceptor flow IDs to enable

setOutboundInterceptorFlows

public void setOutboundInterceptorFlows(@Nullable@NonnullElements
                               Collection<String> flows)

Set the ordered collection of outbound interceptor flows to enable.

Parameters:

flows - flow identifiers to enable

setOutboundFlowsLookupStrategy

public void setOutboundFlowsLookupStrategy(@Nullable
                                  com.google.common.base.Function<ProfileRequestContext,List<String>> strategy)

Set a lookup strategy for the outboundFlows property.

Parameters:

strategy - lookup strategy

Since:

3.3.0

isFeatureDisallowed

public boolean isFeatureDisallowed(int feature)

Return true iff the input feature constant is disallowed.

Parameters:

feature - a bit constant

Returns:

true iff the input feature constant is disallowed

Since:

3.3.0

getDisallowedFeatures

public int getDisallowedFeatures()

Get a bitmask of disallowed features to block.

Individual profiles define their own feature constants.

Returns:

bitmask of features to block

Since:

3.3.0

setDisallowedFeatures

public void setDisallowedFeatures(int mask)

Set a bitmask of disallowed features to block.

Parameters:

mask - a bitmask of features to block

Since:

3.3.0

setDisallowedFeaturesLookupStrategy

public void setDisallowedFeaturesLookupStrategy(@Nullable
                                       com.google.common.base.Function<ProfileRequestContext,Integer> strategy)

Set a lookup strategy for the bitmask of disallowed features to block.

Parameters:

strategy - lookup strategy

Since:

3.3.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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