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

Class AttributeQueryProfileConfiguration

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

All Implemented Interfaces:

AttributeResolvingProfileConfiguration, ConditionalProfileConfiguration, ProfileConfiguration, SAMLProfileConfiguration, AttributeQueryProfileConfiguration, SAML2ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class AttributeQueryProfileConfiguration
extends AbstractSAML2ProfileConfiguration
implements AttributeQueryProfileConfiguration

Configuration support for IdP SAML 2.0 attribute query profile.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,String>	attributeRecipientGroupIDLookupStrategy	Lookup strategy for attribute recipient group ID.
private Predicate<MessageContext>	clientTLSSOAPRequestsPredicate	Predicate used to determine if SOAP-based requests should use client TLS.
static final String	PROFILE_COUNTER	Name of profile counter.
private Function<ProfileRequestContext,Collection<String>>	requestedIdPAttributeNamesLookupStrategy	Lookup strategy for requested IdP attribute names to pass into resolver.
private Predicate<MessageContext>	signSOAPRequestsPredicate	Predicate used to determine if SOAP-based requests should be signed.

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

PROFILE_ID

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

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Modifier	Constructor	Description
	AttributeQueryProfileConfiguration()	Constructor.
protected	AttributeQueryProfileConfiguration(String profileId)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getAttributeRecipientGroupID(ProfileRequestContext profileRequestContext)
Collection<String>	getRequestedIdPAttributeNames(ProfileRequestContext profileRequestContext)
boolean	isClientTLSSOAPRequests(MessageContext messageContext)
boolean	isResolveAttributes(ProfileRequestContext profileRequestContext)
boolean	isSignSOAPRequests(MessageContext messageContext)
void	setAttributeRecipientGroupID(String groupID)	Set the group of services for which attributes are being resolved.
void	setAttributeRecipientGroupIDLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the lookup strategy for the group of services for which attributes are being resolved.
void	setClientTLSSOAPRequests(boolean flag)	Set whether SOAP-based requests should use client TLS.
void	setClientTLSSOAPRequestsPredicate(Predicate<MessageContext> predicate)	Set the predicate used to determine if SOAP-based requests should use client TLS.
void	setRequestedIdPAttributeNames(Collection<String> names)	Set IdPAttribute names to resolve (if resolving attributes).
void	setRequestedIdPAttributeNamesLookupStrategy(Function<ProfileRequestContext,Collection<String>> strategy)	Lookup strategy for IdPAttribute names to resolve (if resolving attributes).
void	setSignSOAPRequests(boolean flag)	Set whether SOAP-based requests should be signed.
void	setSignSOAPRequestsPredicate(Predicate<MessageContext> predicate)	Set the predicate used to determine if SOAP-based requests should be signed.

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

PROFILE_COUNTER

@Nonnull
@NotEmpty
public static final String PROFILE_COUNTER

Name of profile counter.

See Also:

• Constant Field Values

requestedIdPAttributeNamesLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Collection<String>> requestedIdPAttributeNamesLookupStrategy

Lookup strategy for requested IdP attribute names to pass into resolver.

attributeRecipientGroupIDLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> attributeRecipientGroupIDLookupStrategy

Lookup strategy for attribute recipient group ID.

signSOAPRequestsPredicate

@Nonnull
private Predicate<MessageContext> signSOAPRequestsPredicate

Predicate used to determine if SOAP-based requests should be signed.

clientTLSSOAPRequestsPredicate

@Nonnull
private Predicate<MessageContext> clientTLSSOAPRequestsPredicate

Predicate used to determine if SOAP-based requests should use client TLS.

Constructor Details

AttributeQueryProfileConfiguration

public AttributeQueryProfileConfiguration()

Constructor.

AttributeQueryProfileConfiguration

protected AttributeQueryProfileConfiguration(@Nonnull @NotEmpty
 String profileId)

Constructor.

Parameters:

profileId - unique ID for this profile

Method Details

isResolveAttributes

public boolean isResolveAttributes(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

isResolveAttributes in interface AttributeResolvingProfileConfiguration

getRequestedIdPAttributeNames

@Nonnull
@Unmodifiable
@NotLive
public Collection<String> getRequestedIdPAttributeNames(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

getRequestedIdPAttributeNames in interface AttributeResolvingProfileConfiguration

setRequestedIdPAttributeNames

public void setRequestedIdPAttributeNames(@Nullable
 Collection<String> names)

Set IdPAttribute names to resolve (if resolving attributes).

Parameters:

names - IdPAttribute names to resolve

Since:

5.2.0

setRequestedIdPAttributeNamesLookupStrategy

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

Lookup strategy for IdPAttribute names to resolve (if resolving attributes).

Parameters:

strategy - lookup strategy

Since:

5.2.0

getAttributeRecipientGroupID

@Nullable
public String getAttributeRecipientGroupID(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

getAttributeRecipientGroupID in interface AttributeResolvingProfileConfiguration

setAttributeRecipientGroupID

public void setAttributeRecipientGroupID(@Nullable
 String groupID)

Set the group of services for which attributes are being resolved.

Parameters:

groupID - group identifier

Since:

5.2.0

setAttributeRecipientGroupIDLookupStrategy

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

Set the lookup strategy for the group of services for which attributes are being resolved.

Parameters:

strategy - lookup strategy

Since:

5.2.0

isSignSOAPRequests

public boolean isSignSOAPRequests(@Nullable
 MessageContext messageContext)

Specified by:

isSignSOAPRequests in interface AttributeQueryProfileConfiguration

setSignSOAPRequests

public void setSignSOAPRequests(boolean flag)

Set whether SOAP-based requests should be signed.

Parameters:

flag - flag to set

Since:

5.2.0

setSignSOAPRequestsPredicate

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

Set the predicate used to determine if SOAP-based requests should be signed.

Parameters:

predicate - the predicate

Since:

5.2.0

isClientTLSSOAPRequests

public boolean isClientTLSSOAPRequests(@Nullable
 MessageContext messageContext)

Specified by:

isClientTLSSOAPRequests in interface AttributeQueryProfileConfiguration

setClientTLSSOAPRequests

public void setClientTLSSOAPRequests(boolean flag)

Set whether SOAP-based requests should use client TLS.

Parameters:

flag - flag to set

Since:

5.2.0

setClientTLSSOAPRequestsPredicate

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

Set the predicate used to determine if SOAP-based requests should use client TLS.

Parameters:

predicate - the predicate

Since:

5.2.0