net.shibboleth.idp.saml.attribute.mapping

Class AbstractSAMLAttributesMapper<InType extends org.opensaml.saml.saml2.core.Attribute,OutType extends IdPAttribute>

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.saml.attribute.mapping.AbstractSAMLAttributesMapper<InType,OutType>

Type Parameters:

InType - the type which is to be inspected and mapped

OutType - some sort of representation of an IdP attribute

All Implemented Interfaces:

AttributesMapper<InType,OutType>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public abstract class AbstractSAMLAttributesMapper<InType extends org.opensaml.saml.saml2.core.Attribute,OutType extends IdPAttribute>
extends AbstractIdentifiableInitializableComponent
implements AttributesMapper<InType,OutType>

The class contains the mechanics to go from a list of Attributes (or derived) to a Multimap of String,IdPAttribute (or derived, or null). The representation as a Multimap is useful for filtering situations and is exploited by AttributeInMetadata filter.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private String	logPrefix The String used to prefix log message.
private Collection<AttributeMapper<InType,OutType>>	mappers The mappers we can apply.

Constructor Summary

Constructors

Constructor and Description
AbstractSAMLAttributesMapper() Default Constructor.
AbstractSAMLAttributesMapper(AttributeResolver resolver, String id, Supplier<AbstractSAMLAttributeMapper<InType,OutType>> mapperFactory) Constructor to create the mapping from an existing resolver.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
private String	getLogPrefix() Return a string which is to be prepended to all log messages.
Collection<AttributeMapper<InType,OutType>>	getMappers() Get the mappers.
Multimap<String,OutType>	mapAttributes(List<InType> prototypes) Map the input objects into IdP attributes.
void	setMappers(Collection<AttributeMapper<InType,OutType>> theMappers) Set the attribute mappers into the lookup map.

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, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

mappers

@Nonnull
@NonnullElements
private Collection<AttributeMapper<InType extends org.opensaml.saml.saml2.core.Attribute,OutType extends IdPAttribute>> mappers

The mappers we can apply.

logPrefix

@Nullable
private String logPrefix

The String used to prefix log message.

Constructor Detail

AbstractSAMLAttributesMapper

public AbstractSAMLAttributesMapper()

Default Constructor.

AbstractSAMLAttributesMapper

public AbstractSAMLAttributesMapper(@Nonnull
                            AttributeResolver resolver,
                            @Nonnull@NotEmpty
                            String id,
                            @Nonnull
                            Supplier<AbstractSAMLAttributeMapper<InType,OutType>> mapperFactory)

Constructor to create the mapping from an existing resolver.
This code inverts the AttributeEncoder (internal attribute -> SAML Attributes) into AttributeMapper (SAML [RequestedAttributes] -> internal [Requested] Attributes).
to generate the AbstractSAMLAttributeMapper (with no AbstractSAMLAttributeMapper.getAttributeIds(). These are accumulated into a Multimap, where the key is the AbstractSAMLAttributeMapper and the values are the (IdP) attribute names. The collection of AttributeMappers can then be extracted from the map, and the appropriate internal names added (these being the value of the Multimap)

Parameters:

resolver - The resolver

id - The it

mapperFactory - A factory to generate new mappers of the correct type.

Method Detail

getMappers

@Nonnull
@NonnullElements
public Collection<AttributeMapper<InType,OutType>> getMappers()

Get the mappers.

Returns:

Returns the mappers.

setMappers

public void setMappers(@Nonnull
              Collection<AttributeMapper<InType,OutType>> theMappers)

Set the attribute mappers into the lookup map.

Parameters:

theMappers - The mappers to set.

mapAttributes

@Nonnull
@NonnullElements
public Multimap<String,OutType> mapAttributes(@Nonnull@NonnullElements
                                                             List<InType> prototypes)

Map the input objects into IdP attributes.

Specified by:

mapAttributes in interface AttributesMapper<InType extends org.opensaml.saml.saml2.core.Attribute,OutType extends IdPAttribute>

Parameters:

prototypes - the SAML attributes

Returns:

a map from IdP AttributeId to RequestedAttributes

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

getLogPrefix

@Nonnull
@NotEmpty
private String getLogPrefix()

Return a string which is to be prepended to all log messages.

Returns:

"Attribute Mappers '' :"