net.shibboleth.idp.saml.attribute.mapping

Class AbstractSAMLAttributeDesignatorMapper<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.AbstractSAMLAttributeDesignatorMapper<OutType>

Type Parameters:

OutType - the output (IdP Attribute) type

All Implemented Interfaces:

AttributeMapper<AttributeDesignator,OutType>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public abstract class AbstractSAMLAttributeDesignatorMapper<OutType extends IdPAttribute>
extends AbstractIdentifiableInitializableComponent
implements AttributeMapper<AttributeDesignator,OutType>

Basis of all classes which map SAML1 AttributeDesignator into an IdP IdPAttribute.

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	attributeIds The internal names to generate.
private String	attributeNamespace The attribute namespace.
private org.slf4j.Logger	log Class logger.
private String	logPrefix The String used to prefix log message.
private String	theSAMLName the (SAML) attribute name.

Constructor Summary

Constructors

Constructor and Description
AbstractSAMLAttributeDesignatorMapper()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	attributeMatches(AttributeDesignator designator) Determines if the input matches the provided parameterisation.
protected void	doInitialize()
boolean	equals(Object obj) .
List<String>	getAttributeIds() Get the list of internal identifiers.
String	getAttributeNamespace() Get the (optional) attribute namespace.
protected String	getLogPrefix() return a string which is to be prepended to all log messages.
String	getSAMLName() Get the SAML attribute name.
int	hashCode() .
Map<String,OutType>	mapAttribute(AttributeDesignator prototype) Map the SAML attribute to the required output type.
protected boolean	matches(String otherSAMLName, String otherSAMLNamespace) Compare whether the name and namespace given "match" ours.
protected abstract OutType	newAttribute(AttributeDesignator input, String id) Function to summon up the output type based on an ID and an object of the input type.
void	setAttributeIds(List<String> theIds) Set the list of internal identifiers.
void	setAttributeNamespace(String ns) Set the (optional) attribute namespace.
void	setSAMLName(String name) Set the SAML attribute name.

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, finalize, getClass, 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.

attributeIds

@Nonnull
@NonnullElements
private List<String> attributeIds

The internal names to generate.

attributeNamespace

@Nullable
private String attributeNamespace

The attribute namespace.

theSAMLName

@NonnullAfterInit
private String theSAMLName

the (SAML) attribute name.

logPrefix

@Nullable
private String logPrefix

The String used to prefix log message.

Constructor Detail

AbstractSAMLAttributeDesignatorMapper

public AbstractSAMLAttributeDesignatorMapper()

Method Detail

setAttributeIds

public void setAttributeIds(@Nullable@NullableElements
                   List<String> theIds)

Set the list of internal identifiers.

Parameters:

theIds - the list

getAttributeIds

@Nonnull
@NonnullElements
@Unmodifiable
public List<String> getAttributeIds()

Get the list of internal identifiers.

Returns:

the identifiers

setSAMLName

public void setSAMLName(@Nullable
               String name)

Set the SAML attribute name.

Parameters:

name - the name

getSAMLName

@NonnullAfterInit
public String getSAMLName()

Get the SAML attribute name.

Returns:

the name

setAttributeNamespace

public void setAttributeNamespace(@Nullable
                         String ns)

Set the (optional) attribute namespace.

Parameters:

ns - the namespace to set

getAttributeNamespace

@Nullable
public String getAttributeNamespace()

Get the (optional) attribute namespace.

Returns:

the namespace

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

matches

protected boolean matches(@Nonnull@NotEmpty
              String otherSAMLName,
              @Nullable
              String otherSAMLNamespace)

Compare whether the name and namespace given "match" ours. Used in checking both against input attributes and as part of equality checking.

Parameters:

otherSAMLName - the name to compare against

otherSAMLNamespace - the bamespace to compare against

Returns:

whether there is a match.

attributeMatches

protected boolean attributeMatches(@Nonnull
                       AttributeDesignator designator)

Determines if the input matches the provided parameterisation.

Parameters:

designator - the designator to consider

Returns:

whether it matches.

mapAttribute

@Nonnull
@NonnullElements
public Map<String,OutType> mapAttribute(@Nonnull
                                                       AttributeDesignator prototype)

Map the SAML attribute to the required output type.

If the input contains values to be decoded, failure to decode any values results in a failure to map the input at all.

Specified by:

mapAttribute in interface AttributeMapper<AttributeDesignator,OutType extends IdPAttribute>

Parameters:

prototype - the SAML attribute

Returns:

the appropriate map of names to output type

getLogPrefix

@Nonnull
@NotEmpty
protected String getLogPrefix()

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

Returns:

" Attribute Mapper '' :"

equals

public boolean equals(Object obj)

. The identity is not part of equality of hash

Overrides:

equals in class Object

hashCode

public int hashCode()

. The identity is not part of equality of hash

Overrides:

hashCode in class Object

newAttribute

@Nonnull
protected abstract OutType newAttribute(@Nonnull
                           AttributeDesignator input,
                           @Nonnull@NotEmpty
                           String id)

Function to summon up the output type based on an ID and an object of the input type. Typically the input type will be inspected for extra parameterisation.

Parameters:

input - the input value to inspect.

id - the identifier of the new attribute.

Returns:

an output, suitable set up with per object information.