Package net.shibboleth.oidc.attribute.transcoding.impl

Class OIDCStringAttributeTranscoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

net.shibboleth.oidc.attribute.transcoding.AbstractOIDCAttributeTranscoder

net.shibboleth.oidc.attribute.transcoding.impl.OIDCStringAttributeTranscoder

All Implemented Interfaces:

AttributeTranscoder<JSONObject>, OIDCAttributeTranscoder, Component, DestructableComponent, InitializableComponent

public class OIDCStringAttributeTranscoder
extends AbstractOIDCAttributeTranscoder

Class encoding string attributes to string json object. Name of the attribute will be set as the key. The string contains attribute value. If there are several attribute values they are delimited with delimiter(space is default) or placed to array. If the value is set to be interpreted as int, only values that may be parsed to int are used. In case output is interpreted as int but not set to array, only the first parsable value is used. If the value is interpreted as boolean the value is true if string value equals to "true" ignoring the case. If boolean values are not set to array the first string value is considered to be the result. Finally, the result may be placed to json Object.

For decoding, attempt to convert the input JSON type into a StringAttributeValue in the following way for the following JSON types:

• If a String, convert directly to a string attribute value.
• If an Integer or Double (a number type) and PROP_NUMBER_AS_STRING is true, convert to string, else return an empty values list.
• If a Boolean and PROP_BOOLEAN_AS_STRING is true, convert boolean to 'true' or 'false' string, else return an empty values list.
• If a JSON Array and PROP_ARRAY_AS_STRING is true, convert to a string by serializing the array to a JSON string.
• If a JSON Array and PROP_ARRAY_AS_STRING is false, attempt to recursively convert elements of the array to string attribute values using the same set of rules. If any element fails to convert it will be excluded from the result.
• If a JSON Object and PROP_ASOBJECT is true, convert the object to a string by serializing into JSON. Else, return an empty values list.
• For any other unknown type, return an empty values list.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.oidc.attribute.transcoding.AbstractOIDCAttributeTranscoder

AbstractOIDCAttributeTranscoder.NamingFunction

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
static final String	PROP_ASOBJECT	Whether to parse the values into and out as a JSON object.

Fields inherited from interface net.shibboleth.oidc.attribute.transcoding.OIDCAttributeTranscoder

METADATA_TAG_NAME, PROP_ARRAY_AS_STRING, PROP_ASARRAY, PROP_ASBOOLEAN, PROP_ASINTEGER, PROP_BOOLEAN_AS_STRING, PROP_NAME, PROP_NAME_FROM_METADATA, PROP_NUMBER_AS_STRING, PROP_STRING_DELIMITER

Constructor Summary

Constructors

Constructor	Description
OIDCStringAttributeTranscoder()

Method Summary

Modifier and Type	Method	Description
protected List<IdPAttributeValue>	decodeValues(ProfileRequestContext profileRequestContext, Object input, TranscodingRule rule)	Subclasses should override this method to perform specific claim value decoding into IdPAttributeValue objects.
protected Object	encodeValues(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule)	Performs encoding of IdPAttribute's values based on rule into a claim value.
private Object	toJSONObject(String value)	Parses string as JSONObject.
private List<?>	transformValues(TranscodingRule rule, Stream<String> attributeValues)	Converts string values to List of Integer, String or Boolean depending on rule.

Methods inherited from class net.shibboleth.oidc.attribute.transcoding.AbstractOIDCAttributeTranscoder

buildClaim, buildIdPAttribute, doDecode, doEncode, getEncodedName, getEncodedName, getEncodedType, getNameFromMetadata, setNameFromMetadataLookupStrategy

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

decode, encode, setActivationCondition

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

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, 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_ASOBJECT

@Nonnull
@NotEmpty
public static final String PROP_ASOBJECT

Whether to parse the values into and out as a JSON object.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Details

OIDCStringAttributeTranscoder

public OIDCStringAttributeTranscoder()

Method Details

encodeValues

@Nullable
protected Object encodeValues(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 IdPAttribute attribute,
 @Nonnull
 TranscodingRule rule)
                       throws AttributeEncodingException

Performs encoding of IdPAttribute's values based on rule into a claim value.

Specified by:

encodeValues in class AbstractOIDCAttributeTranscoder

Parameters:

profileRequestContext - current profile request

attribute - the attribute being encoded

rule - properties to control encoding

Returns:

Integer, Boolean, String, JSON Array or JSON Object value for claim

Throws:

AttributeEncodingException - if there's a problem encoding the values

decodeValues

@Nonnull
protected List<IdPAttributeValue> decodeValues(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 Object input,
 @Nonnull
 TranscodingRule rule)
                                        throws AttributeDecodingException

Subclasses should override this method to perform specific claim value decoding into IdPAttributeValue objects.

Specified by:

decodeValues in class AbstractOIDCAttributeTranscoder

Parameters:

profileRequestContext - current profile request context

input - the raw claim value

rule - properties to control decoding

Returns:

a possibly empty list of decoded values

Throws:

AttributeDecodingException - if there's a problem decoding the claim value

toJSONObject

@Nonnull
private Object toJSONObject(@Nonnull @NotEmpty
 String value)
                     throws AttributeEncodingException

Parses string as JSONObject.

Parameters:

value - string to parse

Returns:

string parsed as JSONObject

Throws:

AttributeEncodingException - if parsing fails

transformValues

@Nonnull
@NotLive
@Unmodifiable
private List<?> transformValues(@Nonnull
 TranscodingRule rule,
 @Nonnull
 Stream<String> attributeValues)

Converts string values to List of Integer, String or Boolean depending on rule.

Parameters:

rule - transcoding rule

attributeValues - IdPAttribute values

Returns:

list of String, Boolean or Integer objects