net.shibboleth.idp.saml.attribute.encoding

Class AbstractSAML1AttributeEncoder<EncodedType extends IdPAttributeValue>

java.lang.Object

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

net.shibboleth.idp.saml.attribute.encoding.AbstractSAMLAttributeEncoder<Attribute,EncodedType>

net.shibboleth.idp.saml.attribute.encoding.AbstractSAML1AttributeEncoder<EncodedType>

Type Parameters:

EncodedType - the type of data that can be encoded by the encoder

All Implemented Interfaces:

AttributeEncoder<Attribute>, AttributeDesignatorMapperProcessor<IdPAttribute>, SAML1AttributeEncoder<EncodedType>, Component, DestructableComponent, InitializableComponent, UnmodifiableComponent

public abstract class AbstractSAML1AttributeEncoder<EncodedType extends IdPAttributeValue>
extends AbstractSAMLAttributeEncoder<Attribute,EncodedType>
implements SAML1AttributeEncoder<EncodedType>, AttributeDesignatorMapperProcessor<IdPAttribute>

Base class for encoders that produce a SAML 1 Attribute.

Field Summary

Fields

Modifier and Type	Field and Description
private SAMLObjectBuilder<Attribute>	attributeBuilder Builder used to construct Attribute objects.
private String	namespace The namespace in which the attribute name is interpreted.

Constructor Summary

Constructors

Constructor and Description
AbstractSAML1AttributeEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Attribute	buildAttribute(IdPAttribute idpAttribute, List<XMLObject> attributeValues) Builds a SAML attribute element from the given attribute values.
protected void	doInitialize()
boolean	equals(Object obj)
private String	getMapperId() Generate an Id suitable for the mapper.
String	getNamespace() Get the encoded Namespace of the attribute.
String	getProtocol()
int	hashCode()
void	populateAttributeMapper(AbstractSAMLAttributeDesignatorMapper<IdPAttribute> mapper) This populates the attribute mapper to go from a SAML AttributeDesignator to an IdP Attribute (or derivative) such that applying the output of the mapper to the encoder will produce the name attribute (and vice versa).
void	setNamespace(String attributeNamespace) Set the namespace in which the attribute name is interpreted.

Methods inherited from class net.shibboleth.idp.saml.attribute.encoding.AbstractSAMLAttributeEncoder

canEncodeValue, encode, encodeType, encodeValue, getActivationCondition, getName, setActivationCondition, setEncodeType, setName

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.idp.saml.attribute.encoding.SAML1AttributeEncoder

getName

Methods inherited from interface net.shibboleth.idp.attribute.AttributeEncoder

encode, getActivationCondition

Field Detail

attributeBuilder

@Nonnull
private final SAMLObjectBuilder<Attribute> attributeBuilder

Builder used to construct Attribute objects.

namespace

@NonnullAfterInit
private String namespace

The namespace in which the attribute name is interpreted.

Constructor Detail

AbstractSAML1AttributeEncoder

public AbstractSAML1AttributeEncoder()

Constructor.

Method Detail

getProtocol

@Nonnull
@NotEmpty
public final String getProtocol()

Specified by:

getProtocol in interface AttributeEncoder<Attribute>

getNamespace

@NonnullAfterInit
public String getNamespace()

Get the encoded Namespace of the attribute.

Specified by:

getNamespace in interface SAML1AttributeEncoder<EncodedType extends IdPAttributeValue>

Returns:

namespace of the attribute

setNamespace

public void setNamespace(@Nonnull@NotEmpty
                String attributeNamespace)

Set the namespace in which the attribute name is interpreted.

Parameters:

attributeNamespace - namespace in which the attribute name is interpreted

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractSAMLAttributeEncoder<Attribute,EncodedType extends IdPAttributeValue>

Throws:

ComponentInitializationException

buildAttribute

@Nonnull
protected Attribute buildAttribute(@Nonnull
                               IdPAttribute idpAttribute,
                               @Nonnull@NonnullElements
                               List<XMLObject> attributeValues)
                            throws AttributeEncodingException

Builds a SAML attribute element from the given attribute values.

Specified by:

buildAttribute in class AbstractSAMLAttributeEncoder<Attribute,EncodedType extends IdPAttributeValue>

Parameters:

idpAttribute - the attribute being encoded, never null

attributeValues - the encoded values for the attribute, never null or containing null elements

Returns:

the SAML attribute element

Throws:

AttributeEncodingException - thrown if there is a problem constructing the SAML attribute

populateAttributeMapper

@Nonnull
public void populateAttributeMapper(@Nonnull
                                   AbstractSAMLAttributeDesignatorMapper<IdPAttribute> mapper)

This populates the attribute mapper to go from a SAML AttributeDesignator to an IdP Attribute (or derivative) such that applying the output of the mapper to the encoder will produce the name attribute (and vice versa).

The populated mapper must not have any associated (IdP) Attribute names and must implement Object.equals(Object) and Object.hashCode().

Specified by:

populateAttributeMapper in interface AttributeDesignatorMapperProcessor<IdPAttribute>

Parameters:

mapper - the mapper.

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSAMLAttributeEncoder<Attribute,EncodedType extends IdPAttributeValue>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSAMLAttributeEncoder<Attribute,EncodedType extends IdPAttributeValue>

getMapperId

@Nonnull
@NotEmpty
private String getMapperId()

Generate an Id suitable for the mapper.

Returns:

a suitable Id for the mapper