JBoss.orgCommunity Documentation

Chapter 8. Connectors

8.1. Common Connector Properties
8.2. Source Security
8.2.1. Specific Source Credentials
8.2.2. Using Session Credentials
8.2.3. Session and Specific Source Credentials
8.2.4. Configuring Connectors For Source Security

8.1. Common Connector Properties

These properties are common to all connectors.

Property

Description

Type

Default

ConnectorBindingName

The name of the connector binding. Must be unique across all connector bindings. This property is not editable, and is not seen in the Designer in the connector properties table.

string

ConnectorClass

The class name of the custom connector class that connects to the data source. Required. Not editable.

string

ConnectorClassPath

The class path of the custom connector class that connects to the data source. Required.

string

ConnectorMaxThreads

The maximum number of connector worker threads. Required.

integer

ConnectorThreadTTL

The maximum length of time a connector thread may live in idle state. Required.

integer - milliseconds

ExceptionOnMaxRows

Specifies whether or not an exception is thrown when the number of rows for a query exceeds the value of MaxResultRows. If this flag is set to false, then no more rows than MaxResultRows will be returned, but no exception will be thrown.

boolean

MaxResultRows

The maximum number of rows to be processed by the connector from a source. A custom connector should stop adding rows to the ResultsCollector when the number of rows reaches this value. Optional – if not specified, all rows will be processed.

integer

8.2. Source Security

Teiid can use the security mechanisms of individual data sources during execution.

The use of source security is driven off the credentials JDBC property.

There are 3 basic use cases:

  1. Specify the credentials for all sources

  2. Pass the session logon credentials to all sources

  3. Some combination of the previous two

This use case is for when you want to specify the logon credentials for all the source systems in the JDBC URL. The form of the credentials property is:

credentials=(system=<sys1>,user=<uname>, password=<pwd>/system=<sys2>,...)

Note

Any property can be specified for a system, using the name=value syntax, as long as the connector associated with the source understands the property or can pass it to the source.

The following properties are "well-known" and required:

Example 8.1. Example URL With Two Source Credentials

jdbc:metamatrix:MyVDB@mm://HostA:5001;credentials=(system=s1,user=u1,password=p1/system=s2,user=u2,password=p2)


This use case uses the session credentials for all source systems.

Example 8.2. Example URL With Session Credentials

jdbc:metamatrix:MyVDB@mm://HostA:5001;credentials=defaultToLogon


The above techniques can be used in combination with one another as needed.

Example 8.3. Combination of Source Credential Approaches

jdbc:metamatrix:MyVDB@mm://HostA:5001; credentials=defaultToLogon,(system=s1,user=u1,password=p1)


When source security is used, the connector bindings for the sources must be configured appropriately.