net.shibboleth.idp.saml.attribute.mapping

Class AbstractSAMLAttributeValueMapper

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.saml.attribute.mapping.AbstractSAMLAttributeValueMapper

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent

public abstract class AbstractSAMLAttributeValueMapper
extends AbstractInitializableComponent

The base of the classes that map SAML2 attribute values into IdP attribute values.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log logger.
private String	logPrefix The String used to prefix log message.

Constructor Summary

Constructors

Constructor and Description
AbstractSAMLAttributeValueMapper()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract IdPAttributeValue	decodeValue(XMLObject object) Function to decode a single XMLObject into an IdPAttributeValue.
List<IdPAttributeValue<?>>	decodeValues(List<XMLObject> inputs) Convert from a list of the SAML Objects (usually a SAML2 AttributeValue) Value into the IDP Attributes.
protected void	doInitialize()
boolean	equals(Object obj)
protected abstract String	getAttributeTypeName() Return the output type (for logging).
String	getLogPrefix() Return a string which is to be prepended to all log messages.
protected String	getStringValue(XMLObject object) Function to return the string contents if this is the correct type.
int	hashCode()
void	setLogPrefix(String prefix) Set the log prefix to use.

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

Field Detail

log

private final org.slf4j.Logger log

logger.

logPrefix

private String logPrefix

The String used to prefix log message.

Constructor Detail

AbstractSAMLAttributeValueMapper

public AbstractSAMLAttributeValueMapper()

Method Detail

decodeValues

@Nonnull
@Unmodifiable
public List<IdPAttributeValue<?>> decodeValues(@Nonnull@NonnullElements
                                                           List<XMLObject> inputs)

Convert from a list of the SAML Objects (usually a SAML2 AttributeValue) Value into the IDP Attributes.

Parameters:

inputs - the list of SAML Attributes

Returns:

a list of IdP Attributes

getStringValue

@Nullable
protected String getStringValue(@Nonnull
                             XMLObject object)

Function to return the string contents if this is the correct type.

Parameters:

object - The object to inspect.

Returns:

Its contents suitably decoded. Returns null if we could not decode.

getLogPrefix

@NonnullAfterInit
public String getLogPrefix()

Return a string which is to be prepended to all log messages. This is set by the enclosing AttributeMapper.

Returns:

Returns the logPrefix.

setLogPrefix

public void setLogPrefix(@Nonnull
                String prefix)

Set the log prefix to use.

Parameters:

prefix - The logPrefix to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

decodeValue

@Nullable
protected abstract IdPAttributeValue decodeValue(@Nonnull
                                     XMLObject object)

Function to decode a single XMLObject into an IdPAttributeValue.

Parameters:

object - the object to decode

Returns:

the returned final IdPAttributeValue or null if decoding failed

getAttributeTypeName

@Nonnull
protected abstract String getAttributeTypeName()

Return the output type (for logging).

Returns:

the output type.