public interface EngineClientInterface extends PingClientInterface, DeleteOperationsInterface, InjectOperationsInterface, InspectOperationsInterface, SendOperationsInterface, WatchOperationsInterface, ReceiveConsumerOperationsInterface, ConnectOperationsInterface
EngineClientFactory
to construct an instance of this interface.Modifier and Type | Field and Description |
---|---|
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.
|
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
DEFAULT_INSPECT_POLLING_INTERVAL, PROPERTY_ENGINE_INFO, PROPERTY_INSPECT_POLLING_INTERVAL
DEFAULT_STATUS_POLLING_INTERVAL, PROPERTY_STATUS, PROPERTY_STATUS_POLLING_INTERVAL
PROPERTY_ALL_CONSUMERS_CONNECTED
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener.
|
void |
addPropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Add a property change listener for a specific named property.
|
void |
addPropertyChangeListenerSync(java.beans.PropertyChangeListener listener)
Deprecated.
Use addPropertyChangeListener instead
|
void |
addPropertyChangeListenerSync(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Deprecated.
Use addPropertyChangeListener instead
|
void |
connectInBackground()
Requests that the client begins to establish a connection in the background.
|
void |
connectNow()
Manually request that the bean connects to the remote server.
|
void |
disconnect()
Disconnect from a server.
|
void |
flushListeners()
Utility method that blocks until all pending property change listeners
that have already fired have finished executing.
|
void |
pingServer()
Manually test if the remote server process is alive and responding to client requests.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener.
|
void |
removePropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Remove a property change listener for a specific named property.
|
void |
removePropertyChangeListenerSync(java.beans.PropertyChangeListener listener)
Deprecated.
|
void |
removePropertyChangeListenerSync(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Deprecated.
|
void |
setHost(java.lang.String newHostValue)
Setter for the host property.
|
void |
setPort(int newPortValue)
Setter for the port property.
|
void |
setProcessName(java.lang.String newProcessName)
Setter for the process name property.
|
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.
|
close, dispose, getBeanConnected, getConnectionPollingInterval, getHost, getPort, getProcessName, isBeanConnected, setConnectionPollingInterval
deleteAll, deleteName, deleteNames, deleteNamesFromFile, deleteNamesFromFile, killName, killNames, killNamesFromFile, killNamesFromFile, setCancelDeleteFileRead
injectCDP, injectCDPsFromFile, injectJavaApplication, injectJavaApplicationsFromFile, injectMonitorScript, injectMonitorScript, injectMonitorScriptFromFile, injectMonitorScriptFromFile, injectMonitorScriptFromFile, setCancelInjectFileRead
getEngineInfo, getInspectPollingInterval, getRemoteEngineInfo, setInspectPollingInterval, startInspectPollingThread, stopInspectPollingThread
flushEvents, sendEvents, sendEvents, sendEventsFromFile, sendEventsFromFile, sendEventsFromFile, sendEventsFromFile, setCancelSendFileRead
getRemoteStatus, getStatus, getStatusPollingInterval, setStatusPollingInterval, startStatusPollingThread, stopStatusPollingThread
addAsyncConsumer, addConsumer, addConsumer, addConsumer, getAllConsumers, getConsumer, isAllConsumersConnected, isDisconnectIfSlowReceiver, removeAllConsumers, removeConsumer
attachAsConsumerOfEngine, attachAsConsumerOfEngine, attachAsConsumerOfEngine, attachAsConsumerOfEngine, detachAsConsumerOfEngine, detachAsConsumerOfEngine, detachAsConsumerOfEngine, detachAsConsumerOfEngine, getReceiverConnections, setPersistentReceiveConnections, setReceiverConnections
static final java.lang.String PROPERTY_MONITOR_ONLY
static final java.lang.String PROPERTY_RECEIVE_ONLY
static final boolean DEFAULT_MONITOR_ONLY
static final boolean DEFAULT_RECEIVE_ONLY
void connectInBackground()
Calling 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.
void setReconnectPolicy(ReconnectPolicyInterface p)
In most cases, we recommend using setReconnectPeriod(long)
instead of writing a custom policy object.
ReconnectPolicyInterface
void setReconnectPeriod(long reconnectPeriodMillis)
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.
reconnectPeriodMillis
- The minimum reconnection period in milliseconds, or 0 to place no limit on
how often we can attempt to reconnect.setReconnectPolicy(ReconnectPolicyInterface)
void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
removePropertyChangeListener
in interface BaseClientInterface
listener
- the listener to be removed.void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
removePropertyChangeListener
in interface BaseClientInterface
propertyName
- the name of the property that was listened on.listener
- the listener to be removed.void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
addPropertyChangeListener
in interface BaseClientInterface
listener
- the listener to be added.void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
addPropertyChangeListener
in interface BaseClientInterface
propertyName
- the name of the property to listen on.listener
- the listener to be added.void flushListeners()
@Deprecated void addPropertyChangeListenerSync(java.beans.PropertyChangeListener listener)
listener
- the listener to be added.@Deprecated void addPropertyChangeListenerSync(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
- the name of the property to listen on.listener
- the listener to be added.@Deprecated void removePropertyChangeListenerSync(java.beans.PropertyChangeListener listener)
listener
- the listener to be removed.@Deprecated void removePropertyChangeListenerSync(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
- the name of the property that was listened on.listener
- the listener to be removed.void setHost(java.lang.String newHostValue) throws EngineException
setHost
in interface BaseClientInterface
newHostValue
- The new value for the Host property.EngineException
- Thrown if any exceptions occur in the Client SDK.void setPort(int newPortValue) throws EngineException
setPort
in interface BaseClientInterface
newPortValue
- The new value for the Port property.EngineException
- Thrown if any exceptions occur in the Client SDK.void setProcessName(java.lang.String newProcessName) throws EngineException
setProcessName
in interface BaseClientInterface
newProcessName
- The new value for the Process NameEngineException
- Thrown if any exceptions occur in the Client SDK.void connectNow() throws EngineException
pingServer()
from the PingOperationsInterface.connectNow
in interface BaseClientInterface
EngineException
- Thrown if any exceptions occur in the Client SDK.void disconnect() throws EngineException
The beanConnected property is set to false, and the connection polling thread is terminated.
disconnect
in interface BaseClientInterface
EngineException
- When there was a problem during the disconnection.void pingServer() throws EngineException
pingServer
in interface PingOperationsInterface
EngineException
- when the ping fails.Submit a bug or feature
Copyright (c) 2013-2018 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.