Package net.shibboleth.oidc.attribute.transcoding

Class AbstractOIDCAttributeTranscoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

net.shibboleth.oidc.attribute.transcoding.AbstractOIDCAttributeTranscoder

All Implemented Interfaces:

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

Direct Known Subclasses:

OIDCByteAttributeTranscoder, OIDCScopedStringAttributeTranscoder, OIDCStringAttributeTranscoder

public abstract class AbstractOIDCAttributeTranscoder
extends AbstractAttributeTranscoder<JSONObject>
implements OIDCAttributeTranscoder

Abstract class for OIDC attribute encoders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOIDCAttributeTranscoder.NamingFunction	A function to produce a "canonical" name for an OIDC claim for transcoding rules.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,Set<String>>	nameFromMetadataLookupStrategy	Strategy to lookup naming overrides in metadata.

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
AbstractOIDCAttributeTranscoder()

Method Summary

Modifier and Type	Method	Description
protected JSONObject	buildClaim(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, Object claimValues)	Builds an OIDC claim structure with the given values.
protected IdPAttribute	buildIdPAttribute(ProfileRequestContext profileRequestContext, JSONObject claim, TranscodingRule rule, List<IdPAttributeValue> attributeValues)	Builds an IdPAttribute from the given values.
protected abstract List<IdPAttributeValue>	decodeValues(ProfileRequestContext profileRequestContext, Object input, TranscodingRule rule)	Subclasses should override this method to perform specific claim value decoding into IdPAttributeValue objects.
IdPAttribute	doDecode(ProfileRequestContext profileRequestContext, JSONObject input, TranscodingRule rule)
JSONObject	doEncode(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends JSONObject> to, TranscodingRule rule)
protected abstract Object	encodeValues(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule)	Performs encoding of IdPAttribute's values based on rule into a claim value.
String	getEncodedName(TranscodingRule rule)
protected String	getEncodedName(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule)	Get the encoded name for the attribute via SAML metadata (if enabled) or rule's name property.
Class<JSONObject>	getEncodedType()
protected String	getNameFromMetadata(ProfileRequestContext profileRequestContext, String attributeId)	If enabled, search metadata for a tag value prefixed by the input attribute ID followed by a space character.
void	setNameFromMetadataLookupStrategy(Function<ProfileRequestContext,Set<String>> strategy)	Sets lookup strategy for obtaining tag-based naming overrides from metadata.

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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

nameFromMetadataLookupStrategy

@Nullable
private Function<ProfileRequestContext,Set<String>> nameFromMetadataLookupStrategy

Strategy to lookup naming overrides in metadata.

Constructor Details

AbstractOIDCAttributeTranscoder

public AbstractOIDCAttributeTranscoder()

Method Details

getEncodedType

@Nonnull
public Class<JSONObject> getEncodedType()

Specified by:

getEncodedType in interface AttributeTranscoder<JSONObject>

setNameFromMetadataLookupStrategy

public void setNameFromMetadataLookupStrategy(@Nullable
 Function<ProfileRequestContext,Set<String>> strategy)

Sets lookup strategy for obtaining tag-based naming overrides from metadata.

Parameters:

strategy - lookup strategy

Since:

3.1.0

getEncodedName

@Nullable
public String getEncodedName(@Nonnull
 TranscodingRule rule)

Specified by:

getEncodedName in interface AttributeTranscoder<JSONObject>

doEncode

@Nullable
public JSONObject doEncode(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 IdPAttribute attribute,
 @Nonnull
 Class<? extends JSONObject> to,
 @Nonnull
 TranscodingRule rule)
                    throws AttributeEncodingException

Specified by:

doEncode in class AbstractAttributeTranscoder<JSONObject>

Throws:

AttributeEncodingException

buildClaim

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

Builds an OIDC claim structure with the given values.

Parameters:

profileRequestContext - current profile request context

attribute - the attribute being encoded

rule - properties to control encoding

claimValues - the encoded value(s) for the claim

Returns:

the OIDC claim (for the moment in the form of a single-valued JSON structure

Throws:

AttributeEncodingException - if there's a problem constructing the claim

getEncodedName

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

Get the encoded name for the attribute via SAML metadata (if enabled) or rule's name property.

Parameters:

profileRequestContext - current profile request context

attribute - the attribute being encoded

rule - properties to control encoding

Returns:

the name of the OIDC claim

Throws:

AttributeEncodingException - if there's a problem constructing the name

encodeValues

@Nullable
protected abstract 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.

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

doDecode

@Nullable
public IdPAttribute doDecode(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 JSONObject input,
 @Nonnull
 TranscodingRule rule)
                      throws AttributeDecodingException

Specified by:

doDecode in class AbstractAttributeTranscoder<JSONObject>

Throws:

AttributeDecodingException

buildIdPAttribute

@Nonnull
protected IdPAttribute buildIdPAttribute(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 JSONObject claim,
 @Nonnull
 TranscodingRule rule,
 @Nonnull
 List<IdPAttributeValue> attributeValues)
                                  throws AttributeDecodingException

Builds an IdPAttribute from the given values.

Parameters:

profileRequestContext - current profile request

claim - the claim being decoded

rule - properties to control decoding

attributeValues - the decoded values for the attribute

Returns:

the IdPAttribute object

Throws:

AttributeDecodingException - if there's a problem constructing the IdPAttribute

decodeValues

@Nonnull
protected abstract 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.

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

getNameFromMetadata

@Nullable
protected String getNameFromMetadata(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nonnull
 String attributeId)

If enabled, search metadata for a tag value prefixed by the input attribute ID followed by a space character.

The remaining portion of the value will be interpreted in a protocol-specific way.

Parameters:

profileRequestContext - profile request context

attributeId - attribute ID

Returns:

the first matching tag value from the installed lookup function

Since:

3.1.0