public class BrokerMonitorClient
extends java.lang.Object
Many calls throw "communications exception". These exceptions are:
Modifier and Type | Field and Description |
---|---|
static int |
BROKER_MONITOR_DEFAULT_PORT |
Constructor and Description |
---|
BrokerMonitorClient(java.lang.String broker_monitor_host)
Create a Broker Monitor client.
|
BrokerMonitorClient(java.lang.String broker_monitor_host,
BrokerConnectionDescriptor desc)
Create a Broker Monitor client.
|
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Destroys the Broker Monitor client.
|
java.lang.String |
getHostName()
Get the host name of Broker Monitor.
|
int |
getPort()
Get the port being used by the Broker Monitor.
|
BrokerServerLogEntry[] |
getServerLogEntries(int base_port,
BrokerDate first_entry,
java.lang.String locale,
int num_entries)
Get a set of server log entries, for the server listening on the given base port number.
|
COM.activesw.api.client.BrokerServerLogInfo |
getServerLogStatus(int base_port)
Get the server log status, for the server listening on the given base port number.
|
int |
getServerRunStatus(int port)
Specifies whether the Broker Server is online, stopped, starting, stopping, unresponsive, failed, or unknown.
|
COM.activesw.api.client.BrokerServerInfo[] |
getServers()
Get the configuration details of all Broker Servers on the host.
|
java.lang.String |
getVersion()
Get the version of the Broker Monitor.
|
int |
getVersionNumber()
Get Broker Monitor's version number.
|
void |
pruneMonitorLog(int base_port,
BrokerDate older_than)
Delete entries from the Broker Monitor's log.
|
void |
reloadConfig()
Make Broker Monitor to re-load its configuration for all the servers.
|
void |
reloadConfigForServer(int port)
Make Broker Monitor to re-read its configuration for the specified server.
|
void |
startServer(int port)
Start a server.
|
java.lang.String |
toString()
Get Broker Monitor client information in a form suitable for human viewing.
|
public static final int BROKER_MONITOR_DEFAULT_PORT
public BrokerMonitorClient(java.lang.String broker_monitor_host) throws BrokerException
BrokerCommFailureException
- If problems occur while establishing the connection.BrokerHostNotFoundException
- If the specified host does not exist.BrokerNotRunningException
- If the host exists but no Broker Monitor is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerException
public BrokerMonitorClient(java.lang.String broker_monitor_host, BrokerConnectionDescriptor desc) throws BrokerException
BrokerCommFailureException
- If problems occur while establishing the connection.BrokerHostNotFoundException
- If the specified host does not exist.BrokerNotRunningException
- If the host exists but no Broker Monitor is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerInvalidPortException
- If the monitor port is invalid.BrokerException
public void destroy() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public java.lang.String getHostName()
public int getPort()
public int getServerRunStatus(int port) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerUnknownServerException
- If no server is configured on the specified port.BrokerException
public COM.activesw.api.client.BrokerServerInfo[] getServers() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void startServer(int port) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerUnknownServerException
- If no server is configured on the specified port.BrokerException
public void reloadConfig() throws BrokerException
BrokerException
public void reloadConfigForServer(int port) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerUnknownServerException
- If no server is configured on the specified port.BrokerException
public int getVersionNumber()
If Broker Monitor is newer than Broker Monitor client's version, Broker Monitor client's version is reported.
public java.lang.String getVersion() throws BrokerException
BrokerInvalidClientException
- If Broker Monitor client has been destroyed.BrokerException
public COM.activesw.api.client.BrokerServerLogInfo getServerLogStatus(int base_port) throws BrokerException
BrokerInvalidClientException
- If Broker Monitor client has been destroyed.BrokerIncompatibleVersionException
- If the version of the Broker is not known to this operation.BrokerNoPermissionException
- If the client has limited access.BrokerException
public BrokerServerLogEntry[] getServerLogEntries(int base_port, BrokerDate first_entry, java.lang.String locale, int num_entries) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the version of the Broker is not known to this operation.BrokerOutOfRangeException
- If num_entries is less than -1.BrokerNoPermissionException
- If the client has limited access.BrokerException
public void pruneMonitorLog(int base_port, BrokerDate older_than) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the version of the Broker is not known to this operation.BrokerNullParameterException
- If older_than is null.BrokerNoPermissionException
- If the client has limited access.BrokerException
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2002-2006 webMethods, Inc. Copyright © 2007-2021 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.