net.shibboleth.idp.saml.attribute.encoding

Class AbstractSAML2AttributeEncoder<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.AbstractSAML2AttributeEncoder<EncodedType>

Type Parameters:

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

All Implemented Interfaces:

AttributeEncoder<Attribute>, SAML2AttributeEncoder<EncodedType>, Component, DestructableComponent, InitializableComponent, UnmodifiableComponent

public abstract class AbstractSAML2AttributeEncoder<EncodedType extends IdPAttributeValue>
extends AbstractSAMLAttributeEncoder<Attribute,EncodedType>
implements SAML2AttributeEncoder<EncodedType>

Base class for encoders that produce a SAML 2 Attribute.

Field Summary

Fields

Modifier and Type	Field and Description
private SAMLObjectBuilder<Attribute>	attributeBuilder Builder used to construct Attribute objects.
private String	format The format of the attribute name.
private String	friendlyName A friendly, human readable, name for the attribute.

Constructor Summary

Constructors

Constructor and Description
AbstractSAML2AttributeEncoder() 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.
boolean	equals(Object obj)
String	getEffectiveNameFormat() Get the name format, or the SAML constants for "unspecified", if not set.
String	getFriendlyName() Get the friendly, human readable, name for the attribute.
protected String	getMapperId() Generate an Id suitable for the mapper.
String	getNameFormat() Get the encoded NameFormat of the attribute.
String	getProtocol()
int	hashCode()
void	setFriendlyName(String attributeFriendlyName) Set the friendly, human readable, name for the attribute.
void	setNameFormat(String nameFormat) Set the format of the attribute name.

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

canEncodeValue, doInitialize, 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.SAML2AttributeEncoder

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.

friendlyName

@Nullable
private String friendlyName

A friendly, human readable, name for the attribute.

format

@Nullable
private String format

The format of the attribute name.

Constructor Detail

AbstractSAML2AttributeEncoder

public AbstractSAML2AttributeEncoder()

Constructor.

Method Detail

getProtocol

@Nonnull
public final String getProtocol()

Specified by:

getProtocol in interface AttributeEncoder<Attribute>

getFriendlyName

@Nullable
public final String getFriendlyName()

Get the friendly, human readable, name for the attribute.

Returns:

friendly, human readable, name for the attribute

setFriendlyName

public void setFriendlyName(@Nullable
                   String attributeFriendlyName)

Set the friendly, human readable, name for the attribute.

Parameters:

attributeFriendlyName - friendly, human readable, name for the attribute

getNameFormat

@Nullable
public String getNameFormat()

Get the encoded NameFormat of the attribute.

Specified by:

getNameFormat in interface SAML2AttributeEncoder<EncodedType extends IdPAttributeValue>

Returns:

name format of the attribute

getEffectiveNameFormat

@Nonnull
@NotEmpty
public String getEffectiveNameFormat()

Get the name format, or the SAML constants for "unspecified", if not set.

Returns:

the effective name format regardless of nulls

setNameFormat

public void setNameFormat(@Nullable
                 String nameFormat)

Set the format of the attribute name.

Parameters:

nameFormat - format in which the attribute name is interpreted

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

getMapperId

@Nonnull
protected String getMapperId()

Generate an Id suitable for the mapper.

Returns:

a suitable Id for 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>