net.shibboleth.idp.saml.attribute.encoding

Class AbstractSAMLAttributeEncoder<AttributeType extends org.opensaml.saml.common.SAMLObject,EncodedType extends IdPAttributeValue>

java.lang.Object

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

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

Type Parameters:

AttributeType - type of attribute produced

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

All Implemented Interfaces:

AttributeEncoder<AttributeType>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent

Direct Known Subclasses:

AbstractSAML1AttributeEncoder, AbstractSAML2AttributeEncoder

public abstract class AbstractSAMLAttributeEncoder<AttributeType extends org.opensaml.saml.common.SAMLObject,EncodedType extends IdPAttributeValue>
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements AttributeEncoder<AttributeType>, net.shibboleth.utilities.java.support.component.UnmodifiableComponent

Base class for encoders that produce SAML attributes.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>	activationCondition Condition for use of this encoder.
private boolean	encodeType Whether to encode with xsi:type or not.
private Logger	log Class logger.
private String	name The name of the attribute.

Constructor Summary

Constructors

Constructor and Description
AbstractSAMLAttributeEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract AttributeType	buildAttribute(IdPAttribute idpAttribute, List<org.opensaml.core.xml.XMLObject> attributeValues) Builds a SAML attribute element from the given attribute values.
protected abstract boolean	canEncodeValue(IdPAttribute idpAttribute, IdPAttributeValue value) Checks if the given value can be handled by the encoder.
protected void	doInitialize()
AttributeType	encode(IdPAttribute attribute)
boolean	encodeType() Get whether to encode type information.
protected abstract org.opensaml.core.xml.XMLObject	encodeValue(IdPAttribute idpAttribute, EncodedType value) Encodes an attribute value in to a SAML attribute value element.
boolean	equals(Object obj)
com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>	getActivationCondition()
String	getName() Get the name of the attribute.
int	hashCode()
void	setActivationCondition(com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set the activation condition for this encoder.
void	setEncodeType(boolean flag) Set whether to encode type information.
void	setName(String attributeName) Set the name of the attribute.

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.attribute.AttributeEncoder

getProtocol

Field Detail

log

@Nonnull
private final Logger log

Class logger.

activationCondition

@Nonnull
private com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> activationCondition

Condition for use of this encoder.

name

@NonnullAfterInit
private String name

The name of the attribute.

encodeType

private boolean encodeType

Whether to encode with xsi:type or not.

Constructor Detail

AbstractSAMLAttributeEncoder

public AbstractSAMLAttributeEncoder()

Constructor.

Method Detail

getActivationCondition

@Nonnull
public com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> getActivationCondition()

Specified by:

getActivationCondition in interface AttributeEncoder<AttributeType extends org.opensaml.saml.common.SAMLObject>

setActivationCondition

public void setActivationCondition(@Nonnull
                          com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set the activation condition for this encoder.

Parameters:

condition - condition to set

getName

@NonnullAfterInit
public final String getName()

Get the name of the attribute.

Returns:

name of the attribute

setName

public void setName(@Nonnull@NotEmpty
           String attributeName)

Set the name of the attribute.

Parameters:

attributeName - name of the attribute

encodeType

public boolean encodeType()

Get whether to encode type information.

Defaults to 'true'

Returns:

true iff type information should be encoded

setEncodeType

public void setEncodeType(boolean flag)

Set whether to encode type information.

Parameters:

flag - flag to set

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

encode

@Nonnull
public AttributeType encode(@Nonnull
                           IdPAttribute attribute)
                                                                 throws AttributeEncodingException

Specified by:

encode in interface AttributeEncoder<AttributeType extends org.opensaml.saml.common.SAMLObject>

Throws:

AttributeEncodingException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

canEncodeValue

protected abstract boolean canEncodeValue(@Nonnull
                     IdPAttribute idpAttribute,
                     @Nonnull
                     IdPAttributeValue value)

Checks if the given value can be handled by the encoder. In many cases this is simply a check to see if the given object is of the right type.

Parameters:

idpAttribute - the attribute being encoded, never null

value - the value to check, never null

Returns:

true if the encoder can encoder this value, false if not

encodeValue

@Nullable
protected abstract org.opensaml.core.xml.XMLObject encodeValue(@Nonnull
                                                   IdPAttribute idpAttribute,
                                                   @Nonnull
                                                   EncodedType value)
                                                        throws AttributeEncodingException

Encodes an attribute value in to a SAML attribute value element.

Parameters:

idpAttribute - the attribute being encoded, never null

value - the value to encoder, never null

Returns:

the attribute value or null if the resulting attribute value would be empty

Throws:

AttributeEncodingException - thrown if there is a problem encoding the attribute value

buildAttribute

@Nonnull
protected abstract AttributeType buildAttribute(@Nonnull
                                   IdPAttribute idpAttribute,
                                   @Nonnull@NonnullElements
                                   List<org.opensaml.core.xml.XMLObject> attributeValues)
                                                                                     throws AttributeEncodingException

Builds a SAML attribute element from the given attribute values.

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