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

Class ECPProfileConfiguration

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

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

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

All Implemented Interfaces:

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

public class ECPProfileConfiguration
extends BrowserSSOProfileConfiguration
implements ECPProfileConfiguration

Configuration support for SP SAML 2.0 ECP.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,IDPList>	idpListLookupStrategy	Lookup function to supply IdP list.
private Function<ProfileRequestContext,String>	providerNameLookupStrategy	Lookup function to supply provider name.

Fields inherited from class net.shibboleth.sp.saml.saml2.profile.config.impl.BrowserSSOProfileConfiguration

attributeExtractionStrategyLookupStrategy, attributeResolutionPrincipalLookupStrategy

Fields inherited from interface net.shibboleth.saml.saml2.profile.config.BrowserSSOProfileConfiguration

FEATURE_AUTHNCONTEXT, FEATURE_FORCEAUTHN, FEATURE_NAMEIDFORMAT, FEATURE_SCOPING, FEATURE_SPNAMEQUALIFIER, PROFILE_ID

Fields inherited from interface net.shibboleth.saml.saml2.profile.config.ECPProfileConfiguration

PROFILE_ID

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

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Constructor	Description
ECPProfileConfiguration()	Constructor.

Method Summary

Modifier and Type	Method	Description
IDPList	getIDPList(ProfileRequestContext profileRequestContext)	Get the IDPList object to signal to the ECP client.
String	getProviderName(ProfileRequestContext profileRequestContext)	Get the provider name to signal to the ECP client.
String	getResponseBinding(ProfileRequestContext profileRequestContext)	Get the SAML binding to insert into an AuthnRequest to control the response binding.
void	setIDPList(IDPList list)	Set the IDPList object to signal to the ECP client.
void	setIDPListLookupStrategy(Function<ProfileRequestContext,IDPList> strategy)	Set the lookup strategy for the IDPList object to signal to the ECP client.
void	setProviderName(String name)	Set the provider name to signal to the ECP client.
void	setProviderNameLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the lookup strategy for the provider name to signal to the ECP client.

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

getAttributeExtractionStrategy, getAttributeIndex, getAttributeRecipientGroupID, getAttributeResolutionPrincipal, getAuthnContextClassRefs, getAuthnContextComparison, getMaximumTimeSinceAuthn, getNameIDFormat, getProxyCount, getRequestedAttributes, getRequestedIdPAttributeNames, getSPNameQualifier, isAllowUnsolicited, isCheckAddress, isCheckInResponseTo, isExtractStandardAttributes, isForceAuthn, isRequireNotOnOrAfter, isRequireRecipient, isResolveAttributes, isValidateAuthnContextClassRefs, setAllowUnsolicited, setAllowUnsolicitedPredicate, setAttributeExtractionStrategy, setAttributeExtractionStrategyLookupStrategy, setAttributeIndex, setAttributeIndexLookupStrategy, setAttributeRecipientGroupID, setAttributeRecipientGroupIDLookupStrategy, setAttributeResolutionPrincipal, setAttributeResolutionPrincipalLookupStrategy, setAuthnContextClassRefs, setAuthnContextClassRefsLookupStrategy, setAuthnContextComparison, setAuthnContextComparisonLookupStrategy, setCheckAddress, setCheckAddressPredicate, setCheckInResponseTo, setCheckInResponseToPredicate, setExtractStandardAttributes, setExtractStandardAttributesPredicate, setForceAuthn, setForceAuthnPredicate, setMaximumTimeSinceAuthn, setMaximumTimeSinceAuthnLookupStrategy, setNameIDFormat, setNameIDFormatLookupStrategy, setProxyCount, setProxyCountLookupStrategy, setRequestedAttributes, setRequestedAttributesLookupStrategy, setRequestedIdPAttributeNames, setRequestedIdPAttributeNamesLookupStrategy, setRequireNotOnOrAfter, setRequireNotOnOrAfterPredicate, setRequireRecipient, setRequireRecipientPredicate, setResolveAttributes, setResolveAttributesPredicate, setResponseBinding, setResponseBindingLookupStrategy, setSPNameQualifier, setSPNameQualifierLookupStrategy, setValidateAuthnContextClassRefs, setValidateAuthnContextClassRefsPredicate

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

getAssertionAudiences, getAssertionLifetime, isRequireSignedAssertions, setAssertionAudiences, setAssertionAudiencesLookupStrategy, setAssertionLifetime, setAssertionLifetimeLookupStrategy, setRequireSignedAssertions, setRequireSignedAssertionsPredicate

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

getAttributeRecipientGroupID, getRequestedIdPAttributeNames, isResolveAttributes

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

getAttributeIndex, getAuthnContextComparison, getMaximumTimeSinceAuthn, getProxyCount, getRequestedAttributes, getSPNameQualifier, isCheckAddress, isCheckInResponseTo, isForceAuthn

Methods inherited from interface net.shibboleth.sp.saml.saml2.profile.config.BrowserSSOProfileConfiguration

getAttributeExtractionStrategy, getAttributeResolutionPrincipal, getAuthnContextClassRefs, getNameIDFormat, isAllowUnsolicited, isExtractStandardAttributes, isRequireNotOnOrAfter, isRequireRecipient, isValidateAuthnContextClassRefs

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

isClientTLSArtifactRequests, isSignArtifactRequests

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

getAssertionAudiences, getAssertionLifetime, isRequireSignedAssertions

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

getMessageHandler, isSignRequests, isSignResponses

Field Details

providerNameLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> providerNameLookupStrategy

Lookup function to supply provider name.

idpListLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IDPList> idpListLookupStrategy

Lookup function to supply IdP list.

Constructor Details

ECPProfileConfiguration

public ECPProfileConfiguration()

Constructor.

Method Details

getResponseBinding

@Nullable
public String getResponseBinding(@Nullable
 ProfileRequestContext profileRequestContext)

Get the SAML binding to insert into an AuthnRequest to control the response binding.

Defaults tp SAMLConstants.SAML2_POST_BINDING_URI.

Specified by:

getResponseBinding in interface BrowserSSOProfileConfiguration

Overrides:

getResponseBinding in class BrowserSSOProfileConfiguration

Parameters:

profileRequestContext - current profile request context

Returns:

response binding

getProviderName

@Nullable
public String getProviderName(@Nullable
 ProfileRequestContext profileRequestContext)

Get the provider name to signal to the ECP client.

Specified by:

getProviderName in interface ECPProfileConfiguration

Parameters:

profileRequestContext - current profile request context

Returns:

provider name

setProviderName

public void setProviderName(@Nullable
 String name)

Set the provider name to signal to the ECP client.

Parameters:

name - provider name

setProviderNameLookupStrategy

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

Set the lookup strategy for the provider name to signal to the ECP client.

Parameters:

strategy - lookup strategy

getIDPList

@Nullable
public IDPList getIDPList(@Nullable
 ProfileRequestContext profileRequestContext)

Get the IDPList object to signal to the ECP client.

Specified by:

getIDPList in interface ECPProfileConfiguration

Parameters:

profileRequestContext - current profile request context

Returns:

the IdP list

setIDPList

public void setIDPList(@Nullable
 IDPList list)

Set the IDPList object to signal to the ECP client.

Parameters:

list - IdP list object

setIDPListLookupStrategy

public void setIDPListLookupStrategy(@Nonnull
 Function<ProfileRequestContext,IDPList> strategy)

Set the lookup strategy for the IDPList object to signal to the ECP client.

Parameters:

strategy - lookup strategy