public interface BaseClientInterface
extends java.lang.AutoCloseable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The copyright statement that is displayed in the usage string of a number of components.
|
static int |
DEFAULT_CONNECTION_POLLING_INTERVAL
The default value for the connectionPollingInterval property in milliseconds.
|
static java.lang.String |
DEFAULT_HOST
The default value for the host property, see
ConnectionConstants.DEFAULT_HOST |
static int |
DEFAULT_PORT
The default value for the port property, initialised for an Engine, see
ConnectionConstants.DEFAULT_PORT . |
static java.lang.String |
DEFAULT_PROCESS_NAME
The default value for the process name, initialised for an Engine, see
ConnectionConstants.DEFAULT_PROCESS_NAME . |
static java.lang.String |
PRODUCTNAME
The name of the product - this is just one component of the name that the user sees.
|
static java.lang.String |
PROPERTY_BEAN_CONNECTED
The string name of the bound property that is used for "beanConnected" updates
(typically "beanConnected", but this constant should be used to be sure).
|
static java.lang.String |
PROPERTY_CONNECTION_POLLING_INTERVAL
The string name of the bound property that is used for "connectionPollingInterval" updates
(typically "connectionPollingInterval", but this constant should be used to be sure).
|
static java.lang.String |
PROPERTY_HOST
The string name of the bound property that is used for "host" updates
(typically "host", but this constant should be used to be sure).
|
static java.lang.String |
PROPERTY_PORT
The string name of the bound property that is used for "port" updates
(typically "port", but this constant should be used to be sure).
|
static java.lang.String |
PROPERTY_PROCESS_NAME
The string name of the bound property that is used for "processName" updates
(typically "processName", but this constant should be used to be sure).
|
static java.lang.String |
PROPERTY_VERBOSE
The string name of the bound property that is used for "verbose" updates
(typically "verbose", but this constant should be used to be sure).
|
static java.lang.String |
VERSION
The marketing version number for the product as a whole.
|
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 |
close()
Disconnects the client and also waits to ensure that all background threads and other resources
associated with this object have been terminated or freed.
|
void |
connectNow()
Manually request that the bean connects to the remote server.
|
void |
disconnect()
Disconnect from a server.
|
void |
dispose()
Deprecated.
Replaced by
close() as of Apama version 9.10 |
boolean |
getBeanConnected()
Get the beanConnected property value.
|
int |
getConnectionPollingInterval()
Get the polling interval (in milliseconds) for the internal connection test thread.
|
java.lang.String |
getHost()
Get the name of the host to be connected to.
|
int |
getPort()
Get the port number to be connected to.
|
java.lang.String |
getProcessName()
Get the process name of this client
This is the process name used when initialising the client
|
boolean |
isBeanConnected()
Another name for the getBeanConnected() method.
|
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 |
setConnectionPollingInterval(int milliseconds)
Set the polling interval (in milliseconds) for the internal connection test thread.
|
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.
|
static final java.lang.String VERSION
static final java.lang.String PRODUCTNAME
static final java.lang.String COPYRIGHT
static final java.lang.String DEFAULT_HOST
ConnectionConstants.DEFAULT_HOST
static final int DEFAULT_PORT
ConnectionConstants.DEFAULT_PORT
.static final java.lang.String DEFAULT_PROCESS_NAME
ConnectionConstants.DEFAULT_PROCESS_NAME
.static final int DEFAULT_CONNECTION_POLLING_INTERVAL
static final java.lang.String PROPERTY_HOST
static final java.lang.String PROPERTY_PORT
static final java.lang.String PROPERTY_PROCESS_NAME
static final java.lang.String PROPERTY_BEAN_CONNECTED
static final java.lang.String PROPERTY_CONNECTION_POLLING_INTERVAL
static final java.lang.String PROPERTY_VERBOSE
void connectNow() throws com.apama.util.CompoundException
pingServer()
from the PingOperationsInterface.com.apama.util.CompoundException
- Thrown if any exceptions occur in the Client SDK.void disconnect() throws com.apama.util.CompoundException
The beanConnected property is set to false, and the connection polling thread is terminated.
com.apama.util.CompoundException
- When there was a problem during the disconnection.
Some implementations use a subclass of CompoundException.void close()
This method is invoked automatically on objects managed by the try-with-resources statement.
close
in interface java.lang.AutoCloseable
AutoCloseable.close()
@Deprecated void dispose()
close()
as of Apama version 9.10java.lang.String getHost()
void setHost(java.lang.String newHostValue) throws com.apama.util.CompoundException
newHostValue
- The new value for the Host property.com.apama.util.CompoundException
- Thrown if any exceptions occur in the Client SDK.int getPort()
void setPort(int newPortValue) throws com.apama.util.CompoundException
newPortValue
- The new value for the Port property.com.apama.util.CompoundException
- Thrown if any exceptions occur in the Client SDK.java.lang.String getProcessName()
void setProcessName(java.lang.String newProcessName) throws com.apama.util.CompoundException
newProcessName
- The new value for the Process Namecom.apama.util.CompoundException
- Thrown if any exceptions occur in the Client SDK.boolean isBeanConnected()
boolean getBeanConnected()
int getConnectionPollingInterval()
void setConnectionPollingInterval(int milliseconds)
milliseconds
- the polling interval in millisecondsvoid removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- the listener to be removed.void removePropertyChangeListener(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 addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- the listener to be added.void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
- the name of the property to listen on.listener
- the listener to be added.Submit a bug or feature
Copyright (c) 2013-2020 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.