Package net.shibboleth.idp.saml.saml2.profile.config

Class AbstractSAML2ArtifactAwareProfileConfiguration

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.profile.config.AbstractProfileConfiguration

net.shibboleth.idp.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.idp.saml.profile.config.AbstractSAMLProfileConfiguration

net.shibboleth.idp.saml.saml2.profile.config.AbstractSAML2ProfileConfiguration

net.shibboleth.idp.saml.saml2.profile.config.AbstractSAML2ArtifactAwareProfileConfiguration

All Implemented Interfaces:

ConditionalProfileConfiguration, ProfileConfiguration, SAMLArtifactAwareProfileConfiguration, SAMLArtifactConsumerProfileConfiguration, SAMLProfileConfiguration, SAML2ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

AttributeQueryProfileConfiguration, BrowserSSOProfileConfiguration, SingleLogoutProfileConfiguration

public abstract class AbstractSAML2ArtifactAwareProfileConfiguration
extends AbstractSAML2ProfileConfiguration
implements SAMLArtifactAwareProfileConfiguration, SAMLArtifactConsumerProfileConfiguration

Configuration support for artifact-aware profiles.

Since:

3.4.0

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,SAMLArtifactConfiguration>	artifactConfigurationLookupStrategy	Lookup function to supply artifactConfiguration property.
private Predicate<MessageContext>	clientTLSArtifactRequestsPredicate	Predicate used to determine if artifact resolution requests should use client TLS.
private Predicate<MessageContext>	signArtifactRequestsPredicate	Predicate used to determine if artifact resolution requests should be signed.

Fields inherited from class net.shibboleth.idp.saml.profile.config.AbstractSAMLProfileConfiguration

DEFAULT_ASSERTION_LIFETIME

Fields inherited from class net.shibboleth.idp.profile.config.AbstractProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSAML2ArtifactAwareProfileConfiguration(String profileId)	Constructor.

Method Summary

Modifier and Type	Method	Description
SAMLArtifactConfiguration	getArtifactConfiguration(ProfileRequestContext profileRequestContext)	Get the associated SAMLArtifactConfiguration for the profile, if any.
boolean	isClientTLSArtifactRequests(MessageContext messageContext)	Get whether artifact resolution requests should use client TLS.
boolean	isSignArtifactRequests(MessageContext messageContext)	Get whether artifact resolution requests should be signed.
void	setArtifactConfiguration(SAMLArtifactConfiguration config)	Set the SAML artifact configuration, if any.
void	setArtifactConfigurationLookupStrategy(Function<ProfileRequestContext,SAMLArtifactConfiguration> strategy)	Set a lookup strategy for the SAML artifact configuration.
void	setClientTLSArtifactRequests(boolean flag)	Set whether artifact resolution requests should use client TLS.
void	setClientTLSArtifactRequestsPredicate(Predicate<MessageContext> predicate)	Set the predicate used to determine if artifact resolution requests should use client TLS.
void	setSignArtifactRequests(boolean flag)	Set whether artifact resolution requests should be signed.
void	setSignArtifactRequestsPredicate(Predicate<MessageContext> predicate)	Set the predicate used to determine if artifact resolution requests should be signed.

Methods inherited from class net.shibboleth.idp.saml.saml2.profile.config.AbstractSAML2ProfileConfiguration

getProxyAudiences, getProxyCount, isEncryptAssertions, isEncryptAttributes, isEncryptionOptional, isEncryptNameIDs, isIgnoreRequestSignatures, setEncryptAssertions, setEncryptAssertionsPredicate, setEncryptAttributes, setEncryptAttributesPredicate, setEncryptionOptional, setEncryptionOptionalPredicate, setEncryptNameIDs, setEncryptNameIDsPredicate, setIgnoreRequestSignatures, setIgnoreRequestSignaturesPredicate, setProxyAudiences, setProxyAudiencesLookupStrategy, setProxyCount, setProxyCountLookupStrategy

Methods inherited from class net.shibboleth.idp.saml.profile.config.AbstractSAMLProfileConfiguration

getAdditionalAudiencesForAssertion, getAssertionLifetime, isIncludeConditionsNotBefore, isSignAssertions, isSignRequests, isSignResponses, setAdditionalAudiencesForAssertion, setAdditionalAudiencesForAssertionLookupStrategy, setAssertionLifetime, setAssertionLifetimeLookupStrategy, setIncludeConditionsNotBefore, setIncludeConditionsNotBeforePredicate, setSignAssertions, setSignAssertionsPredicate, setSignRequests, setSignRequestsPredicate, setSignResponses, setSignResponsesPredicate

Methods inherited from class net.shibboleth.idp.profile.config.AbstractConditionalProfileConfiguration

getActivationCondition, setActivationCondition

Methods inherited from class net.shibboleth.idp.profile.config.AbstractProfileConfiguration

equals, getDisallowedFeatures, getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration, hashCode, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setInboundFlowsLookupStrategy, setInboundInterceptorFlows, setInboundInterceptorFlowsLookupStrategy, setOutboundFlowsLookupStrategy, setOutboundInterceptorFlows, setOutboundInterceptorFlowsLookupStrategy, setSecurityConfiguration, setSecurityConfigurationLookupStrategy

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

setId

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

doInitialize, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getId

Methods inherited from interface net.shibboleth.idp.profile.config.ProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration

Methods inherited from interface net.shibboleth.idp.saml.profile.config.SAMLProfileConfiguration

getAdditionalAudiencesForAssertion, getAssertionLifetime, isIncludeConditionsNotBefore, isSignAssertions, isSignRequests, isSignResponses

Field Detail

artifactConfigurationLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SAMLArtifactConfiguration> artifactConfigurationLookupStrategy

Lookup function to supply artifactConfiguration property.

signArtifactRequestsPredicate

@Nonnull
private Predicate<MessageContext> signArtifactRequestsPredicate

Predicate used to determine if artifact resolution requests should be signed.

clientTLSArtifactRequestsPredicate

@Nonnull
private Predicate<MessageContext> clientTLSArtifactRequestsPredicate

Predicate used to determine if artifact resolution requests should use client TLS.

Constructor Detail

AbstractSAML2ArtifactAwareProfileConfiguration

protected AbstractSAML2ArtifactAwareProfileConfiguration(@Nonnull @NotEmpty
                                                         String profileId)

Constructor.

Parameters:

profileId - unique ID for this profile

Method Detail

getArtifactConfiguration

@Nullable
public SAMLArtifactConfiguration getArtifactConfiguration(@Nullable
                                                          ProfileRequestContext profileRequestContext)

Get the associated SAMLArtifactConfiguration for the profile, if any.

Specified by:

getArtifactConfiguration in interface SAMLArtifactAwareProfileConfiguration

Parameters:

profileRequestContext - current profile request context

Returns:

an associated artifact configuration, or null

setArtifactConfiguration

public void setArtifactConfiguration(@Nullable
                                     SAMLArtifactConfiguration config)

Set the SAML artifact configuration, if any.

Parameters:

config - configuration to set

setArtifactConfigurationLookupStrategy

public void setArtifactConfigurationLookupStrategy(@Nonnull
                                                   Function<ProfileRequestContext,SAMLArtifactConfiguration> strategy)

Set a lookup strategy for the SAML artifact configuration.

Parameters:

strategy - lookup strategy

Since:

3.3.0

isSignArtifactRequests

public boolean isSignArtifactRequests(@Nullable
                                      MessageContext messageContext)

Get whether artifact resolution requests should be signed.

Specified by:

isSignArtifactRequests in interface SAMLArtifactConsumerProfileConfiguration

Parameters:

messageContext - current message context

Returns:

whether artifact resolution requests should be signed

setSignArtifactRequests

public void setSignArtifactRequests(boolean flag)

Set whether artifact resolution requests should be signed.

Parameters:

flag - flag to set

setSignArtifactRequestsPredicate

public void setSignArtifactRequestsPredicate(@Nonnull
                                             Predicate<MessageContext> predicate)

Set the predicate used to determine if artifact resolution requests should be signed.

Parameters:

predicate - the predicate

Since:

4.0.0

isClientTLSArtifactRequests

public boolean isClientTLSArtifactRequests(@Nullable
                                           MessageContext messageContext)

Get whether artifact resolution requests should use client TLS.

Specified by:

isClientTLSArtifactRequests in interface SAMLArtifactConsumerProfileConfiguration

Parameters:

messageContext - current message context

Returns:

whether artifact resolution requests should use client TLS

setClientTLSArtifactRequests

public void setClientTLSArtifactRequests(boolean flag)

Set whether artifact resolution requests should use client TLS.

Parameters:

flag - flag to set

setClientTLSArtifactRequestsPredicate

public void setClientTLSArtifactRequestsPredicate(@Nonnull
                                                  Predicate<MessageContext> predicate)

Set the predicate used to determine if artifact resolution requests should use client TLS.

Parameters:

predicate - the predicate

Since:

4.0.0