com.metamatrix.admin.api.objects
Interface Service

All Superinterfaces:

AdminObject

All Known Implementing Classes:

MMService

public interface Service
extends AdminObject

Represents a service in the MetaMatrix system.

The unique identifier pattern is [host]<AdminObject.DELIMITER>[process]<AdminObject.DELIMITER>[Service Name] when running against a MetaMatrix server. The [Service Name] can itself have spaces in the name. In the case of the MM Query, a Service does not apply as MM Query is not running within a MM Server VM.

Since:

4.3

Field Summary

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	getComponentTypeName() Get the component type identifier for this service ComponentType.
java.lang.String	getDescription() Returns the description
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

Method Detail

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

getComponentTypeName

java.lang.String getComponentTypeName()

Get the component type identifier for this service ComponentType.

Returns:

the Component Type identifier which can be used to find the ComponentType.

Since:

6.1