The Shibboleth IdP V3 software has reached its End of Life and is no longer supported. This documentation is available for historical purposes only. See the IDP4 wiki space for current documentation on the supported version.
DataConnectorConfiguration
- Rod Widdowson
- Scott Cantor
- Takeshi Nishimura
- astuart4@ed.ac.uk
Overview
Data connectors produce sets of IdPAttribute objects which are internal to the IdP and are generally used as input to attribute definitions. The product of data connectors are not in general passed along directly to relying parties.
Schema Name and Location
All elements and plugins described in this page and its children are defined in the urn:mace:shibboleth:2.0:resolver schema, which is located at http://shibboleth.net/schema/idp/shibboleth-attribute-resolver.xsd.
Prior to V3.3, the supplied plugins were only defined by a schema type (xsi:type) in the urn:mace:shibboleth:2.0:resolver:dc schema, which is located at http://shibboleth.net/schema/idp/shibboleth-attribute-resolver-dc.xsd. Now they are defined in both namespaces.
Common Attributes
Name | Type | Default | Description |
|---|---|---|---|
| String | Identifier for the Data Connector. This is used for logging, to establish dependencies, and as a target for failover. | |
| Bean Reference | Bean ID of a condition to decide whether to resolve this connector, see here. | |
| space-delimited list | List of entity IDs for which this connector should be resolved. | |
| String | A series of ';' separated resource names which contain Spring definitions for this connector. See below. | |
| Bean Reference | Bean ID of a List<Resource> which contain Spring definitions for this connector. See below. | |
| Bean Reference | (Advanced) Bean ID of a List<BeanFactoryPostProcessor> for use when parsing the resources specified by springResources or springResourcesRef | |
| Bean Reference | (Advanced) Bean ID of a List<BeanBeanPostProcessorPostProcessor> for use when parsing the resources specified by springResources or springResourcesRef | |
| Bean Reference | Bean ID of a function injected to override the normal lookup process for the request's ProfileRequestContext | |
| Duration | 0 | Time between retries of a failed data connector (during the interval, failure is just assumed when the connector is run and no actual connection is attempted) |
propagateResolutionExceptions 3.4 | Boolean | true | Whether connector/plugin failure is fatal to the entire attribute resolution process |
Common Child Elements
All Data Connectors can have zero or more of each the following two child elements.
Prior to V3.3 the child elements had to be specified in a strict order, with the Common Child Elements coming first. This has been relaxed in V3.3.
| Name | Cardinality | Description |
|---|---|---|
| 0 or more | Deprecated in 3.4 |
| 0 or more | This element identifies an attribute definition which is an input to this data connector |
| 0 or more | This element identifies a data connector whose attributes are to be input to this data conector |
| 0 or more | This element has a single attribute ref="whatever" whose content is the identifier of a data connector to resolve if this data connector fails (for instance due to the external data source being unavailable) |
DataConnector Plugin Types
Data Connectors are distinguished by their schema type, which is inside the xsi:type XML attribute. The following types are supported:
| xsi:type | Function |
|---|---|
| A data connector that gets its information from a static list of attributes and values specified within the configuration |
| Creates multiple attributes from a script supported by JSR-223 |
| Creates an attribute whose value is computed from the SHA-1 hash of the requesting entity's ID, an attribute value (usually a user identifier of some kind), and a salt |
| Creates an attribute whose value is generated either via the ComputedId mechanism (above) or by storing it and looking it up in a database |
| A data connector that uses JDBC to connect to and pull information from a relational database |
| A data connector that uses LDAP to connect to and pull information from a directory |
| A data connector that uses HTTP to connect to and pull information from a web service |
Native Spring Configuration
Certain Data Connectors can be configured using native Spring syntax, which allows for various optimizations, shared connection configuration, and/or use of advanced options not supported otherwise. Two mechanisms for this exist:
- By direct reference to externally defined beans, for instance
<BeanManagedConnection> - By specifying, via the
springResourcesorspringResourcesRefattributes, resources which contain appropriate configuration for the connector
More precise details are described for each data connector.