net.shibboleth.idp.attribute

Interface AttributeEncoder<EncodedType>

Type Parameters:

EncodedType - the type of object created by encoding the attribute

@ThreadSafe
public interface AttributeEncoder<EncodedType>

Attribute encoders convert an IdPAttribute into a protocol specific representation. Implementations must take into account that an IdPAttribute may contain values of multiple types. An implementation encountering a value type it does not understand may either decide to ignore it or throw an AttributeEncodingException.

Encoders implement a Predicate interface to determine their applicability to a request.

Encoders MUST be thread-safe and stateless and MUST implement appropriate Object.equals(Object) and Object.hashCode() methods.

Method Summary

Methods

Modifier and Type	Method and Description
EncodedType	encode(IdPAttribute attribute) Encode the supplied attribute into a protocol specific representation.
Predicate<ProfileRequestContext>	getActivationCondition() Get an activation condition for this encoder.
String	getProtocol() Get the identifier of the protocol targeted by this encoder.

Method Detail

getProtocol

@Nonnull
@NotEmpty
String getProtocol()

Get the identifier of the protocol targeted by this encoder. Note, some protocols may have different types of encoders that are used to encode attributes in to different parts of the protocol message. This identifier should not be used to distinguish between the different message structure, it should only identify the protocol itself.

Returns:

identifier of the protocol targeted by this encounter

getActivationCondition

@Nonnull
Predicate<ProfileRequestContext> getActivationCondition()

Get an activation condition for this encoder.

Returns:

a predicate indicating whether the encoder should be applied

encode

@Nonnull
EncodedType encode(@Nonnull
                         IdPAttribute attribute)
                   throws AttributeEncodingException

Encode the supplied attribute into a protocol specific representation.

Parameters:

attribute - the attribute to encode

Returns:

the Object the attribute was encoded into

Throws:

AttributeEncodingException - if unable to successfully encode attribute