net.shibboleth.idp.saml.metadata.impl

Class AttributeMappingNodeProcessor

java.lang.Object

net.shibboleth.idp.saml.metadata.impl.AttributeMappingNodeProcessor

All Implemented Interfaces:

MetadataNodeProcessor

@NotThreadSafe
public class AttributeMappingNodeProcessor
extends Object
implements MetadataNodeProcessor

An implementation of MetadataNodeProcessor which extracts IdPRequestedAttributes from any AttributeConsumingService we find and IdPAttributes from any EntityDescriptor that we find.

Field Summary

Fields

Modifier and Type	Field and Description
private ReloadableService<net.shibboleth.idp.attribute.resolver.AttributeResolver>	attributeResolverService Service used to get the resolver used to fetch attributes.
private SAML2AttributesMapper	attributesMapper Cached AttributeMapper.
private org.joda.time.DateTime	lastReload Date when the cache was last refreshed.
private org.slf4j.Logger	log Class logger.
private boolean	refreshFailed Whether the last invocation of refreshMappers() failed.
private RequestedAttributesMapper	requestedAttributesMapper Cached RequestedAttributeMapper.

Constructor Summary

Constructors

Constructor and Description
AttributeMappingNodeProcessor(ReloadableService<net.shibboleth.idp.attribute.resolver.AttributeResolver> resolverService) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
SAML2AttributesMapper	getAttributesMapper() Get the current AttributesMapper.
RequestedAttributesMapper	getRequestedAttributesMapper() Get the current RequestedAttributesMapper.
private void	handleAttributeConsumingService(AttributeConsumingService acs) Look inside the AttributeConsumingService for any RequestedAttributes and map them.
private void	handleEntityDescriptor(EntityDescriptor entity) Look inside the EntityDescriptor for entities Attributes and map them.
void	process(XMLObject metadataNode)
protected void	refreshMappers() Inspect the service and see whether we need to reload the mappers.
void	setAttributesMapper(SAML2AttributesMapper mapper) Set the current AttributesMapper.
void	setRequestedAttributesMapper(RequestedAttributesMapper mapper) Set the current RequestedAttributesMapper.

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

attributeResolverService

@Nonnull
private final ReloadableService<net.shibboleth.idp.attribute.resolver.AttributeResolver> attributeResolverService

Service used to get the resolver used to fetch attributes.

refreshFailed

@Nonnull
private boolean refreshFailed

Whether the last invocation of refreshMappers() failed.

requestedAttributesMapper

@Nullable
private RequestedAttributesMapper requestedAttributesMapper

Cached RequestedAttributeMapper.

attributesMapper

@Nullable
private SAML2AttributesMapper attributesMapper

Cached AttributeMapper.

lastReload

@Nullable
private org.joda.time.DateTime lastReload

Date when the cache was last refreshed.

Constructor Detail

AttributeMappingNodeProcessor

public AttributeMappingNodeProcessor(@Nonnull
                             ReloadableService<net.shibboleth.idp.attribute.resolver.AttributeResolver> resolverService)

Constructor.

Parameters:

resolverService - the service for the attribute resolver we are to derive unmapping info from

Method Detail

getRequestedAttributesMapper

public RequestedAttributesMapper getRequestedAttributesMapper()

Get the current RequestedAttributesMapper.

Returns:

Returns the mapper.

setRequestedAttributesMapper

public void setRequestedAttributesMapper(@Nullable
                                RequestedAttributesMapper mapper)

Set the current RequestedAttributesMapper.

Parameters:

mapper - what to set.

getAttributesMapper

public SAML2AttributesMapper getAttributesMapper()

Get the current AttributesMapper.

Returns:

Returns the mapper.

setAttributesMapper

public void setAttributesMapper(@Nullable
                       SAML2AttributesMapper mapper)

Set the current AttributesMapper.

Parameters:

mapper - what to set.

refreshMappers

protected void refreshMappers()
                       throws FilterException

Inspect the service and see whether we need to reload the mappers.

Throws:

FilterException - if the mapping generation fails

process

public void process(XMLObject metadataNode)
             throws FilterException

Specified by:

process in interface MetadataNodeProcessor

Throws:

FilterException

handleAttributeConsumingService

private void handleAttributeConsumingService(AttributeConsumingService acs)

Look inside the AttributeConsumingService for any RequestedAttributes and map them.

Parameters:

acs - the AttributeConsumingService to look at

handleEntityDescriptor

private void handleEntityDescriptor(EntityDescriptor entity)

Look inside the EntityDescriptor for entities Attributes and map them.

Parameters:

entity - the entity