net.shibboleth.idp.saml.attribute.mapping

Class AbstractSAMLAttributeMapper<InType extends 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.AbstractSAMLAttributeMapper<InType,OutType>

Type Parameters:

InType - the input (SAML2 attribute) type

OutType - the output (IdP Attribute) type

All Implemented Interfaces:

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

public abstract class AbstractSAMLAttributeMapper<InType extends Attribute,OutType extends IdPAttribute>
extends AbstractIdentifiableInitializableComponent
implements AttributeMapper<InType,OutType>

Basis of all classes which map SAML2 Attribute into an IdP IdPAttribute.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractSAMLAttributeMapper()

Method Summary

Methods

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

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.

attributeFormat

@Nullable
private String attributeFormat

The attribute format.

theSAMLName

@NonnullAfterInit
private String theSAMLName

the (SAML) attribute name.

logPrefix

@Nullable
private String logPrefix

The String used to prefix log message.

valueMapper

@NonnullAfterInit
private AbstractSAMLAttributeValueMapper valueMapper

The value mapper.

Constructor Detail

AbstractSAMLAttributeMapper

public AbstractSAMLAttributeMapper()

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

setValueMapper

public void setValueMapper(@Nullable
                  AbstractSAMLAttributeValueMapper mapper)

Get the class which converts types.

Parameters:

mapper - The valueMapper to set.

getValueMapper

@NonnullAfterInit
public AbstractSAMLAttributeValueMapper getValueMapper()

Get the class which converts types.

Returns:

Returns the valueMapper.

setAttributeFormat

public void setAttributeFormat(@Nullable
                      String format)

Set the (optional) attribute format.

Parameters:

format - the format

getAttributeFormat

@Nullable
public String getAttributeFormat()

Get the (optional) attribute format.

Returns:

the format

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

matches

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

Compare whether the name and format given "match" ours. Used in checking both against input attributes and as part of equality checking. For the sake of comparison null is considered to be the same as Attribute.UNSPECIFIED

Parameters:

otherSAMLName - the name to compare against

otherSAMLFormat - the format to compare against

Returns:

whether there is a match.

attributeMatches

protected boolean attributeMatches(@Nonnull
                       InType attribute)

Determines if the attribute matches the provided parameterisation.

Parameters:

attribute - the attribute to consider

Returns:

whether it matches.

mapAttribute

@Nonnull
@NonnullElements
public Map<String,OutType> mapAttribute(@Nonnull
                                                       InType 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<InType extends Attribute,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
                           InType 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.