Package net.shibboleth.idp.cas.attribute.transcoding.impl

Class CASStringAttributeTranscoder

java.lang.Object

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

net.shibboleth.idp.attribute.transcoding.AbstractAttributeTranscoder<Attribute>

net.shibboleth.idp.cas.attribute.AbstractCASAttributeTranscoder<StringAttributeValue>

net.shibboleth.idp.cas.attribute.transcoding.impl.CASStringAttributeTranscoder

All Implemented Interfaces:

AttributeTranscoder<Attribute>, CASAttributeTranscoder, Component, DestructableComponent, InitializableComponent

public class CASStringAttributeTranscoder
extends AbstractCASAttributeTranscoder<StringAttributeValue>

AttributeTranscoder that supports Attribute and StringAttributeValue objects.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.cas.attribute.AbstractCASAttributeTranscoder

AbstractCASAttributeTranscoder.NamingFunction

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.

Fields inherited from interface net.shibboleth.idp.cas.attribute.CASAttributeTranscoder

PROP_NAME

Constructor Summary

Constructors

Constructor	Description
CASStringAttributeTranscoder()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEncodeValue(IdPAttribute attribute, IdPAttributeValue value)	Checks if the given value can be handled by the transcoder.
protected IdPAttributeValue	decodeValue(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, String value)	Function to decode a single string value into an IdPAttributeValue.
protected String	encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, StringAttributeValue value)	Encodes an attribute value into a string.

Methods inherited from class net.shibboleth.idp.cas.attribute.AbstractCASAttributeTranscoder

buildIdPAttribute, doDecode, doEncode, getEncodedName, getEncodedType

Methods inherited from class net.shibboleth.idp.attribute.transcoding.AbstractAttributeTranscoder

decode, encode, setActivationCondition

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.idp.attribute.transcoding.AttributeTranscoder

decode, encode

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

CASStringAttributeTranscoder

public CASStringAttributeTranscoder()

Method Detail

canEncodeValue

protected boolean canEncodeValue(@Nonnull
                                 IdPAttribute attribute,
                                 @Nonnull
                                 IdPAttributeValue value)

Checks if the given value can be handled by the transcoder.

In many cases this is simply a check to see if the given object is of the right type.

Specified by:

canEncodeValue in class AbstractCASAttributeTranscoder<StringAttributeValue>

Parameters:

attribute - the attribute being encoded, never null

value - the value to check, never null

Returns:

true if the transcoder can encode this value, false if not

encodeValue

@Nullable
protected String encodeValue(@Nullable
                             ProfileRequestContext profileRequestContext,
                             @Nonnull
                             IdPAttribute attribute,
                             @Nonnull
                             TranscodingRule rule,
                             @Nonnull
                             StringAttributeValue value)
                      throws AttributeEncodingException

Encodes an attribute value into a string.

Specified by:

encodeValue in class AbstractCASAttributeTranscoder<StringAttributeValue>

Parameters:

profileRequestContext - current profile request

attribute - the attribute being encoded

rule - properties to control encoding

value - the value to encode

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

decodeValue

@Nullable
protected IdPAttributeValue decodeValue(@Nullable
                                        ProfileRequestContext profileRequestContext,
                                        @Nonnull
                                        Attribute attribute,
                                        @Nonnull
                                        TranscodingRule rule,
                                        @Nullable
                                        String value)

Function to decode a single string value into an IdPAttributeValue.

Specified by:

decodeValue in class AbstractCASAttributeTranscoder<StringAttributeValue>

Parameters:

profileRequestContext - current profile request

attribute - the attribute being decoded

rule - properties to control decoding

value - the value to decode

Returns:

the returned final IdPAttributeValue or null if decoding failed