net.shibboleth.idp.saml.attribute.resolver.impl

Class SAML2NameIDAttributeDefinition

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.attribute.resolver.AbstractResolverPlugin<IdPAttribute>

net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

net.shibboleth.idp.saml.attribute.resolver.impl.SAML2NameIDAttributeDefinition

All Implemented Interfaces:

net.shibboleth.idp.attribute.resolver.AttributeDefinition, net.shibboleth.idp.attribute.resolver.ResolverPlugin<IdPAttribute>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, org.springframework.beans.factory.DisposableBean

public class SAML2NameIDAttributeDefinition
extends net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

An attribute definition that creates attributes whose values are NameID.

When building the NameID the textual content of the NameID is the value of the source attribute. If a nameIdQualifier is provided that value is used as the NameID's NameQualifier otherwise the attribute issuer's entity ID is used. If a nameIdSPQualifier is provided then that valid is used as the NameID's SPNameQualifier, otherwise the attribute recipient's entityID is used.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.NameID>	nameIDBuilder The builder for the object represented inside this attribute.
private String	nameIdFormat Format of the NameID.
private String	nameIdQualifier Name qualifier for the NameID.
private String	nameIdSPQualifier SP name qualifier for the NameID.

Constructor Summary

Constructors

Constructor and Description
SAML2NameIDAttributeDefinition() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.opensaml.saml.saml2.core.NameID	buildNameId(String nameIdValue, net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext) Builds a name ID.
protected IdPAttribute	doAttributeDefinitionResolve(net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext, net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext)
private XMLObjectAttributeValue	encodeOneValue(IdPAttributeValue theValue, net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext) Worker function for doAttributeDefintionResolve.
String	getNameIdFormat() Gets the format for the NameID used as an attribute value.
String	getNameIdQualifier() Gets the NameQualifier for the NameID used as an attribute value.
String	getNameIdSPQualifier() Gets the SPNameQualifier for the NameID used as an attribute value.
void	setNameIdFormat(String format) Sets the format for the NameID used as an attribute value.
void	setNameIdQualifier(String qualifier) Sets the NameQualifier for the NameID used as an attribute value.
void	setNameIdSPQualifier(String qualifier) Sets the SPNameQualifier for the NameID used as an attribute value.

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

doInitialize, doResolve, getAttributeEncoders, getDisplayDescriptions, getDisplayNames, getLogPrefix, getSourceAttributeId, isDependencyOnly, setAttributeEncoders, setDependencyOnly, setDisplayDescriptions, setDisplayNames, setSourceAttributeId

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin

doDestroy, equals, getActivationCondition, getDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, resolve, setActivationCondition, setDependencies, setProfileContextStrategy, setPropagateResolutionExceptions

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

setId

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

getId

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

destroy, 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.idp.attribute.resolver.ResolverPlugin

getActivationCondition, getDependencies, isPropagateResolutionExceptions, resolve

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

initialize, isInitialized

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

destroy, isDestroyed

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

getId

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

nameIDBuilder

@Nonnull
private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.NameID> nameIDBuilder

The builder for the object represented inside this attribute.

nameIdFormat

private String nameIdFormat

Format of the NameID.

nameIdQualifier

private String nameIdQualifier

Name qualifier for the NameID.

nameIdSPQualifier

private String nameIdSPQualifier

SP name qualifier for the NameID.

Constructor Detail

SAML2NameIDAttributeDefinition

public SAML2NameIDAttributeDefinition()

Constructor.

Method Detail

getNameIdFormat

@Nullable
public String getNameIdFormat()

Gets the format for the NameID used as an attribute value.

Returns:

format for the NameID used as an attribute value

setNameIdFormat

public void setNameIdFormat(@Nullable
                   String format)

Sets the format for the NameID used as an attribute value.

Parameters:

format - format for the NameID used as an attribute value

getNameIdQualifier

@Nullable
public String getNameIdQualifier()

Gets the NameQualifier for the NameID used as an attribute value.

Returns:

NameQualifier for the NameID used as an attribute value

setNameIdQualifier

public void setNameIdQualifier(@Nullable
                      String qualifier)

Sets the NameQualifier for the NameID used as an attribute value.

Parameters:

qualifier - NameQualifier for the NameID used as an attribute value

getNameIdSPQualifier

@Nullable
public String getNameIdSPQualifier()

Gets the SPNameQualifier for the NameID used as an attribute value.

Returns:

SPNameQualifier for the NameID used as an attribute value

setNameIdSPQualifier

public void setNameIdSPQualifier(@Nullable
                        String qualifier)

Sets the SPNameQualifier for the NameID used as an attribute value.

Parameters:

qualifier - SPNameQualifier for the NameID used as an attribute value

buildNameId

protected org.opensaml.saml.saml2.core.NameID buildNameId(@Nonnull@NotEmpty
                                              String nameIdValue,
                                              @Nonnull
                                              net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext)
                                                   throws net.shibboleth.idp.attribute.resolver.ResolutionException

Builds a name ID. The provided value is the textual content of the NameID. The NameQualifier and SPNameQualifier are set according to the configuration, or to the local and requesting entityIDs respectively.

Parameters:

nameIdValue - value of the NameID

resolutionContext - current resolution context

Returns:

the constructed NameID

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if the IdP Name is empty.

encodeOneValue

@Nullable
private XMLObjectAttributeValue encodeOneValue(@Nonnull
                                              IdPAttributeValue theValue,
                                              @Nonnull
                                              net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext)
                                        throws net.shibboleth.idp.attribute.resolver.ResolutionException

Worker function for doAttributeDefintionResolve. This returns an AttributeValue if the input value is appropriate for encoding as a NameID.

Parameters:

theValue - an arbitrary value.

resolutionContext - the context to get the rest of the values from

Returns:

null or an attributeValue.

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if the IdP Name is empty.

doAttributeDefinitionResolve

@Nullable
protected IdPAttribute doAttributeDefinitionResolve(@Nonnull
                                                 net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext,
                                                 @Nonnull
                                                 net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext)
                                             throws net.shibboleth.idp.attribute.resolver.ResolutionException

Specified by:

doAttributeDefinitionResolve in class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException