Package net.shibboleth.idp.saml.saml2.nameid.transcoding.impl

Class SAML2StringNameIDTranscoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

net.shibboleth.idp.saml.attribute.transcoding.AbstractSAMLAttributeTranscoder<NameID,EncodedType>

net.shibboleth.idp.saml.saml2.nameid.transcoding.AbstractSAML2NameIDTranscoder<StringAttributeValue>

net.shibboleth.idp.saml.saml2.nameid.transcoding.impl.SAML2StringNameIDTranscoder

All Implemented Interfaces:

AttributeTranscoder<NameID>, SAML2NameIDTranscoder<StringAttributeValue>, Component, DestructableComponent, InitializableComponent

public class SAML2StringNameIDTranscoder
extends AbstractSAML2NameIDTranscoder<StringAttributeValue>

AttributeTranscoder that supports NameID and StringAttributeValue objects.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.saml.saml2.nameid.transcoding.AbstractSAML2NameIDTranscoder

AbstractSAML2NameIDTranscoder.NamingFunction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TEMPLATE	The default template.
static final String	PROP_TEMPLATE	The decoding template.

Fields inherited from interface net.shibboleth.idp.saml.saml2.nameid.transcoding.SAML2NameIDTranscoder

PROP_DEFAULT_QUALIFIERS, PROP_NAME_FORMAT

Constructor Summary

Constructors

Constructor	Description
SAML2StringNameIDTranscoder()

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, NameID nameID, TranscodingRule rule, XMLObject value)	Function to decode a single XMLObject into an IdPAttributeValue.
protected XMLObject	encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, StringAttributeValue value)	Encodes an attribute value into a SAML AttributeValue element.

Methods inherited from class net.shibboleth.idp.saml.saml2.nameid.transcoding.AbstractSAML2NameIDTranscoder

buildAttribute, buildIdPAttribute, doInitialize, getEncodedName, getEncodedType, getNameQualifier, getSPNameQualifier, getValues, setIdentityProviderNameLookupStrategy, setServiceProviderNameLookupStrategy

Methods inherited from class net.shibboleth.idp.saml.attribute.transcoding.AbstractSAMLAttributeTranscoder

doDecode, doEncode, getStringValue

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

decode, encode, getNameFromMetadata, setActivationCondition, setNameFromMetadataLookupStrategy

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.InitializableComponent

initialize, isInitialized

Field Details

PROP_TEMPLATE

@Nonnull
@NotEmpty
public static final String PROP_TEMPLATE

The decoding template.

See Also:

• Constant Field Values

DEFAULT_TEMPLATE

@Nonnull
@NotEmpty
public static final String DEFAULT_TEMPLATE

The default template.

See Also:

• Constant Field Values

Constructor Details

SAML2StringNameIDTranscoder

public SAML2StringNameIDTranscoder()

Method Details

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 AbstractSAMLAttributeTranscoder<NameID,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 XMLObject encodeValue(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 IdPAttribute attribute,
 @Nonnull
 TranscodingRule rule,
 @Nonnull
 StringAttributeValue value)
                         throws AttributeEncodingException

Encodes an attribute value into a SAML AttributeValue element.

Specified by:

encodeValue in class AbstractSAMLAttributeTranscoder<NameID,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
 NameID nameID,
 @Nonnull
 TranscodingRule rule,
 @Nullable
 XMLObject value)

Function to decode a single XMLObject into an IdPAttributeValue.

Specified by:

decodeValue in class AbstractSAMLAttributeTranscoder<NameID,StringAttributeValue>

Parameters:

profileRequestContext - current profile request

nameID - the attribute being decoded

rule - properties to control decoding

value - the value to decode

Returns:

the returned final IdPAttributeValue or null if decoding failed