Package net.shibboleth.oidc.attribute.transcoding

Class AbstractOIDCAttributeTranscoder

java.lang.Object

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

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

net.shibboleth.oidc.attribute.transcoding.AbstractOIDCAttributeTranscoder

All Implemented Interfaces:

AttributeTranscoder<net.minidev.json.JSONObject>, OIDCAttributeTranscoder, Component, DestructableComponent, InitializableComponent

Direct Known Subclasses:

OIDCByteAttributeTranscoder, OIDCScopedStringAttributeTranscoder, OIDCStringAttributeTranscoder

public abstract class AbstractOIDCAttributeTranscoder
extends AbstractAttributeTranscoder<net.minidev.json.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 org.slf4j.Logger	log	Class logger.

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractOIDCAttributeTranscoder()

Method Summary

Modifier and Type	Method	Description
protected net.minidev.json.JSONObject	buildClaim(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, Object claimValues)	Builds an OIDC claim structure with the given values.
protected IdPAttribute	buildIdPAttribute(ProfileRequestContext profileRequestContext, net.minidev.json.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, net.minidev.json.JSONObject input, TranscodingRule rule)
net.minidev.json.JSONObject	doEncode(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends net.minidev.json.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)
Class<net.minidev.json.JSONObject>	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

AbstractOIDCAttributeTranscoder

public AbstractOIDCAttributeTranscoder()

Method Detail

getEncodedType

public Class<net.minidev.json.JSONObject> getEncodedType()

Specified by:

getEncodedType in interface AttributeTranscoder<net.minidev.json.JSONObject>

getEncodedName

@Nullable
public String getEncodedName(@Nonnull
                             TranscodingRule rule)

Specified by:

getEncodedName in interface AttributeTranscoder<net.minidev.json.JSONObject>

doEncode

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

Specified by:

doEncode in class AbstractAttributeTranscoder<net.minidev.json.JSONObject>

Throws:

AttributeEncodingException

buildClaim

@Nonnull
protected net.minidev.json.JSONObject buildClaim(@Nullable
                                                 ProfileRequestContext profileRequestContext,
                                                 @Nullable
                                                 IdPAttribute attribute,
                                                 @Nonnull
                                                 TranscodingRule rule,
                                                 @Nonnull @NonnullElements
                                                 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

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
                             net.minidev.json.JSONObject input,
                             @Nonnull
                             TranscodingRule rule)
                      throws AttributeDecodingException

Specified by:

doDecode in class AbstractAttributeTranscoder<net.minidev.json.JSONObject>

Throws:

AttributeDecodingException

buildIdPAttribute

@Nonnull
protected IdPAttribute buildIdPAttribute(@Nullable
                                         ProfileRequestContext profileRequestContext,
                                         @Nonnull
                                         net.minidev.json.JSONObject claim,
                                         @Nonnull
                                         TranscodingRule rule,
                                         @Nonnull @NonnullElements
                                         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
@NonnullElements
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