public class BrokerServerClient
extends java.lang.Object
Many calls say they can throw a "communications exception". These exceptions are:
Modifier and Type | Field and Description |
---|---|
static int |
BROKER_SERVER_DEFAULT_PORT |
static int |
PUBLISH_PROCESSING_ACTIVE |
static int |
PUBLISH_PROCESSING_PAUSE |
static int |
SERVER_LOG_ALL_ENTRIES |
static int |
SERVER_STATUS_ERROR |
static int |
SERVER_STATUS_FAILED |
static int |
SERVER_STATUS_RUNNING |
static int |
SERVER_STATUS_STARTING |
static int |
SERVER_STATUS_STOPPED |
static int |
SERVER_STATUS_STOPPING |
static int |
SERVER_STATUS_UNKNOWN |
static int |
SSL_STATUS_DISABLED |
static int |
SSL_STATUS_ENABLED |
static int |
SSL_STATUS_ERROR |
static int |
SSL_STATUS_NOT_SUPPORTED |
Constructor and Description |
---|
BrokerServerClient(java.lang.String broker_host,
BrokerConnectionDescriptor desc)
Create a Broker Server client.
|
Modifier and Type | Method and Description |
---|---|
boolean |
checkMetaDataBackup()
Verifies that the backup of the meta-data is still OK to proceed.
|
void |
createBroker(java.lang.String broker_name,
java.lang.String description,
boolean is_default)
Create a Broker.
|
void |
destroy()
Destroy the Broker Server client.
|
void |
endMetaDataBackup()
Notifies the Broker that backup of the meta-data is complete.
|
java.util.Locale |
getActiveFilterCollationLocale()
Returns the active Broker Server Filter Collation locale.
|
int |
getActivePort()
Get the base port currently being used by the Broker Server.
|
BrokerProcessInfo |
getActiveProcessInfo()
Get the process information currently in use by the Broker Server.
|
BrokerSSLConfig |
getActiveSSLConfig()
Get the SSL configuration currently in use on by the Broker Server.
|
BrokerSSLConfigV2 |
getActiveSSLConfigV2()
Get the SSL configuration currently in use on by the Broker Server.
|
BrokerSSLIdentity |
getActiveSSLIdentity()
Get the BrokerServer's SSL identity that is currently in use on by the Broker Server.
|
BrokerAccessControlList |
getAdminACL()
Get the Broker Server's administrative access control list (ACL).
|
int |
getAuditOnErrorState()
Returns 1 if the audit error state is enabled and 0 if the audit error state is disabled
|
short[] |
getAuditOperations()
Returns the audit operations
|
COM.activesw.api.client.BrokerAuditLogEntry[] |
getAuditRecords(java.lang.Integer noRecords,
java.lang.Integer AckId,
int msecs)
Reads the 'noRecords' number of audit records taking into consideration that AckId is the ID of the last record accessed.
|
int |
getAuditState()
Returns 1 if the audit state is enabled and 0 if the audit state is disabled.
|
java.util.Locale[] |
getAvailableLocales() |
COM.activesw.api.client.BrokerBasicAuthIdentity |
getBasicAuthIdentity()
Returns the Broker Server's basic authentication identity that is in use.
|
boolean |
getBasicAuthStatus()
Returns whether basic authentication is configured on Broker Server.
|
BrokerInfo[] |
getBrokers()
Get the list of Brokers in a given server.
|
boolean |
getBypassAuthCheckStatus()
Returns whether to bypass basic authentication checks on Broker Server.
|
BrokerConnectionDescriptor |
getConnectionDescriptor() |
java.lang.String |
getDefaultBrokerName()
Get the name of the default Broker in the server.
|
java.lang.String |
getDescription()
Get the Broker Server description.
|
java.lang.String |
getDNFromKeystore(java.lang.String keystore,
java.lang.String password,
BrokerSSLConfigV2.KeystoreType keystoreType)
Get the distinguished name in the given keystore on the Broker Server.
|
java.lang.String[] |
getDNsFromCertFile(java.lang.String certificate_file,
java.lang.String password)
Get the list of distinguished names available in the given certificate file on the Broker Server.
|
protected java.util.Locale |
getFilterCollationLocaleInternal(boolean saved) |
java.lang.String |
getFipsMode()
Returns the FIPS mode set on the Broker Server.
|
java.util.Map<java.lang.String,java.lang.String> |
getHardwareInfo()
Get the Broker Server hardware info string.
|
java.lang.String |
getHostName()
Get the host name of the Broker Server.
|
java.lang.String |
getIssuerDNFromKeystore(java.lang.String keystore,
java.lang.String password,
BrokerSSLConfigV2.KeystoreType keystoreType)
Get the issuer distinguished name in the given keystore on the Broker Server.
|
java.lang.String |
getLicense()
Deprecated.
Deprecated in webMethods Broker 9.0, instead use
getLicenseFileName() |
java.lang.String |
getLicenseContent()
Get the Broker Server license file content.
|
java.lang.String |
getLicenseFileName()
Get the Broker Server license file name.
|
BrokerLogConfig |
getLogConfig()
Get the Broker server logging configuration.
|
java.lang.String[] |
getMetaDataStorageFiles()
Get the path names for the MetaData storage files.
|
int |
getMonitorPort()
Get the Broker Monitor port managing the current Broker Server.
|
java.lang.String |
getProductDisplayName()
Get the Product display name.
|
int |
getPublicationProcessingState()
Get the Broker Server publication processing state.
|
java.lang.String[] |
getRootDNsFromCertFile(java.lang.String certificate_file,
java.lang.String password)
Get the list of trusted root distinguished names available in the given certificate file on the Broker Server.
|
java.lang.String[] |
getRootDNsFromTruststore(java.lang.String truststore,
BrokerSSLConfigV2.TruststoreType truststoreType)
Get the list of trusted root distinguished names available in the given truststore on the Broker Server.
|
java.util.Locale |
getSavedFilterCollationLocale()
Returns the saved Broker Server Filter Collation locale.
|
BrokerSSLConfig |
getSavedSSLConfig()
Get the SSL configuration to be used next time the Broker Server is started.
|
BrokerSSLConfigV2 |
getSavedSSLConfigV2()
Get the SSL configuration to be used next time the Broker Server is started.
|
BrokerSSLIdentity |
getSavedSSLIdentity()
Get the BrokerServer's SSL identity that will be used the next time the Broker Server is restarted.
|
BrokerServerLogEntry[] |
getServerLogEntries(BrokerDate first_entry,
java.lang.String locale,
int num_entries) |
COM.activesw.api.client.BrokerServerLogInfo |
getServerLogStatus()
Get the Broker Server log status.
|
static int |
getServerProcessRunStatus(java.lang.String broker_host)
Specifies whether the Broker Server is online, stopped, starting, stopping, unresponsive, failed, or unknown.
|
static int |
getServerProcessRunStatus(java.lang.String broker_monitor_host,
int monitorPort,
int brokerPort)
Specifies whether the Broker Server is online, stopped, starting, stopping, unresponsive, failed, or unknown.
|
BrokerSSLStatus |
getSSLStatus()
Get the current status of the Broker Server SSL configuration.
|
BrokerEvent |
getStats()
Get the Broker Server statistics.
|
BrokerEvent |
getStorageStats()
Get the Broker Server storage statistics.
|
BrokerEvent |
getUsageStats()
Get the Broker Server system usage statistics.
|
java.lang.String |
getVersion()
Get the Broker Server version string.
|
int |
getVersionNumber()
Get the Broker Server's version number.
|
boolean |
isConnectionUsingSSL() |
boolean |
isStreamingEnabled()
Returns true if streaming is enabled on the Broker Server.
|
void |
pausePublishProcessing()
pause Broker Server publication processing.
|
void |
pruneServerLog(BrokerDate older_than)
Delete entries from the Broker Server log.
|
void |
registerConnectionCallback(BrokerServerConnectionCallback obj,
java.lang.Object client_data)
Register a connection callback for this client.
|
void |
resumePublishProcessing()
resume Broker Server publication processing.
|
void |
setAdminACL(BrokerAccessControlList acl)
Set the Broker Server's administrative access control list (ACL).
|
void |
setAuditOnErrorState(int state)
Sets audit on error and the action for the audit log error.
|
void |
setAuditOperations(short[] ops)
Sets the audit operations as specified by the values in ops.
|
void |
setAuditState(int state)
Enables/Disables the audit state.
|
void |
setBasicAuthIdentity(COM.activesw.api.client.BrokerBasicAuthIdentity new_identity)
Sets the Broker Server's identity for basic authentication.
|
void |
setDefaultBrokerName(java.lang.String broker_name)
Set the name of the default Broker in the server.
|
void |
setDescription(java.lang.String description)
Set the Broker Server description.
|
void |
setFilterCollationLocale(java.lang.String locale)
Set the Broker Server Filter Collation locale.
|
void |
setLicense(java.lang.String license)
Deprecated.
Deprecated in webMethods Broker 9.0, instead use
setLicenseFileName(String) |
void |
setLicenseContent(java.lang.String licenseFileContent)
Set the license file content for Broker Server.
|
void |
setLicenseFile(java.lang.String licenseFile)
Deprecated.
Deprecated in webMethods Broker 9.0, instead use
setLicenseFileName(String) |
void |
setLicenseFileName(java.lang.String licenseFileName)
Set the license file name for Broker Server.
|
void |
setLogConfig(BrokerLogConfig log_config)
Set the Broker Server logging configuration.
|
void |
setSSLConfig(BrokerSSLConfig new_config)
Set the SSL configuration to be used next time the Broker Server is started.
|
void |
setSSLConfig(java.lang.String certificate_file,
java.lang.String password,
java.lang.String distinguished_name)
Set the SSL configuration to be used next time the Broker Server is started.
|
void |
setSSLConfigV2(BrokerSSLConfigV2 new_config)
Set the SSL configuration to be used next time the Broker server is started.
|
boolean |
startMetaDataBackup()
Notifies the Broker that backup of the meta-data is going to start.
|
static void |
startServerProcess(java.lang.String broker_host)
Start the Broker Server process (if it is not already started).
|
static void |
startServerProcess(java.lang.String broker_monitor_host,
int monitorPort,
int brokerPort)
Start the Broker Server process (if it is not already started).
|
void |
stopProcess()
Stop the Broker Server process.
|
java.lang.String |
toString()
Get a string with the server client information in a form suitable for human viewing.
|
public static final int BROKER_SERVER_DEFAULT_PORT
public static final int SERVER_STATUS_STARTING
public static final int SERVER_STATUS_RUNNING
public static final int SERVER_STATUS_STOPPING
public static final int SERVER_STATUS_STOPPED
public static final int SERVER_STATUS_ERROR
public static final int SERVER_STATUS_UNKNOWN
public static final int SERVER_STATUS_FAILED
public static final int SSL_STATUS_ENABLED
public static final int SSL_STATUS_ERROR
public static final int SSL_STATUS_DISABLED
public static final int SSL_STATUS_NOT_SUPPORTED
public static final int SERVER_LOG_ALL_ENTRIES
public static final int PUBLISH_PROCESSING_ACTIVE
public static final int PUBLISH_PROCESSING_PAUSE
public BrokerServerClient(java.lang.String broker_host, BrokerConnectionDescriptor desc) throws BrokerException
BrokerCommFailureException
- If problems occur establishing the connection.BrokerHostNotFoundException
- If the specified host does not exist.BrokerNotRunningException
- If the host exists but no Broker Server is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerSecurityException
- If a secure connection is attempted but is rejected by the Broker Server.BrokerException
public void destroy() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public BrokerAccessControlList getAdminACL() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerException
public void setAdminACL(BrokerAccessControlList acl) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If ACL is null.BrokerException
public java.lang.String getDNFromKeystore(java.lang.String keystore, java.lang.String password, BrokerSSLConfigV2.KeystoreType keystoreType) throws BrokerException
The keystoreType parameter specifies the type of keystore: either PKCS12 or PEM. If the keystoreType is null, the type is assumed to be PKCS12.
BrokerFileNotFoundException
- If the keystore is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a keystore, or if the client has limited access.BrokerNullParameterException
- If keystore is null.BrokerSSLConfigException
- If the keystoreType is invalid.BrokerException
public java.lang.String getIssuerDNFromKeystore(java.lang.String keystore, java.lang.String password, BrokerSSLConfigV2.KeystoreType keystoreType) throws BrokerException
The keystoreType parameter specifies the type of keystore: either PKCS12 or PEM. If the keystoreType is null, the type is assumed to be PKCS12.
BrokerFileNotFoundException
- If the keystore is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a keystore, or if the client has limited access.BrokerNullParameterException
- If keystore is null.BrokerSSLConfigException
- If the keystoreType is invalid.BrokerException
public java.lang.String[] getRootDNsFromTruststore(java.lang.String truststore, BrokerSSLConfigV2.TruststoreType truststoreType) throws BrokerException
The truststoreType parameter specifies the type of truststore: either PEM or DIR. If the truststoreType is null, the type is assumed to be PEM.
BrokerFileNotFoundException
- If the certificate file is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a certificate file, or if the client has limited access.BrokerNullParameterException
- If certificate_file is null.BrokerException
public java.lang.String[] getDNsFromCertFile(java.lang.String certificate_file, java.lang.String password) throws BrokerException
BrokerFileNotFoundException
- If the certificate file is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a certificate file, or if the client has limited access.BrokerNullParameterException
- If certificate_file is null.BrokerException
public java.lang.String[] getRootDNsFromCertFile(java.lang.String certificate_file, java.lang.String password) throws BrokerException
BrokerFileNotFoundException
- If the certificate file is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a certificate file, or if the client has limited access.BrokerNullParameterException
- If certificate_file is null.BrokerException
public BrokerSSLConfigV2 getActiveSSLConfigV2() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker does not support the old form of SSL configuration.BrokerException
public BrokerSSLConfigV2 getSavedSSLConfigV2() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker does not support the old form of SSL configuration.BrokerException
public void setSSLConfigV2(BrokerSSLConfigV2 new_config) throws BrokerException
BrokerFileNotFoundException
- If the certificate file is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a certificate file, or if the client has limited access.BrokerNullParameterException
- If distinguished_name is null when certificate_file is non-null.BrokerUnknownNameException
- If a distinguished name is specified but does not exist in the certificate file.BrokerIncompatibleVersionException
- If the Broker does not support the new form of SSL configuration.BrokerSSLConfigException
- If there is a problem with the SSL configuration.BrokerException
public void setBasicAuthIdentity(COM.activesw.api.client.BrokerBasicAuthIdentity new_identity) throws BrokerException
BrokerInvalidClientException
- The BrokerServerClient has been destroyed or is disconnected.BrokerIncompatibleVersionException
- Broker Server does not support this operation.BrokerNullParameterException
- The new_identity parameter is null.BrokerBasicAuthFailureException
- Basic Authentication failed for the user.BrokerException
public COM.activesw.api.client.BrokerBasicAuthIdentity getBasicAuthIdentity() throws BrokerException
BrokerInvalidClientException
- The BrokerServerClient has been destroyed or is disconnected.BrokerNoPermissionException
- The client does not have permission to obtain the Broker's basic authentication identity.BrokerIncompatibleVersionException
- Broker Server does not support this operation.BrokerException
public BrokerSSLConfig getActiveSSLConfig() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker does not support the old form of SSL configuration.BrokerException
public BrokerSSLConfig getSavedSSLConfig() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker does not support the old form of SSL configuration.BrokerException
public void setSSLConfig(java.lang.String certificate_file, java.lang.String password, java.lang.String distinguished_name) throws BrokerException
BrokerFileNotFoundException
- If the certificate file is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a certificate file, or if the client has limited access.BrokerNullParameterException
- If distinguished_name is null when certificate_file is non-null.BrokerUnknownNameException
- If a distinguished name is specified but does not exist in the certificate file.BrokerIncompatibleVersionException
- If the Broker does not support the old form of SSL configuration.BrokerException
public void setSSLConfig(BrokerSSLConfig new_config) throws BrokerException
BrokerFileNotFoundException
- If the certificate file is not found or cannot be read.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the password is invalid or if the file is not a certificate file, or if the client has limited access.BrokerNullParameterException
- If distinguished_name is null when certificate_file is non-null.BrokerUnknownNameException
- If a distinguished name is specified but does not exist in the certificate file.BrokerIncompatibleVersionException
- If the Broker does not support the old form of SSL configuration.BrokerException
public BrokerSSLIdentity getActiveSSLIdentity() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker does not support this call.BrokerException
public BrokerSSLIdentity getSavedSSLIdentity() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker does not support this call.BrokerException
public BrokerSSLStatus getSSLStatus() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public boolean getBasicAuthStatus() throws BrokerException
BrokerInvalidClientException
- The BrokerServerClient has been destroyed or is disconnected.BrokerIncompatibleVersionException
- Broker Server does not support this operation.BrokerException
public boolean getBypassAuthCheckStatus() throws BrokerException
BrokerInvalidClientException
- The BrokerServerClient has been destroyed or is disconnected.BrokerIncompatibleVersionException
- Broker Server does not support this operation.BrokerException
public java.lang.String getHostName()
public int getActivePort() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public int getMonitorPort() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public BrokerProcessInfo getActiveProcessInfo() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerException
public BrokerLogConfig getLogConfig() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void setLogConfig(BrokerLogConfig log_config) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerInvalidLogConfigException
- If one or more log configuration entries are not valid. If this exception is thrown, all valid entries are still set.BrokerNoPermissionException
- If the client has limited access.BrokerException
public COM.activesw.api.client.BrokerServerLogInfo getServerLogStatus() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the version of the Broker is known not to this operation.BrokerNoPermissionException
- If the client has limited access.BrokerException
public BrokerServerLogEntry[] getServerLogEntries(BrokerDate first_entry, java.lang.String locale, int num_entries) throws BrokerException
BrokerException
public void pruneServerLog(BrokerDate older_than) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the version of the Broker is known not to this operation.BrokerNullParameterException
- If older_than is null.BrokerNoPermissionException
- If the client has limited access.BrokerException
@Deprecated public java.lang.String getLicense() throws BrokerException
getLicenseFileName()
BrokerException
@Deprecated public void setLicense(java.lang.String license) throws BrokerException
setLicenseFileName(String)
BrokerException
@Deprecated public void setLicenseFile(java.lang.String licenseFile) throws BrokerException
setLicenseFileName(String)
BrokerException
public java.lang.String getLicenseFileName() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerException
public void setLicenseFileName(java.lang.String licenseFileName) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerInvalidLicenseException
- If the license file is not a valid license file.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If license is null.BrokerException
public java.lang.String getLicenseContent() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker does not support getLicenseContentBrokerNoPermissionException
- If the client has limited access.BrokerException
public void setLicenseContent(java.lang.String licenseFileContent) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerInvalidLicenseException
- If the license file is not a valid license file.BrokerNoPermissionException
- If the client has limited access.BrokerIncompatibleVersionException
- If the Broker Server does not support setLicenseContentBrokerNullParameterException
- If license is null.BrokerException
public java.lang.String getDescription() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void setDescription(java.lang.String description) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If description is null.BrokerException
public int getVersionNumber()
If the Broker Server is newer than the client's version, the client's version is reported.
public java.lang.String getVersion() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public java.lang.String getProductDisplayName() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public java.util.Map<java.lang.String,java.lang.String> getHardwareInfo() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public static int getServerProcessRunStatus(java.lang.String broker_host) throws BrokerException
SERVER_STATUS_STARTING
, SERVER_STATUS_RUNNING
, SERVER_STATUS_STOPPING
, SERVER_STATUS_STOPPED
,
SERVER_STATUS_ERROR
, SERVER_STATUS_UNKNOWN
, SERVER_STATUS_FAILED
.
Broker Monitor running at default port BrokerMonitorClient.BROKER_MONITOR_DEFAULT_PORT
is queried for the Broker Server
status.
Use getServerProcessRunStatus(String, int, int)
to query Broker Monitor running at non-default port.broker_host
- Broker Server host name, e.g. "localhost:6859"BrokerException
BrokerHostNotFoundException
- If the specified host does not exist.BrokerInvalidClientException
- If the client has been destroyed.BrokerNotRunningException
- If the host exists but no Broker Monitor is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerUnknownServerException
- If the specified host has a monitor running, but no server is configured on the specified port.public static int getServerProcessRunStatus(java.lang.String broker_monitor_host, int monitorPort, int brokerPort) throws BrokerException
SERVER_STATUS_STARTING
, SERVER_STATUS_RUNNING
, SERVER_STATUS_STOPPING
, SERVER_STATUS_STOPPED
,
SERVER_STATUS_ERROR
, SERVER_STATUS_UNKNOWN
, SERVER_STATUS_FAILED
.broker_monitor_host
- Broker Monitor host name, e.g. "localhost"monitorPort
- Broker Monitor portbrokerPort
- Broker Server portBrokerException
BrokerHostNotFoundException
- If the specified host does not exist.BrokerInvalidClientException
- If the client has been destroyed.BrokerNotRunningException
- If the host exists but no Broker Monitor is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerUnknownServerException
- If the specified host has a monitor running, but no server is configured on the specified port.public static void startServerProcess(java.lang.String broker_host) throws BrokerException
BrokerMonitorClient.BROKER_MONITOR_DEFAULT_PORT
is used for starting the Broker
Server.
Use startServerProcess(String, int, int)
to use Broker Monitor running at non-default port.broker_host
- Broker Server host with port, e.g. "localhost:6849"BrokerException
BrokerCommFailureException
- If problems occur establishing the connection.BrokerHostNotFoundException
- If the specified host does not exist.BrokerNotRunningException
- If the host exists but no Broker Server is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerUnknownServerException
- If the specified host has a monitor running, but no server is configured on the specified port.public static void startServerProcess(java.lang.String broker_monitor_host, int monitorPort, int brokerPort) throws BrokerException
broker_monitor_host
- Broker Monitor host name, e.g. "localhost"monitorPort
- Broker Monitor portbrokerPort
- Broker Server portBrokerException
BrokerCommFailureException
- If problems occur establishing the connection.BrokerHostNotFoundException
- If the specified host does not exist.BrokerNotRunningException
- If the host exists but no Broker Server is running on that host.BrokerNullParameterException
- If broker_host is null.BrokerUnknownServerException
- If the specified host has a monitor running, but no server is configured on the specified port.public void stopProcess() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerException
public BrokerEvent getStats() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public BrokerEvent getUsageStats() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public BrokerEvent getStorageStats() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void setFilterCollationLocale(java.lang.String locale) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If description is null.BrokerInvalidNameException
- If the locale name is invalid.BrokerException
public java.util.Locale getActiveFilterCollationLocale() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If description is null.BrokerInvalidNameException
- If the locale name is invalid.BrokerException
public java.util.Locale getSavedFilterCollationLocale() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If description is null.BrokerInvalidNameException
- If the locale name is invalid.BrokerException
protected java.util.Locale getFilterCollationLocaleInternal(boolean saved) throws BrokerException
BrokerException
public void createBroker(java.lang.String broker_name, java.lang.String description, boolean is_default) throws BrokerException
BrokerExistsException
- If a Broker with the given name already exists.BrokerInvalidBrokerNameException
- If the Broker name is not valid.BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerNullParameterException
- If broker_name or description are is null.BrokerException
public BrokerInfo[] getBrokers() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public java.lang.String getDefaultBrokerName() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void setDefaultBrokerName(java.lang.String broker_name) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access.BrokerUnknownBrokerNameException
- If the Broker does not exist in the server.BrokerException
public void registerConnectionCallback(BrokerServerConnectionCallback obj, java.lang.Object client_data) throws BrokerException
BrokerInvalidClientException
- If the client has been disconnected or destroyed.BrokerException
public boolean startMetaDataBackup() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed or disconnected.BrokerIncompatibleVersionException
- If the Broker does not support changelocks.BrokerException
public void endMetaDataBackup() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed or disconnected.BrokerIncompatibleVersionException
- If the Broker does not support changelocks.BrokerException
public boolean checkMetaDataBackup() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed or disconnected.BrokerIncompatibleVersionException
- If the Broker does not support changelocks.BrokerException
public java.lang.String[] getMetaDataStorageFiles() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed or disconnected.BrokerIncompatibleVersionException
- If the Broker does not support changelocks.BrokerException
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Locale[] getAvailableLocales() throws BrokerException
BrokerException
public int getPublicationProcessingState() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void pausePublishProcessing() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public void resumePublishProcessing() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerException
public COM.activesw.api.client.BrokerAuditLogEntry[] getAuditRecords(java.lang.Integer noRecords, java.lang.Integer AckId, int msecs) throws BrokerException
noRecords
- Number of records to be read from the Audit log. This number must be less than the total number of audit records.AckId
- This is an optional parameter. This is the ID of the last record read.msecs
- The number of milliseconds to wait for a reply from the Broker Server before timing out.BrokerException
BrokerTimeoutException
- If the request was not handled within msecs (No audit log entries in this case)BrokerInvalidClientException
- If the client has been destroyed.BrokerNoPermissionException
- If the client has limited access or has no permission to retrieve the audit records.public void setAuditOperations(short[] ops) throws BrokerException
ops
- Ops is an array of Boolean values to enable/disable the audit operations. Array index - Operation 0 - CONNECTION 1 - SESSION 2 - SERVER
MODIFICATION3 - SERVER SECURITY 4 - SERVER START/STOP 5 - BROKER MODIFICATION 6 - DOCTYPE MODIFICATION 7 - CLIENTGROUP MODIFICATION 8 -
CLIENTGROUP SECURITY 9 - GATEWAY MODIFICATION 10 - TERRITORY MODIFICATION 11 - CLIENT QUEUEBrokerException
BrokerTimeoutException
- If the request was not handled within the default timeout of 30000 milliseconds.BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker Server version is incompatible and does not support the old form of SSL configuration.BrokerNoPermissionException
- If the client has limited access or has no permission to set the audit operations.public void setAuditState(int state) throws BrokerException
state
- Boolean value to enable or disable audit logging.BrokerException
BrokerTimeoutException
- If the request was not handled within the default timeout of 30000 milliseconds.BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker Server version is incompatible and does not support the old form of SSL configuration.BrokerNoPermissionException
- If the client has limited access or has no permission to set the audit state.public int getAuditState() throws BrokerException
BrokerException
BrokerTimeoutException
- If the request was not handled within the default timeout of 30000 milliseconds.BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker Server version is incompatible and does not support the old form of SSL configuration.BrokerNoPermissionException
- If the client has limited access or has no permission to get the audit state.public void setAuditOnErrorState(int state) throws BrokerException
state
- Enable or disable auditing when an error occurs.BrokerException
BrokerTimeoutException
- If the request was not handled within the default timeout of 30000 milliseconds.BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker Server version is incompatible and does not support the old form of SSL configuration.BrokerNoPermissionException
- If the client has limited access or has no permission to set the audit on error state.public int getAuditOnErrorState() throws BrokerException
BrokerException
BrokerTimeoutException
- If the request was not handled within the default timeout of 30000 milliseconds.BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker Server version is incompatible and does not support the old form of SSL configuration.BrokerNoPermissionException
- If the client has limited access or has no permission to get the audit on error state.public short[] getAuditOperations() throws BrokerException
BrokerException
BrokerTimeoutException
- If the request was not handled within the default timeout of 30000 milliseconds.BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker Server version is incompatible and does not support the old form of SSL configuration.BrokerNoPermissionException
- If the client has limited access or has no permission to get the audit operations.public boolean isConnectionUsingSSL() throws BrokerInvalidClientException
BrokerInvalidClientException
public java.lang.String getFipsMode() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker does not support getFipsModeBrokerNoPermissionException
- If the client has limited access.BrokerTimeoutException
- If the request was not handled in a reasonable time.BrokerException
public boolean isStreamingEnabled() throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed.BrokerIncompatibleVersionException
- If the Broker does not support streaming.BrokerNoPermissionException
- If the client has limited access.BrokerTimeoutException
- If the request was not handled in a reasonable time.BrokerException
public BrokerConnectionDescriptor getConnectionDescriptor()
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.