com.ibm.di.server
Class ControlProcesses

java.lang.Object
  com.ibm.di.server.ControlProcesses

public class ControlProcesses
extends java.lang.Object

This class has the ability to start, stop and return AssemblyLines. It can also return information such as AssemblyLine configurations in the form of Hashtables.

Field Summary

static java.lang.String	AL_LAST_EXIT Key for the AssemblyLine's last exit text.
static java.lang.String	AL_LAST_STARTED Key for the AssemblyLine's last started parameter.
static java.lang.String	AL_LAST_STATUS Key for the AssemblyLine's last status.
static java.lang.String	AL_NAME Key for the AssemblyLine name.
static java.lang.String	AL_RUNNING_BOOL Key for specifying whether the AssemblyLine is running.
static java.lang.String	AL_STATUS Key for the AssemblyLine status.
static java.lang.String	AL_VALUE_LAST_STATUS_OK A helper constant that defines a value for AssemblyLine's status property.
static java.lang.String	AL_VALUE_NEVER_EXIT A helper constant that defines a value for AssemblyLine's last exit property.
static java.lang.String	AL_VALUE_NEVER_STARTED A helper constant that defines a value for AssemblyLine's last started property.
static java.lang.String	AL_VALUE_RUNNING_FALSE A helper constant that defines a value for AssemblyLine's running property.
static java.lang.String	AL_VALUE_RUNNING_TRUE A helper constant that defines a value for AssemblyLine's running property.
static java.lang.String	CONN_ENABLED Key for the Connector's enabled parameter.
static java.lang.String	CONN_ENABLED_BOOL Key for the Connector's enabled parameter.
static java.lang.String	CONN_MODE Key for the Connector's name parameter.
static java.lang.String	CONN_NAME Key for the Connector's name parameter.
static java.lang.String	CONN_PARSER Key for the Connector's parser parameter.
static java.lang.String	CONN_TYPE Key for the Connector's mode parameter.
static java.lang.String	CONN_VALUE_ENABLED_FALSE A helper constant that defines a value for Connector's enabled property.
static java.lang.String	CONN_VALUE_ENABLED_TRUE A helper constant that defines a value for Connector's enabled property.
static java.lang.String	CONN_VALUE_NO_PARSER A helper constant that defines a value for Connector's parser property.
static java.lang.String	SVR_HOST_NAME Key for the Server's host name parameter.
static java.lang.String	SVR_IP_ADDRESS Key for the Server's ip address parameter.
static java.lang.String	SVR_OPERATING_SYSTEM Key for the Server's operating system parameter.
static java.lang.String	SVR_SERVER_VERSION Key for the Server's version parameter.
static java.lang.String	SVR_VALUE_UNKNOWN A helper constant that defines a value for Server's property.

Constructor Summary

ControlProcesses()

Method Summary

java.util.Vector	getAssemblyLineConfiguration(java.lang.String aAssemblyLineName) Given an AssemblyLine's name this method retrieves information about its Connectors.
java.util.Vector	getAssemblyLines() Retrieves all AssemblyLines along with their status on the server.
java.util.Hashtable	getServerData() Retrieves general properties about the MI Server.
boolean	startAssemblyLine(java.lang.String aAssemblyLineName) Starts an AssemlbyLine given its name.
void	stopAssemblyLine(java.lang.String aAssemblyLineName) Stops an AssemblyLine given its name.

Methods inherited from class java.lang.Object

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

Field Detail

AL_NAME

public static final java.lang.String AL_NAME

Key for the AssemblyLine name. Used when mapping this property in a Hashtable containing the AssemblyLine information.

See Also:

Constant Field Values

AL_RUNNING_BOOL

public static final java.lang.String AL_RUNNING_BOOL

Key for specifying whether the AssemblyLine is running. Used when mapping this property in a Hashtable containing the AssemblyLine information.

See Also:

Constant Field Values

AL_STATUS

public static final java.lang.String AL_STATUS

Key for the AssemblyLine status. Used when mapping this property in a Hashtable containing the AssemblyLine information.

See Also:

Constant Field Values

AL_LAST_STARTED

public static final java.lang.String AL_LAST_STARTED

Key for the AssemblyLine's last started parameter. Used when mapping this property in a Hashtable containing the AssemblyLine information.

See Also:

Constant Field Values

AL_LAST_STATUS

public static final java.lang.String AL_LAST_STATUS

Key for the AssemblyLine's last status. Used when mapping this property in a Hashtable containing the AssemblyLine information.

See Also:

Constant Field Values

AL_LAST_EXIT

public static final java.lang.String AL_LAST_EXIT

Key for the AssemblyLine's last exit text. Used when mapping this property in a Hashtable containing the AssemblyLine information.

See Also:

Constant Field Values

AL_VALUE_RUNNING_TRUE

public static final java.lang.String AL_VALUE_RUNNING_TRUE

A helper constant that defines a value for AssemblyLine's running property.

See Also:

Constant Field Values

AL_VALUE_RUNNING_FALSE

public static final java.lang.String AL_VALUE_RUNNING_FALSE

A helper constant that defines a value for AssemblyLine's running property.

See Also:

Constant Field Values

AL_VALUE_LAST_STATUS_OK

public static final java.lang.String AL_VALUE_LAST_STATUS_OK

A helper constant that defines a value for AssemblyLine's status property.

See Also:

Constant Field Values

AL_VALUE_NEVER_STARTED

public static final java.lang.String AL_VALUE_NEVER_STARTED

A helper constant that defines a value for AssemblyLine's last started property.

See Also:

Constant Field Values

AL_VALUE_NEVER_EXIT

public static final java.lang.String AL_VALUE_NEVER_EXIT

A helper constant that defines a value for AssemblyLine's last exit property.

See Also:

Constant Field Values

CONN_NAME

public static final java.lang.String CONN_NAME

Key for the Connector's name parameter. Used when mapping this property in a Hashtable containing the Connector information.

See Also:

Constant Field Values

CONN_ENABLED_BOOL

public static final java.lang.String CONN_ENABLED_BOOL

Key for the Connector's enabled parameter. Used when mapping this property in a Hashtable containing the Connector information.

See Also:

Constant Field Values

CONN_ENABLED

public static final java.lang.String CONN_ENABLED

Key for the Connector's enabled parameter. Used when mapping this property in a Hashtable containing the Connector information.

See Also:

Constant Field Values

CONN_MODE

public static final java.lang.String CONN_MODE

Key for the Connector's name parameter. Used when mapping this property in a Hashtable containing the Connector information.

See Also:

Constant Field Values

CONN_TYPE

public static final java.lang.String CONN_TYPE

Key for the Connector's mode parameter. Used when mapping this property in a Hashtable containing the Connector information.

See Also:

Constant Field Values

CONN_PARSER

public static final java.lang.String CONN_PARSER

Key for the Connector's parser parameter. Used when mapping this property in a Hashtable containing the Connector information.

See Also:

Constant Field Values

CONN_VALUE_ENABLED_TRUE

public static final java.lang.String CONN_VALUE_ENABLED_TRUE

A helper constant that defines a value for Connector's enabled property.

See Also:

Constant Field Values

CONN_VALUE_ENABLED_FALSE

public static final java.lang.String CONN_VALUE_ENABLED_FALSE

A helper constant that defines a value for Connector's enabled property.

See Also:

Constant Field Values

CONN_VALUE_NO_PARSER

public static final java.lang.String CONN_VALUE_NO_PARSER

A helper constant that defines a value for Connector's parser property.

See Also:

Constant Field Values

SVR_IP_ADDRESS

public static final java.lang.String SVR_IP_ADDRESS

Key for the Server's ip address parameter. Used when mapping this property in a Hashtable containing the Server information.

See Also:

Constant Field Values

SVR_HOST_NAME

public static final java.lang.String SVR_HOST_NAME

Key for the Server's host name parameter. Used when mapping this property in a Hashtable containing the Server information.

See Also:

Constant Field Values

SVR_OPERATING_SYSTEM

public static final java.lang.String SVR_OPERATING_SYSTEM

Key for the Server's operating system parameter. Used when mapping this property in a Hashtable containing the Server information.

See Also:

Constant Field Values

SVR_SERVER_VERSION

public static final java.lang.String SVR_SERVER_VERSION

Key for the Server's version parameter. Used when mapping this property in a Hashtable containing the Server information.

See Also:

Constant Field Values

SVR_VALUE_UNKNOWN

public static final java.lang.String SVR_VALUE_UNKNOWN

A helper constant that defines a value for Server's property.

See Also:

Constant Field Values

Constructor Detail

ControlProcesses

public ControlProcesses()

Method Detail

getAssemblyLines

public java.util.Vector getAssemblyLines()

Retrieves all AssemblyLines along with their status on the server.

Returns:

Vector which elements are instances of Hashtable. Each element (Hashtable) corresponds to a single AssemlbyLine and contains values for the keys represented by the "AL_" constants.

stopAssemblyLine

public void stopAssemblyLine(java.lang.String aAssemblyLineName)

Stops an AssemblyLine given its name. If multiple AssemblyLines possess this name all of them will be stopped.

Parameters:

aAssemblyLineName - The name of the AssemblyLine to be stopped.

startAssemblyLine

public boolean startAssemblyLine(java.lang.String aAssemblyLineName)

Starts an AssemlbyLine given its name.

Parameters:

aAssemblyLineName - The name of the AssemlbyLine to be started.

Returns:

"true" if the AssemblyLine has been started successfully; "false" - otherwise.

getAssemblyLineConfiguration

public java.util.Vector getAssemblyLineConfiguration(java.lang.String aAssemblyLineName)
                                              throws java.lang.Exception

Given an AssemblyLine's name this method retrieves information about its Connectors.

Parameters:

aAssemblyLineName - The name of the AssemblyLine which configuration will be retrieved.

Returns:

Vector which elements are instances of Hashtable. Each element (Hashtable) corresponds to a single Connector from the AssemblyLine and contains values for the keys represented by the "CONN_" constants.

Throws:

java.lang.Exception - if a problem occurs.

getServerData

public java.util.Hashtable getServerData()

Retrieves general properties about the MI Server.

Returns:

Hashtable which elements contain values for the keys represented by the "SVR_" constants.