Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Namespace: urn:mace:shibboleth:2.0:resolver
Schema: http://shibboleth.net/schema/idp/shibboleth-attribute-resolver.xsd

...

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.

Reference

true

Localtabgroup

Localtab

active
-live
titleSpecific XML Attributes


NameTypeDefaultDescription

noResultIsError

booleanfalseControls whether an empty result set is an error

failFastInitialize

booleanfalseWhether a failure when verifying the database's availability during startup is fatal (stops the Attribute Resolver service from starting)

queryTimeout

Duration

Timeout for the queries made against the database

multipleResultsIsError       

booleanfalseControls whether a result set with more than one row is an error

mappingStrategyRef

Bean ID
Bean ID of a MappingStrategy<java.sql.ResultSet> to process the result set in a pluggable way
validatorRefBean ID
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)
executableSearchBuilderRefBean ID
Bean ID of an ExecutableSearchBuilder<ExecutableStatement> to produce the SQL query to execute

templateEngine

Bean ID
Bean ID of a org.apache.velocity.app.VelocityEngine to use for processing the SQL template

Localtab-live
titleSpecific XML Elements


NameCardinalityDescription

<ContainerManagedConnection>

Exactly 1

Not permitted if the
springResource
attribute is used

Connects to a database via a JNDI DataSource defined in the container

<SimpleManagedConnection>

Connects to a database via a JDBC DataSource defined explicitly with a simplified syntax.

<BeanManagedConnection>

Connects to a database via an externally specified DataSource

<QueryTemplate>

0 or 1The template of the SQL query to send to the database

<Column>

0 or moreA series of remapping definitions which map a column name to an IdPAttribute ID

<ResultCache>


0 or 1

Defines how results should be cached

<ResultCacheBean>

Bean ID (in the element content) defining how results should be cached as an externally defined com.google.common.cache.Cache<String,Map<String,IdPAttribute>> 

Localtab-live
titleCommon XML Attributes

Include Page
DataConnectorCommonAttributes
DataConnectorCommonAttributes

Localtab-live
titleCommon XML Elements

Include Page
DataConnectorCommonChildElements
DataConnectorCommonChildElements

Spring Configuration

If the springResource or 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:

In addition, native bean IDs can be injected as follows:

  1. The DataSource can be specified as an externally defined bean via the <BeanManagedConnection> element (as a recommended replacement for the the <ContainerManagedConnection> element).
  2. The builder for the SQL query can be specified as an externally defined bean via the executableSearchBuilderRef attribute (as a replacement for the <QueryTemplate> element).
  3. The mapping of column names can be specified as an externally defined bean via the mappingStrategyRef attribute (as a replacement for the <Column> elements).
  4. The caching of results can be specified as an externally defined bean via the <ResultCacheBean> element (as a replacement for the <ResultCache> element).
  5. Rarely, a non-default Velocity engine can be injected via the templateEngine attribute.

...