# Uses of Class
net.shibboleth.idp.attribute.transcoding.TranscodingRule

Packages that use TranscodingRule
Package
Description
net.shibboleth.idp.attribute.resolver.spring.enc
Parsers for the urn:mace:shibboleth:2.0:attribute:encoder namespace.
net.shibboleth.idp.attribute.transcoding
APIs for transcoding of attributes.
net.shibboleth.idp.attribute.transcoding.impl
Implementation classes for attribute transcoding.
net.shibboleth.idp.saml.attribute.impl
Miscellaneous implementation classes related to SAML Attributes.
net.shibboleth.idp.saml.attribute.transcoding
Base classes for SAML `AttributeTranscoder` classes.
net.shibboleth.idp.saml.attribute.transcoding.impl
Implementations of SAML transcoders.
net.shibboleth.idp.saml.saml2.nameid.transcoding
API classes for SAML 2.0 NameID decoding classes.
net.shibboleth.idp.saml.saml2.nameid.transcoding.impl
SAML 2.0 NameID transcoder implementations.

## Uses of TranscodingRule in net.shibboleth.idp.attribute.resolver.spring.enc

Methods in net.shibboleth.idp.attribute.resolver.spring.enc that return types with arguments of type TranscodingRule
Modifier and Type
Method
Description
`protected Class<TranscodingRule>`
BaseAttributeEncoderParser.`getBeanClass(Element element)`

## Uses of TranscodingRule in net.shibboleth.idp.attribute.transcoding

Methods in net.shibboleth.idp.attribute.transcoding that return TranscodingRule
Modifier and Type
Method
Description
`static TranscodingRule`
TranscodingRule.`fromResource(Resource resource)`
Build a new rule from a property set resource.
Methods in net.shibboleth.idp.attribute.transcoding that return types with arguments of type TranscodingRule
Modifier and Type
Method
Description
`Collection<TranscodingRule>`
AttributeTranscoderRegistry.`getTranscodingRules(IdPAttribute from, Class<?> to)`
Obtains a set of instructions for encoding an input `IdPAttribute` into a target type.
`<T> Collection<TranscodingRule>`
AttributeTranscoderRegistry.`getTranscodingRules(T from)`
Obtains a set of instructions for decoding an input object into an `IdPAttribute`.
Methods in net.shibboleth.idp.attribute.transcoding with parameters of type TranscodingRule
Modifier and Type
Method
Description
`private boolean`
AbstractAttributeTranscoder.`checkActivation(ProfileRequestContext profileRequestContext, TranscodingRule rule)`
Apply any activation rules to the request.
`IdPAttribute`
AbstractAttributeTranscoder.`decode(ProfileRequestContext profileRequestContext, T input, TranscodingRule rule)`
Decode the supplied object into a protocol-neutral representation.
`IdPAttribute`
AttributeTranscoder.`decode(ProfileRequestContext profileRequestContext, T input, TranscodingRule rule)`
Decode the supplied object into a protocol-neutral representation.
`protected abstract IdPAttribute`
AbstractAttributeTranscoder.`doDecode(ProfileRequestContext profileRequestContext, T input, TranscodingRule rule)`
Decode the supplied object into a protocol-neutral representation.
`protected abstract T`
AbstractAttributeTranscoder.`doEncode(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends T> to, TranscodingRule rule)`
Encode the supplied attribute into a protocol specific representation.
`T`
AbstractAttributeTranscoder.`encode(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends T> to, TranscodingRule rule)`
Encode the supplied attribute into a protocol specific representation.
`T`
AttributeTranscoder.`encode(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends T> to, TranscodingRule rule)`
Encode the supplied attribute into a protocol specific representation.
`String`
AttributeTranscoder.`getEncodedName(TranscodingRule rule)`
Get the name of the encoded object that would be created by a given set of instructions.
`static <T> AttributeTranscoder<T>`
TranscoderSupport.`getTranscoder(TranscodingRule rule)`
Pull an `AttributeTranscoder` object out of the rule provided.

## Uses of TranscodingRule in net.shibboleth.idp.attribute.transcoding.impl

Fields in net.shibboleth.idp.attribute.transcoding.impl with type parameters of type TranscodingRule
Modifier and Type
Field
Description
`private final Collection<TranscodingRule>`
TranscodingRuleLoader.`rules`
Rules loaded.
`private final Map<String,Multimap<Class<?>,TranscodingRule>>`
AttributeTranscoderRegistryImpl.`transcodingRegistry`
Registry of transcoding instructions for a given "name" and type of object.
Methods in net.shibboleth.idp.attribute.transcoding.impl that return types with arguments of type TranscodingRule
Modifier and Type
Method
Description
`Collection<TranscodingRule>`
TranscodingRuleLoader.`getRules()`
Get the rules loaded by this object.
`Collection<TranscodingRule>`
AttributeTranscoderRegistryImpl.`getTranscodingRules(IdPAttribute from, Class<?> to)`
Obtains a set of instructions for encoding an input `IdPAttribute` into a target type.
`<T> Collection<TranscodingRule>`
AttributeTranscoderRegistryImpl.`getTranscodingRules(T from)`
Obtains a set of instructions for decoding an input object into an `IdPAttribute`.
Methods in net.shibboleth.idp.attribute.transcoding.impl with parameters of type TranscodingRule
Modifier and Type
Method
Description
`private Collection<AttributeTranscoder<?>>`
AttributeTranscoderRegistryImpl.`getAttributeTranscoders(TranscodingRule rule)`
Get the appropriate `AttributeTranscoder` objects to use.
Method parameters in net.shibboleth.idp.attribute.transcoding.impl with type arguments of type TranscodingRule
Modifier and Type
Method
Description
`void`
AttributeTranscoderRegistryImpl.`setTranscoderRegistry(Collection<TranscodingRule> mappings)`
Installs the transcoder mappings en masse.

## Uses of TranscodingRule in net.shibboleth.idp.saml.attribute.impl

Method parameters in net.shibboleth.idp.saml.attribute.impl with type arguments of type TranscodingRule
Modifier and Type
Method
Description
`private <T> void`
AttributeMappingNodeProcessor.`decodeAttribute(Collection<TranscodingRule> rules, T input, Multimap<String,IdPAttribute> results)`
Access the registry of transcoding rules to decode the input object.

## Uses of TranscodingRule in net.shibboleth.idp.saml.attribute.transcoding

Methods in net.shibboleth.idp.saml.attribute.transcoding with parameters of type TranscodingRule
Modifier and Type
Method
Description
`protected AttributeDesignator`
AbstractSAML1AttributeTranscoder.`buildAttribute(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends AttributeDesignator> to, TranscodingRule rule, List<XMLObject> attributeValues)`
Builds a SAML attribute element from the given attribute values.
`protected Attribute`
AbstractSAML2AttributeTranscoder.`buildAttribute(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends Attribute> to, TranscodingRule rule, List<XMLObject> attributeValues)`
Builds a SAML attribute element from the given attribute values.
`protected abstract AttributeType`
AbstractSAMLAttributeTranscoder.`buildAttribute(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends AttributeType> to, TranscodingRule rule, List<XMLObject> attributeValues)`
Builds a SAML attribute element from the given attribute values.
`protected IdPAttribute`
AbstractSAML1AttributeTranscoder.`buildIdPAttribute(ProfileRequestContext profileRequestContext, AttributeDesignator attribute, TranscodingRule rule, List<IdPAttributeValue> attributeValues)`
Builds an `IdPAttribute` from the given values.
`protected IdPAttribute`
AbstractSAML2AttributeTranscoder.`buildIdPAttribute(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, List<IdPAttributeValue> attributeValues)`
Builds an `IdPAttribute` from the given values.
`protected abstract IdPAttribute`
AbstractSAMLAttributeTranscoder.`buildIdPAttribute(ProfileRequestContext profileRequestContext, AttributeType attribute, TranscodingRule rule, List<IdPAttributeValue> attributeValues)`
Builds an `IdPAttribute` from the given values.
`protected abstract IdPAttributeValue`
AbstractSAMLAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, AttributeType attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`IdPAttribute`
AbstractSAMLAttributeTranscoder.`doDecode(ProfileRequestContext profileRequestContext, AttributeType input, TranscodingRule rule)`
Decode the supplied object into a protocol-neutral representation.
`AttributeType`
AbstractSAMLAttributeTranscoder.`doEncode(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends AttributeType> to, TranscodingRule rule)`
Encode the supplied attribute into a protocol specific representation.
`protected void`
AbstractSAML1AttributeTranscoder.`encodeName(ProfileRequestContext profileRequestContext, IdPAttribute attribute, AttributeDesignator samlAttribute, TranscodingRule rule)`
`protected void`
AbstractSAML2AttributeTranscoder.`encodeName(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Attribute samlAttribute, TranscodingRule rule)`
`protected abstract XMLObject`
AbstractSAMLAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, EncodedType value)`
Encodes an attribute value into a SAML AttributeValue element.
`String`
AbstractSAML1AttributeTranscoder.`getEncodedName(TranscodingRule rule)`
Get the name of the encoded object that would be created by a given set of instructions.
`String`
AbstractSAML2AttributeTranscoder.`getEncodedName(TranscodingRule rule)`
Get the name of the encoded object that would be created by a given set of instructions.

## Uses of TranscodingRule in net.shibboleth.idp.saml.attribute.transcoding.impl

Methods in net.shibboleth.idp.saml.attribute.transcoding.impl with parameters of type TranscodingRule
Modifier and Type
Method
Description
`protected IdPAttributeValue`
SAML1ByteAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, AttributeDesignator attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML1ScopedStringAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, AttributeDesignator attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML1StringAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, AttributeDesignator attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML1XMLObjectAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, AttributeDesignator attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML2ByteAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML2DateTimeAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML2ScopedStringAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML2StringAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML2XMLObjectAttributeTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, Attribute attribute, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected XMLObject`
SAML1ByteAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, ByteAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML1ScopedStringAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, ScopedStringAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML1StringAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, StringAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML1XMLObjectAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, XMLObjectAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML2ByteAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, ByteAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML2DateTimeAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, DateTimeAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML2ScopedStringAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, ScopedStringAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML2StringAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, StringAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML2XMLObjectAttributeTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, XMLObjectAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected Instant`
SAML2DateTimeAttributeTranscoder.`getDateTimeValue(TranscodingRule rule, Long value)`
Convert a long value into an `Instant`.
`protected Instant`
SAML2DateTimeAttributeTranscoder.`getDateTimeValue(TranscodingRule rule, String value)`
Convert a string value into an `Instant`.
`protected Instant`
SAML2DateTimeAttributeTranscoder.`getDateTimeValue(TranscodingRule rule, XMLObject object)`
Function to return an XML object in date/time form.

## Uses of TranscodingRule in net.shibboleth.idp.saml.saml2.nameid.transcoding

Methods in net.shibboleth.idp.saml.saml2.nameid.transcoding with parameters of type TranscodingRule
Modifier and Type
Method
Description
`protected NameID`
AbstractSAML2NameIDTranscoder.`buildAttribute(ProfileRequestContext profileRequestContext, IdPAttribute attribute, Class<? extends NameID> to, TranscodingRule rule, List<XMLObject> attributeValues)`
Builds a SAML attribute element from the given attribute values.
`protected IdPAttribute`
AbstractSAML2NameIDTranscoder.`buildIdPAttribute(ProfileRequestContext profileRequestContext, NameID nameID, TranscodingRule rule, List<IdPAttributeValue> attributeValues)`
Builds an `IdPAttribute` from the given values.
`String`
AbstractSAML2NameIDTranscoder.`getEncodedName(TranscodingRule rule)`
Get the name of the encoded object that would be created by a given set of instructions.

## Uses of TranscodingRule in net.shibboleth.idp.saml.saml2.nameid.transcoding.impl

Methods in net.shibboleth.idp.saml.saml2.nameid.transcoding.impl with parameters of type TranscodingRule
Modifier and Type
Method
Description
`protected IdPAttributeValue`
SAML2ScopedStringNameIDTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, NameID nameID, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected IdPAttributeValue`
SAML2StringNameIDTranscoder.`decodeValue(ProfileRequestContext profileRequestContext, NameID nameID, TranscodingRule rule, XMLObject value)`
Function to decode a single `XMLObject` into an `IdPAttributeValue`.
`protected XMLObject`
SAML2ScopedStringNameIDTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, ScopedStringAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.
`protected XMLObject`
SAML2StringNameIDTranscoder.`encodeValue(ProfileRequestContext profileRequestContext, IdPAttribute attribute, TranscodingRule rule, StringAttributeValue value)`
Encodes an attribute value into a SAML AttributeValue element.