com.metamatrix.admin.api.objects
Interface ConnectorBinding

All Superinterfaces:

AdminObject

All Known Implementing Classes:

MMConnectorBinding

public interface ConnectorBinding
extends AdminObject

Represents a connector binding (the instance of a connector type) in the MetaMatrix system.

The unique identifier pattern is [host]<AdminObject.DELIMITER>[process]<AdminObject.DELIMITER>[Connector Binding Name] when running against a MetaMatrix server. The [Connector Binding Name] can itself have spaces in the name. In the case of the MM Query, the [host] and [process] do not apply as MM Query is always local.

Since:

4.3

Field Summary

static java.lang.String	PASSWORD Password connector property name
static int	STATE_CLOSED Registered but closed
static int	STATE_DATA_SOURCE_UNAVAILABLE Running, but the underlying data source is unavailable
static int	STATE_FAILED Failed after running successfully
static int	STATE_INIT_FAILED Failed during initialization
static int	STATE_NOT_DEPLOYED Running, not deployed
static int	STATE_NOT_INITIALIZED Registered by not initialized
static int	STATE_NOT_REGISTERED Not registered
static int	STATE_OPEN Open and running

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Method Summary

java.lang.String	getConnectorTypeName() Get the identifier for this connector binding's ConnectorType.
java.lang.String	getDescription() Returns the description
java.lang.String	getRoutingUUID() Returns the String globally unique routing UUID for this Connector Binding
int	getState() Retrieve the current connector state.
java.lang.String	getStateAsString() Retrieve the current connector state as a printable String.
java.util.Date	getStateChangedTime() Returns time of last state change.

Methods inherited from interface com.metamatrix.admin.api.objects.AdminObject

getIdentifier, getName, getProperties, getPropertyValue

Field Detail

STATE_NOT_INITIALIZED

static final int STATE_NOT_INITIALIZED

Registered by not initialized

See Also:

Constant Field Values

STATE_OPEN

static final int STATE_OPEN

Open and running

See Also:

Constant Field Values

STATE_CLOSED

static final int STATE_CLOSED

Registered but closed

See Also:

Constant Field Values

STATE_FAILED

static final int STATE_FAILED

Failed after running successfully

See Also:

Constant Field Values

STATE_INIT_FAILED

static final int STATE_INIT_FAILED

Failed during initialization

See Also:

Constant Field Values

STATE_NOT_REGISTERED

static final int STATE_NOT_REGISTERED

Not registered

See Also:

Constant Field Values

STATE_DATA_SOURCE_UNAVAILABLE

static final int STATE_DATA_SOURCE_UNAVAILABLE

Running, but the underlying data source is unavailable

See Also:

Constant Field Values

STATE_NOT_DEPLOYED

static final int STATE_NOT_DEPLOYED

Running, not deployed

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

Password connector property name

See Also:

Constant Field Values

Method Detail

getRoutingUUID

java.lang.String getRoutingUUID()

Returns the String globally unique routing UUID for this Connector Binding

Returns:

Returns the routingUUID.

Since:

4.3

getState

int getState()

Retrieve the current connector state. This will be one of the constants: DQP.STATE_OPEN. DQP.STATE_NOT_INITIALIZED. DQP.STATE_CLOSED. DQP.STATE_FAILED. DQP.STATE_INIT_FAILED. DQP.STATE_NOT_REGISTERED. DQP.STATE_DATA_SOURCE_UNAVAILABLE. DQP.STATE_NOT_DEPLOYED.

Returns:

current connector state.

getStateAsString

java.lang.String getStateAsString()

Retrieve the current connector state as a printable String.

Returns:

current connector state in String form.

getStateChangedTime

java.util.Date getStateChangedTime()

Returns time of last state change.

Returns:

time of last state change.

Since:

4.3

getDescription

java.lang.String getDescription()

Returns the description

Returns:

description

getConnectorTypeName

java.lang.String getConnectorTypeName()

Get the identifier for this connector binding's ConnectorType.

Returns:

the Connector Type identifier which can be used to find the ConnectorType.

Since:

4.3