RelationalDatabase DataConnector generates multiple IdPAttribute objects from a relational database via a JDBC DataSource. The results are generated such that each IdPAttribute represents a column of the query result set. The ordered values represent the rows of the result set and each IdPAttribute will contain the same number of values, including any embedded nulls in the results. Nulls are represented explicitly with objects of type EmptyAttributeValue as placeholders within the ordered lists.
Data Sources and Drivers
This connector uses a JDBC DataSource to connect to the database. This can be supplied via a few different techniques, but the recommended approach is to define one using Spring syntax in global.xml (or similar location) and use the
<BeanManagedConnection> element, the reason being it can be easily shared across multiple connectors. If you need the ability to reload the data source's settings, then the suggested approach is to create a new Spring file to contain the bean, and add it to the set of AttributeResolverConfiguration resources in services.xml
No matter where or how you define the data source, it is your responsibility to obtain and install the JDBC driver you want to use. The IdP does not come with any drivers, to avoid them becoming stale.
Whatever driver you use should generally be installed to edit-webapp/WEB-INF/lib, after which you will need to stop your container, rebuild the warfile, and restart the container. Failure to do so will lead to ClassNotFound exceptions that reference the driver class.
If you want to use connection pooling, the Apache DBCP library is included with the IdP. The DBCP library provides various DataSource implementations that wrap an actual database driver, and you will have to add the driver itself as well. A rudimentary example is included below, but be aware that there are a lot of options available and no particular "best practice" is implied by our limited experience with them.
Read Only Connections
Previous versions of the IdP marked the connections used for attribute resolution as read-only. A configuration attribute was provided to override this behavior and allow connection pools to be shared between the RDBMS Data Connector and other read-write uses. In V4, the DataConnector no longer marks the connections as read-only itself. If you want to enforce read-only behavior, you should do so via the JDBC connection URL and/or limiting the access of the service account.
Controls whether an empty result set is an error
Whether a failure when verifying the database's availability during startup is fatal (stops the Attribute Resolver service from starting)
Timeout for the queries made against the database
Controls whether a result set with more than one row is an error
Bean ID of a Validator to control what constitutes an initialization failure (set this to "shibboleth.NonFailFastValidator" to bypass connection attempt at config load time)
Bean ID of a org.apache.velocity.app.VelocityEngine to use for processing the SQL template
Not permitted if the
Connects to a database via a JNDI DataSource defined in the container
Connects to a database via a JDBC DataSource defined explicitly with a simplified syntax.
Connects to a database via an externally specified DataSource
0 or 1
The template of the SQL query to send to the database
0 or more
A series of remapping definitions which map a column name to an IdPAttribute ID
0 or 1
Defines how results should be cached
Identifier for the DataConnector. This is used for logging, to establish dependencies, and as a target for failover.
Bean ID of a condition to decide whether to resolve this connector, see here.
List of entity IDs for which this connector should be resolved.
List of entity IDs for which this connector should not be resolved.
List of resolution phases (i.e. flows) during which this connector should be resolved.
List of resolution phases (i.e. flows) during which this connector should not be resolved.
List of attributes produced by the DataConnector that should be directly exported as resolved IdPAttributes without requiring actual AttributeDefinitions.
In the case of a name clash (a DataConnector exports an attribute with the same name as an AttributeDefinition, or another DataConnector exports the same attribute) the DataConnector attribute is NOT added and a warning issued.
Time between retries of a failed DataConnector (during the interval, failure is just assumed when the connector is run and no actual connection is attempted)
Whether connector/plugin failure is fatal to the entire attribute resolution process
The following table contains advanced settings rarely used in common practice.
A series of ';' separated resource names which contain Spring definitions for this connector.
Not valid for ComputedId and Stored DataConnector and DEPRECATED for use with Scripted DataConnector
Bean ID of a List<Resource> which contain Spring definitions for this connector. See below.
Bean ID of a List<BeanFactoryPostProcessor> for use when parsing the resources specified by
Bean ID of a List<BeanPostProcessor> for use when parsing the resources specified by
Bean ID of a function injected to override the normal lookup process for the request's ProfileRequestContext
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 1
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)
springResourceRef attributes are specified, then the configuration of the DataConnector bean is delegated to the supplied resources. The system will create a factory for an RDBMSDataConnector object, and look for beans in the Spring resource(s) supplied that match the types of properties supported by that type and its parent classes.
In prior versons, most of these extension points were non-API classes and interfaces, but in V4+ they have been moved and promoted to API status.
In practice, the RDBMS Data Connector may be supplied with beans of the following types:
The only class available in the IdP which implements this Interface is NonFailFastValidator
The only class available in the IdP which implements this Interface is StringResultMappingStrategy
In addition, native bean IDs can be injected as follows:
The DataSource can be specified as an externally defined bean via the
<BeanManagedConnection>element (as a recommended replacement for the the
The builder for the SQL query can be specified as an externally defined bean via the
executableSearchBuilderRefattribute (as a replacement for the
The mapping of column names can be specified as an externally defined bean via the
mappingStrategyRefattribute (as a replacement for the
The caching of results can be specified as an externally defined bean via the
<ResultCacheBean>element (as a replacement for the
Rarely, a non-default Velocity engine can be injected via the
Simple DataConnector entirely in custom syntax
Simple Data Connector using external bean
The example below demonstrates a number of approaches:
Use of a Spring file to define the various low-level objects, which could be referenced via
<DataConnector" xsi:type="RelationalDatabase" springResources="....." />
Use of a Spring file to define a data source which could be referenced via
Use of the DBCP pooling library to wrap a database driver in a simple pool.