The Shibboleth IdP V4 software has reached its End of Life and is no longer supported. This documentation is available for historical purposes only. See the IDP5 wiki space for current documentation on the supported version.
CASAttributeTranscoderConfiguration
- Scott Cantor
Overview
A set of built-in transcoders supporting the CAS <cas:attribute> feature. Most of them support a common set of properties, documented below; a few other properties are defined for specific transcoder types. Since they largely all do the same thing in the same way, they're documented here together.
Common Properties
In addition to the generic properties, all CAS transcoders support the following optional property:
Name | Type | Default | Description |
|---|---|---|---|
cas.name | String | When encoding, the input IdPAttribute's ID and when decoding, the "id" property in the rule | The |
Transcoder Types
There are 2 built-in subtypes of CAS transcoders, as follows. Each one is predefined as a Spring bean for use in rules using the "short" name of the class, as enumerated in the TranscodingRuleConfiguration reference section.
CASStringAttributeTranscoder
The simplest and most commonly used transcoder, it supports encoding and decoding internal values from and to the StringAttributeValue class. It supports no additional properties.
CASScopedStringAttributeTranscoder
This type supports encoding and decoding internal values from and to the ScopedStringAttributeValue class. It supports the following optional property:
Name | Type | Default | Description |
|---|---|---|---|
cas.scopeDelimiter | String | @ | The character(s) to use to separate the value and scope |
CASDateTimeAttributeTranscoder 4.3
This type supports encoding and decoding internal values from and to the DateTimeAttributeValue class. It supports the following optional property:
Name | Type | Default | Description |
|---|---|---|---|
cas.epochUnits | “s” or “ms” | “s” | When decoding, indicates the unit of conversion into an epoch for a numeric string, either seconds or milliseconds. |