Package net.shibboleth.sp.saml.saml2.profile.config.impl

Class AbstractSAML2AssertionConsumerProfileConfiguration

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.profile.config.AbstractProfileConfiguration

net.shibboleth.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.sp.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.sp.saml.saml2.profile.config.impl.AbstractSAML2ProfileConfiguration

net.shibboleth.sp.saml.saml2.profile.config.impl.AbstractSAML2ArtifactConsumerProfileConfiguration

net.shibboleth.sp.saml.saml2.profile.config.impl.AbstractSAML2AssertionConsumerProfileConfiguration

All Implemented Interfaces:

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

Direct Known Subclasses:

BrowserSSOProfileConfiguration

public abstract class AbstractSAML2AssertionConsumerProfileConfiguration
extends AbstractSAML2ArtifactConsumerProfileConfiguration
implements SAMLAssertionConsumingProfileConfiguration

Base class for SAML profile configurations.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,Set<String>>	assertionAudiencesLookupStrategy	Lookup function to supply additionalAudiences property.
private Function<ProfileRequestContext,Duration>	assertionLifetimeLookupStrategy	Lookup function to supply assertionLifetime property.
private Predicate<ProfileRequestContext>	requireSignedAssertionsPredicate	Whether to require signed assertions.

Fields inherited from interface net.shibboleth.profile.config.ProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Constructor	Description
AbstractSAML2AssertionConsumerProfileConfiguration(String profileId)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAssertionAudiences(ProfileRequestContext profileRequestContext)
Duration	getAssertionLifetime(ProfileRequestContext profileRequestContext)
boolean	isRequireSignedAssertions(ProfileRequestContext profileRequestContext)
void	setAssertionAudiences(Collection<String> audiences)	Set the set of audiences, in addition to our entityID, to validate the assertion against.
void	setAssertionAudiencesLookupStrategy(Function<ProfileRequestContext,Set<String>> strategy)	Set a lookup strategy for the set of audiences, in addition to our entityID, to validate the assertion against.
void	setAssertionLifetime(Duration lifetime)	Set the maximum lifetime of an assertion.
void	setAssertionLifetimeLookupStrategy(Function<ProfileRequestContext,Duration> strategy)	Set a lookup strategy for the maximum lifetime of an assertion.
void	setRequireSignedAssertions(boolean flag)	Set whether to require signed assertions.
void	setRequireSignedAssertionsPredicate(Predicate<ProfileRequestContext> condition)	Set condition to determine whether to require signed assertions.

Methods inherited from class net.shibboleth.sp.saml.saml2.profile.config.impl.AbstractSAML2ArtifactConsumerProfileConfiguration

isClientTLSArtifactRequests, isSignArtifactRequests, setClientTLSArtifactRequests, setClientTLSArtifactRequestsPredicate, setSignArtifactRequests, setSignArtifactRequestsPredicate

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

getMessageHandler, isEncryptionOptional, isEncryptNameIDs, isIgnoreRequestSignatures, isSignRequests, isSignResponses, setEncryptionOptional, setEncryptionOptionalPredicate, setEncryptNameIDs, setEncryptNameIDsPredicate, setIgnoreRequestSignatures, setIgnoreRequestSignaturesPredicate, setMessageHandler, setMessageHandlerLookupStrategy, setSignRequests, setSignRequestsPredicate, setSignResponses, setSignResponsesPredicate

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

setDisallowedFeatures

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

getActivationCondition, setActivationCondition

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

equals, getDisallowedFeatures, getSecurityConfiguration, hashCode, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setSecurityConfiguration, setSecurityConfigurationLookupStrategy

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, 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.shared.component.IdentifiedComponent

getId

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

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Methods inherited from interface net.shibboleth.saml.saml2.profile.config.SAML2ProfileConfiguration

isEncryptionOptional, isEncryptNameIDs, isIgnoreRequestSignatures

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

getMessageHandler, isSignRequests, isSignResponses

Field Details

requireSignedAssertionsPredicate

@Nonnull
private Predicate<ProfileRequestContext> requireSignedAssertionsPredicate

Whether to require signed assertions.

assertionLifetimeLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Duration> assertionLifetimeLookupStrategy

Lookup function to supply assertionLifetime property.

assertionAudiencesLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Set<String>> assertionAudiencesLookupStrategy

Lookup function to supply additionalAudiences property.

Constructor Details

AbstractSAML2AssertionConsumerProfileConfiguration

public AbstractSAML2AssertionConsumerProfileConfiguration(@Nonnull @NotEmpty
 String profileId)

Constructor.

Parameters:

profileId - ID of the communication profile

Method Details

isRequireSignedAssertions

public boolean isRequireSignedAssertions(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

isRequireSignedAssertions in interface SAMLAssertionConsumingProfileConfiguration

setRequireSignedAssertions

public void setRequireSignedAssertions(boolean flag)

Set whether to require signed assertions.

Parameters:

flag - flag to set

setRequireSignedAssertionsPredicate

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

Set condition to determine whether to require signed assertions.

Parameters:

condition - condition to set

getAssertionLifetime

@Nullable
@NonNegative
public Duration getAssertionLifetime(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

getAssertionLifetime in interface SAMLAssertionConsumingProfileConfiguration

setAssertionLifetime

public void setAssertionLifetime(@Nullable @NonNegative
 Duration lifetime)

Set the maximum lifetime of an assertion.

Parameters:

lifetime - lifetime of an assertion

setAssertionLifetimeLookupStrategy

public void setAssertionLifetimeLookupStrategy(@Nonnull
 Function<ProfileRequestContext,Duration> strategy)

Set a lookup strategy for the maximum lifetime of an assertion.

Parameters:

strategy - lookup strategy

getAssertionAudiences

@Nonnull
@NonnullElements
@NotLive
public Set<String> getAssertionAudiences(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

getAssertionAudiences in interface SAMLAssertionConsumingProfileConfiguration

setAssertionAudiences

public void setAssertionAudiences(@Nullable @NonnullElements
 Collection<String> audiences)

Set the set of audiences, in addition to our entityID, to validate the assertion against.

Parameters:

audiences - the additional audiences

setAssertionAudiencesLookupStrategy

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

Set a lookup strategy for the set of audiences, in addition to our entityID, to validate the assertion against.

Parameters:

strategy - lookup strategy

Since:

4.0.0