com.metamatrix.jdbc.api
Interface ConnectionProperties

public interface ConnectionProperties

MetaMatrix-specific connection properties. These connection properties can be set via the java.sql.DriverManager.getConnection(jdbcUrl, connectionProps) method. WARNING: This class does not contain all possible properties.

Field Summary

static java.lang.String	DEFAULT_TO_LOGON
static java.lang.String	PROP_CLIENT_SESSION_PAYLOAD Connection property name for trusted session payload.
static java.lang.String	PROP_CREDENTIALS Data source credential sets.

Field Detail

PROP_CLIENT_SESSION_PAYLOAD

static final java.lang.String PROP_CLIENT_SESSION_PAYLOAD

Connection property name for trusted session payload. The optional client token that will be passed directly through to connectors, which may use it and/or pass it down to their underlying data source.

The form and type of the client payload object is up to the client but it must implement the Serializable interface. MetaMatrix does nothing with this object except to make it available for authentication/augmentation/replacement upon authentication to the system and to connectors that may require it at the data source level.

See Also:

Constant Field Values

PROP_CREDENTIALS

static final java.lang.String PROP_CREDENTIALS

Data source credential sets. The credentials will be decoded and passed in a CredentialMap object as the session payload. It is an error to use this property in conjunction with PROP_CLIENT_SESSION_PAYLOAD as the CredentialMap is used as the payload. If a per-user connection factory is used with the ConnectionPool in the Connector API, the CredentialMap can be used to obtain per-system credentials and use per-user connection pooling. In particular, the MetaMatrix JDBC Connectors have pre-built connection factories that can be used with credentials for this purpose.

Credentials take the following basic form: credentials=(system=sys1,user=u1,password=p1/ system=sys2,user=u2,password=p2). Each set of system credentials must contain a system property. The properties "user" and "password" are also well-known property names used by the connection factory although any property name is allowed and may be used by a connector to extract credentials.

Additionally, the credentials property allows an additional attribute before the credentials list: defaultToLogon as follows: credentials=defaultToLogoncredentials=defaultToLogon,(system=sys1,user=u1,password=p2). When this attribute is used, the user's logon credentials are used as defaults when a connector asks for credentials from the CredentialMap.

See Also:

Constant Field Values

DEFAULT_TO_LOGON

static final java.lang.String DEFAULT_TO_LOGON

See Also:

Constant Field Values