public class BrokerCompleteServer
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
BrokerAccessControlList |
acl |
BrokerCompleteBroker[] |
brokers |
java.lang.String |
description |
java.lang.String |
host_name |
java.lang.String |
license_key |
BrokerLogConfig |
log_config |
int |
port |
BrokerSSLConfig |
ssl_config |
BrokerSSLConfigV2 |
ssl_config_v2 |
java.lang.String |
version |
Constructor and Description |
---|
BrokerCompleteServer()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
deepRefresh(BrokerServerClient client,
java.lang.String client_id,
java.lang.String client_group,
java.lang.String app_name,
BrokerConnectionDescriptor desc)
Refreshes the information about a Broker server based on the given client.
|
static BrokerCompleteServer |
deepRetrieve(BrokerServerClient client,
java.lang.String client_id,
java.lang.String client_group,
java.lang.String app_name,
BrokerConnectionDescriptor desc)
Retrieves all the information about a Broker server and creates an object.
|
void |
refresh(BrokerServerClient client)
Refreshes the information about a Broker server based on the given client.
|
static BrokerCompleteServer |
retrieve(BrokerServerClient client)
Retrieves the information about a Broker Server and creates an object.
|
void |
store(BrokerServerClient client)
Stores the information from this object into the server for which the given client object has been provided.
|
java.lang.String |
toString()
Converts this server's information into a string.
|
java.lang.String |
toString(int indent_level)
Converts this server's information into a string.
|
void |
write(java.io.Writer writer,
int indent_level)
Writes this server's information out in a textual format.
|
public java.lang.String host_name
public java.lang.String description
public int port
public java.lang.String license_key
public BrokerLogConfig log_config
public BrokerSSLConfig ssl_config
public BrokerSSLConfigV2 ssl_config_v2
public BrokerAccessControlList acl
public BrokerCompleteBroker[] brokers
public java.lang.String version
public static BrokerCompleteServer retrieve(BrokerServerClient client) throws BrokerException
Any server information which the client does not have permission to read is set to null.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public static BrokerCompleteServer deepRetrieve(BrokerServerClient client, java.lang.String client_id, java.lang.String client_group, java.lang.String app_name, BrokerConnectionDescriptor desc) throws BrokerException
The client_id, client_group, app_name, and desc are used in establishing connections to the individual brokers. See the constructor for BrokerAdminClient.
Any server information which the client does not have permission to read is set to null.
BrokerNullParameterException
- If client, client_group, or app_name are null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void refresh(BrokerServerClient client) throws BrokerException
Any server information which the client does not have permission to read is set to null.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void deepRefresh(BrokerServerClient client, java.lang.String client_id, java.lang.String client_group, java.lang.String app_name, BrokerConnectionDescriptor desc) throws BrokerException
Rebuilds the 'brokers' array in this object. If any Broker no longer exists or if the client does not have permission to access a Broker, that Broker will not be found in the new 'brokers' array. The information refreshed within each broker follows the rules in BrokerCompleteBroker.deepRefresh().
The client_id, client_group, app_name, and desc are used in establishing connections to the individual brokers. See the constructor for BrokerAdminClient.
Any server information which the client does not have permission to read is set to null.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void store(BrokerServerClient client) throws BrokerException
The host name in this object is ignored. Other values may be overwritten or merged.
If an exception is thrown, nothing is changed.
BrokerInvalidClientException
- If the client is null or has been destroyed.BrokerNoPermissionException
- If the client does not have permission to change the specified information.BrokerException
public void write(java.io.Writer writer, int indent_level) throws BrokerException, java.io.IOException
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).
Does not write anything if host_name is null.
java.io.IOException
- If there is an error wrtiting to the file.BrokerNullParameterException
- If writer is null.BrokerOutOfRangeException
- If indent_level is less than 0.BrokerException
public java.lang.String toString(int indent_level) throws BrokerException
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).
Returns an empty string if all of the data members are null, or if all of them return empty strings when converted to strings.
BrokerOutOfRangeException
- If indent_level is less than 0.BrokerException
public java.lang.String toString()
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).
Returns an empty string if all of the data members are null, or if all of them return empty strings when converted to strings.
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.