com.apama.engine.beans.interfaces
Interface EngineClientInterface

All Superinterfaces:

BaseClientInterface, ConnectOperationsInterface, DeleteOperationsInterface, InjectOperationsInterface, InspectOperationsInterface, PingClientInterface, PingOperationsInterface, ReceiveConsumerOperationsInterface, SendOperationsInterface, WatchOperationsInterface

All Known Implementing Classes:

EngineClientBean

public interface EngineClientInterface
extends PingClientInterface, DeleteOperationsInterface, InjectOperationsInterface, InspectOperationsInterface, SendOperationsInterface, WatchOperationsInterface, ReceiveConsumerOperationsInterface, ConnectOperationsInterface

EngineClientInterface is an interface that specifies ALL of the standard operations to enable an engine client to communicate with a remote correlator. Use EngineClientFactory to construct an instance of this interface.

Field Summary

static boolean	DEFAULT_MONITOR_ONLY The default value for the monitorOnly property.
static boolean	DEFAULT_RECEIVE_ONLY The default value for the receiveOnly property.
static java.lang.String	PROPERTY_MONITOR_ONLY The string name of the bound property that is used for "monitorOnly" updates.
static java.lang.String	PROPERTY_RECEIVE_ONLY The string name of the bound property that is used for "receiveOnly" updates.

Fields inherited from interface com.apama.net.beans.interfaces.BaseClientInterface

COPYRIGHT, DEFAULT_CONNECTION_POLLING_INTERVAL, DEFAULT_HOST, DEFAULT_PORT, DEFAULT_PROCESS_NAME, PRODUCTNAME, PROPERTY_BEAN_CONNECTED, PROPERTY_CONNECTION_POLLING_INTERVAL, PROPERTY_HOST, PROPERTY_PORT, PROPERTY_PROCESS_NAME, PROPERTY_VERBOSE, VERSION

Fields inherited from interface com.apama.engine.beans.interfaces.InspectOperationsInterface

DEFAULT_INSPECT_POLLING_INTERVAL, PROPERTY_ENGINE_INFO, PROPERTY_INSPECT_POLLING_INTERVAL

Fields inherited from interface com.apama.engine.beans.interfaces.WatchOperationsInterface

DEFAULT_STATUS_POLLING_INTERVAL, PROPERTY_STATUS, PROPERTY_STATUS_POLLING_INTERVAL

Fields inherited from interface com.apama.engine.beans.interfaces.ReceiveConsumerOperationsInterface

PROPERTY_ALL_CONSUMERS_CONNECTED

Method Summary

void	connectInBackground() Requests that the client begins to establish a connection in the background.
void	setReconnectPeriod(long reconnectPeriodMillis) Set the minimum period between attempts to reconnect the bean and/or any of the bean's named consumers that have been disconnected (e.g.
void	setReconnectPolicy(ReconnectPolicyInterface p) Set a singleton reconnection policy that will be used to limit when reconnection can be attempted for the bean, and/or any of the bean's named consumers that have been disconnected (e.g.

Methods inherited from interface com.apama.net.beans.interfaces.PingOperationsInterface

pingServer

Methods inherited from interface com.apama.net.beans.interfaces.BaseClientInterface

addPropertyChangeListener, addPropertyChangeListener, connectNow, disconnect, dispose, getBeanConnected, getConnectionPollingInterval, getHost, getPort, getProcessName, isBeanConnected, removePropertyChangeListener, removePropertyChangeListener, setConnectionPollingInterval, setHost, setPort, setProcessName

Methods inherited from interface com.apama.engine.beans.interfaces.DeleteOperationsInterface

deleteAll, deleteName, deleteNames, deleteNamesFromFile, deleteNamesFromFile, killName, killNames, killNamesFromFile, killNamesFromFile, setCancelDeleteFileRead

Methods inherited from interface com.apama.engine.beans.interfaces.InjectOperationsInterface

injectCDP, injectCDPsFromFile, injectJavaApplication, injectJavaApplicationsFromFile, injectMonitorScript, injectMonitorScript, injectMonitorScriptFromFile, injectMonitorScriptFromFile, injectMonitorScriptFromFile, setCancelInjectFileRead

Methods inherited from interface com.apama.engine.beans.interfaces.InspectOperationsInterface

getEngineInfo, getInspectPollingInterval, getRemoteEngineInfo, setInspectPollingInterval, startInspectPollingThread, stopInspectPollingThread

Methods inherited from interface com.apama.engine.beans.interfaces.SendOperationsInterface

flushEvents, sendEvents, sendEvents, sendEventsFromFile, sendEventsFromFile, sendEventsFromFile, setCancelSendFileRead

Methods inherited from interface com.apama.engine.beans.interfaces.WatchOperationsInterface

getRemoteStatus, getStatus, getStatusPollingInterval, setStatusPollingInterval, startStatusPollingThread, stopStatusPollingThread

Methods inherited from interface com.apama.engine.beans.interfaces.ReceiveConsumerOperationsInterface

addConsumer, addConsumer, addConsumer, getAllConsumers, getConsumer, isAllConsumersConnected, removeAllConsumers, removeConsumer

Methods inherited from interface com.apama.engine.beans.interfaces.ConnectOperationsInterface

attachAsConsumerOfEngine, attachAsConsumerOfEngine, attachAsConsumerOfEngine, attachAsConsumerOfEngine, detachAsConsumerOfEngine, detachAsConsumerOfEngine, detachAsConsumerOfEngine, setPersistentReceiveConnections

Field Detail

PROPERTY_MONITOR_ONLY

static final java.lang.String PROPERTY_MONITOR_ONLY

The string name of the bound property that is used for "monitorOnly" updates.

See Also:

Constant Field Values

PROPERTY_RECEIVE_ONLY

static final java.lang.String PROPERTY_RECEIVE_ONLY

The string name of the bound property that is used for "receiveOnly" updates.

See Also:

Constant Field Values

DEFAULT_MONITOR_ONLY

static final boolean DEFAULT_MONITOR_ONLY

The default value for the monitorOnly property.

See Also:

Constant Field Values

DEFAULT_RECEIVE_ONLY

static final boolean DEFAULT_RECEIVE_ONLY

The default value for the receiveOnly property.

See Also:

Constant Field Values

Method Detail

connectInBackground

void connectInBackground()

Requests that the client begins to establish a connection in the background.

Calling BaseClientInterface.disconnect() will bring connection attempts to an end. Repeated calls to this method, or calling this method after a connection has already been established will have no effect.

setReconnectPolicy

void setReconnectPolicy(ReconnectPolicyInterface p)

Set a singleton reconnection policy that will be used to limit when reconnection can be attempted for the bean, and/or any of the bean's named consumers that have been disconnected (e.g. as a slow consumer).

In most cases, we recommend using setReconnectPeriod(long) instead of writing a custom policy object.

See Also:

ReconnectPolicyInterface

setReconnectPeriod

void setReconnectPeriod(long reconnectPeriodMillis)

Set the minimum period between attempts to reconnect the bean and/or any of the bean's named consumers that have been disconnected (e.g. as a slow consumer).

By default there is no minimum reconnection period defined, and if any consumers have been disconnected by the engine, the bean will attempt to reconnect them at least as often as the bean's connection polling interval.

Any previously set reconnect policy will be overwritten when this method is called.

Parameters:

reconnectPeriodMillis - The minimum reconnection period in milliseconds, or 0 to place no limit on how often we can attempt to reconnect.

See Also:

setReconnectPolicy(ReconnectPolicyInterface)