net.shibboleth.idp.profile.config

Class AbstractProfileConfiguration

java.lang.Object

net.shibboleth.idp.profile.config.AbstractProfileConfiguration

All Implemented Interfaces:

ProfileConfiguration, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.IdentifiedComponent

public abstract class AbstractProfileConfiguration
extends Object
implements ProfileConfiguration

Base class for ProfileConfiguration implementations.

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	inboundFlows Enables inbound interceptor flows.
private List<String>	outboundFlows Enables outbound interceptor flows.
private String	profileId ID of the profile configured.
private SecurityConfiguration	securityConfiguration The security configuration for this profile.

Constructor Summary

Constructors

Constructor and Description
AbstractProfileConfiguration(String id) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId()
List<String>	getInboundInterceptorFlows() Get an ordered list of interceptor flows to run for this profile after an inbound message is decoded.
List<String>	getOutboundInterceptorFlows() Get an ordered list of interceptor flows to run for this profile before a final outbound message is generated.
SecurityConfiguration	getSecurityConfiguration() Get the SecurityConfiguration to use with this profile.
int	hashCode()
void	setInboundInterceptorFlows(Collection<String> flows) Set the ordered collection of inbound interceptor flows to enable.
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.

Methods inherited from class java.lang.Object

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

Field Detail

profileId

@Nonnull
@NotEmpty
private final String profileId

ID of the profile configured.

inboundFlows

@Nonnull
@NonnullElements
private List<String> inboundFlows

Enables inbound interceptor flows.

outboundFlows

@Nonnull
@NonnullElements
private List<String> outboundFlows

Enables outbound interceptor flows.

securityConfiguration

@Nullable
private SecurityConfiguration securityConfiguration

The security configuration for this profile.

Constructor Detail

AbstractProfileConfiguration

public AbstractProfileConfiguration(@Nonnull@NotEmpty
                            String id)

Constructor.

Parameters:

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

Method Detail

getId

@Nonnull
@NotEmpty
public String getId()

Specified by:

getId in interface net.shibboleth.utilities.java.support.component.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

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(@Nonnull@NonnullElements
                              Collection<String> flows)

Set the ordered collection of inbound interceptor flows to enable.

Parameters:

flows - flow identifiers to enable

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(@Nonnull@NonnullElements
                               Collection<String> flows)

Set the ordered collection of outbound interceptor flows to enable.

Parameters:

flows - flow identifiers to enable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object