org.teiid.connector.api
Class ConnectorPropertyNames

java.lang.Object
  org.teiid.connector.api.ConnectorPropertyNames

public class ConnectorPropertyNames
extends java.lang.Object

Field Summary

static java.lang.String	ADMIN_CONNECTIONS_ALLOWED
static java.lang.String	CONNECTION_POOL_ENABLED This property can be used to specify whether or not Connection Pooling is enabled.
static java.lang.String	CONNECTOR_BINDING_NAME The environment property used to identify a type of connector binding.
static java.lang.String	CONNECTOR_CLASS The property that specifies the class name of the custom connector class that connects to the data source.
static java.lang.String	CONNECTOR_CLASSPATH
static java.lang.String	CONNECTOR_ID The environment property used to identify a routing ID.
static java.lang.String	CONNECTOR_TYPE_CLASSPATH
static java.lang.String	CONNECTOR_VM_NAME The name of the VM where the connector is running on.
static java.lang.String	EXCEPTION_ON_MAX_ROWS This property can be used to specify whether or not an exception should be thrown if the number of rows for a query exceeds the value of MAX_RESULT_ROWS.
static java.lang.String	IS_IMMUTABLE This property can be used to bypass the normal logic that throws an exception when a command is about to be executed by a non-XA compatible connector, but there is a global transaction.
static java.lang.String	IS_XA
static java.lang.String	MAX_CONNECTIONS The environment property name whose value defines the maximum number of processor threads.
static java.lang.String	MAX_RESULT_ROWS This property can be used to specify the maximum number of rows to be returned from the datasource of this connector.
static java.lang.String	MAX_RESULTSET_CACHE_AGE
static java.lang.String	MAX_RESULTSET_CACHE_SIZE
static java.lang.String	RESULTSET_CACHE_SCOPE
static java.lang.String	SYNCH_WORKERS Indicates whether the connector represents a pooled resource.
static java.lang.String	USE_CREDENTIALS_MAP
static java.lang.String	USE_POST_DELEGATION
static java.lang.String	USE_RESULTSET_CACHE
static java.lang.String	USING_CUSTOM_CLASSLOADER

Constructor Summary

ConnectorPropertyNames()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONNECTOR_CLASS

public static final java.lang.String CONNECTOR_CLASS

The property that specifies the class name of the custom connector class that connects to the data source. This property is required.

See Also:

Constant Field Values

MAX_CONNECTIONS

public static final java.lang.String MAX_CONNECTIONS

The environment property name whose value defines the maximum number of processor threads. This property is required.

See Also:

Constant Field Values

MAX_RESULT_ROWS

public static final java.lang.String MAX_RESULT_ROWS

This property can be used to specify the maximum number of rows to be returned from the datasource of this connector. The connector should stop adding records to the ResultsCollector when the rows collected is equal to this value. This property is optional and if no value is specified, we should return all the rows.

Since:

3.0

See Also:

Constant Field Values

EXCEPTION_ON_MAX_ROWS

public static final java.lang.String EXCEPTION_ON_MAX_ROWS

This property can be used to specify whether or not an exception should be thrown if the number of rows for a query exceeds the value of MAX_RESULT_ROWS. If this flag is set to false, then no more than MAX_RESULT_ROWS values will be returned but no exception will be thrown.

See Also:

Constant Field Values

CONNECTION_POOL_ENABLED

public static final java.lang.String CONNECTION_POOL_ENABLED

This property can be used to specify whether or not Connection Pooling is enabled. If this flag is set to false, then connection pooling is disabled.

See Also:

Constant Field Values

CONNECTOR_BINDING_NAME

public static final java.lang.String CONNECTOR_BINDING_NAME

The environment property used to identify a type of connector binding. This property is required and is a component used to uniquely identify a connector instance.

Since:

4.0

See Also:

Constant Field Values

CONNECTOR_ID

public static final java.lang.String CONNECTOR_ID

The environment property used to identify a routing ID. This value should be used to locate this particular connector from the DQP.

Since:

4.0

See Also:

Constant Field Values

CONNECTOR_VM_NAME

public static final java.lang.String CONNECTOR_VM_NAME

The name of the VM where the connector is running on.

Since:

4.0

See Also:

Constant Field Values

SYNCH_WORKERS

public static final java.lang.String SYNCH_WORKERS

Indicates whether the connector represents a pooled resource. If it does, then synchronous workers will be used.

See Also:

Constant Field Values

USING_CUSTOM_CLASSLOADER

public static final java.lang.String USING_CUSTOM_CLASSLOADER

See Also:

Constant Field Values

CONNECTOR_CLASSPATH

public static final java.lang.String CONNECTOR_CLASSPATH

See Also:

Constant Field Values

CONNECTOR_TYPE_CLASSPATH

public static final java.lang.String CONNECTOR_TYPE_CLASSPATH

See Also:

Constant Field Values

IS_XA

public static final java.lang.String IS_XA

See Also:

Constant Field Values

USE_CREDENTIALS_MAP

public static final java.lang.String USE_CREDENTIALS_MAP

See Also:

Constant Field Values

ADMIN_CONNECTIONS_ALLOWED

public static final java.lang.String ADMIN_CONNECTIONS_ALLOWED

See Also:

Constant Field Values

USE_RESULTSET_CACHE

public static final java.lang.String USE_RESULTSET_CACHE

See Also:

Constant Field Values

MAX_RESULTSET_CACHE_SIZE

public static final java.lang.String MAX_RESULTSET_CACHE_SIZE

See Also:

Constant Field Values

MAX_RESULTSET_CACHE_AGE

public static final java.lang.String MAX_RESULTSET_CACHE_AGE

See Also:

Constant Field Values

RESULTSET_CACHE_SCOPE

public static final java.lang.String RESULTSET_CACHE_SCOPE

See Also:

Constant Field Values

IS_IMMUTABLE

public static final java.lang.String IS_IMMUTABLE

This property can be used to bypass the normal logic that throws an exception when a command is about to be executed by a non-XA compatible connector, but there is a global transaction.

See Also:

Constant Field Values

USE_POST_DELEGATION

public static final java.lang.String USE_POST_DELEGATION

See Also:

Constant Field Values

Constructor Detail

ConnectorPropertyNames

public ConnectorPropertyNames()