com.apama.engine
Class EngineManagementFactory

java.lang.Object
  com.apama.engine.EngineManagementFactory

All Implemented Interfaces:

ConnectionConstants

public class EngineManagementFactory
extends java.lang.Object
implements ConnectionConstants

This class is used to create objects that implement the EngineManagement interface.

Field Summary

Fields inherited from interface com.apama.net.ConnectionConstants

DEFAULT_ADAPTER_PORT, DEFAULT_ENGINE_PORT, DEFAULT_HOST, DEFAULT_PORT, DEFAULT_PROCESS_NAME, DEFAULT_SENTINEL_PORT

Method Summary

static EngineManagement	connectToEngine(java.lang.String host, int port) This static method attempts to establish a connection to an Engine.
static EngineManagement	connectToEngine(java.lang.String host, int port, java.lang.String processName) This static method attempts to establish a connection to an Engine.
static EngineManagement	connectToEngine(java.lang.String host, int port, java.lang.String processName, java.lang.String[] args) This static method attempts to establish a connection to an Engine.
static EngineManagement	connectToEngineMonitorOnly(java.lang.String host, int port, java.lang.String processName) Attempt to establish a monitor-only connection to an Engine listening on the named host and port.
static EngineManagement	connectToEngineReceiveOnly(java.lang.String host, int port, java.lang.String processName) Attempt to establish a receive-only connection to an Engine listening on the named host and port.

Methods inherited from class java.lang.Object

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

Method Detail

connectToEngine

public static EngineManagement connectToEngine(java.lang.String host,
                                               int port)
                                        throws EngineException

This static method attempts to establish a connection to an Engine. It returns an EngineManagement object that can be used to access the Engine.

Parameters:

host - The machine name where an Engine can be located.

port - The port that the Engine is listening on.

Returns:

An EngineManagement object if an Engine is located and a connection established.

Throws:

EngineException - Thrown if any exceptions occur in the Client SDK.

connectToEngine

public static EngineManagement connectToEngine(java.lang.String host,
                                               int port,
                                               java.lang.String processName)
                                        throws EngineException

This static method attempts to establish a connection to an Engine. It returns an EngineManagement object that can be used to access the Engine.

Parameters:

host - The machine name where an Engine can be located.

port - The port that the Engine is listening on.

processName - The process name of the caller

Returns:

An EngineManagement object if an Engine is located and a connection established.

Throws:

EngineException - Thrown if any exceptions occur in the Client SDK.

connectToEngineReceiveOnly

public static EngineManagement connectToEngineReceiveOnly(java.lang.String host,
                                                          int port,
                                                          java.lang.String processName)
                                                   throws EngineException

Attempt to establish a receive-only connection to an Engine listening on the named host and port. If successful, the returned EngineManagement can be used for the connectEventConsumer(), getStatus(), getEngineVersion(), inspectEngine() and ping() operations. All other operations will fail.

Parameters:

host - The hostname of the machine the Engine is running on.

port - The port that the Engine is listening on.

processName - The process name of the caller

Returns:

An EngineManagement object operating in receive-only mode.

Throws:

EngineException - If the connection cannot be established.

connectToEngineMonitorOnly

public static EngineManagement connectToEngineMonitorOnly(java.lang.String host,
                                                          int port,
                                                          java.lang.String processName)
                                                   throws EngineException

Attempt to establish a monitor-only connection to an Engine listening on the named host and port. If successful, the returned EngineManagement can be used for the getStatus(), getEngineVersion(), inspectEngine() and ping() operations. All other operations will fail.

Parameters:

host - The hostname of the machine the Engine is running on.

port - The port that the Engine is listening on.

processName - The process name of the caller

Returns:

An EngineManagement object operating in monitor-only mode.

Throws:

EngineException - If the connection cannot be established.

connectToEngine

public static EngineManagement connectToEngine(java.lang.String host,
                                               int port,
                                               java.lang.String processName,
                                               java.lang.String[] args)
                                        throws EngineException

This static method attempts to establish a connection to an Engine. It returns an EngineManagement object that can be used to access the Engine.

Parameters:

host - The machine name where an Engine can be located.

port - The port that the Engine is listening on.

processName - The process name of the caller

args - Any other configuration information. (null is permitted)

Returns:

An EngineManagement object if an Engine is located and a connection established.

Throws:

EngineException - Thrown if any exceptions occur in the Client SDK.