public class BrokerCompleteClientGroup
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
BrokerAccessControlList |
acl |
java.lang.String[] |
can_publish |
java.lang.String[] |
can_subscribe |
BrokerClientGroupInfo |
client_group_info |
boolean |
ignore_change_errors_on_store |
java.lang.String[] |
log_acknowledge |
java.lang.String[] |
log_publish |
boolean |
replace_lists_on_store |
Constructor and Description |
---|
BrokerCompleteClientGroup()
Constructor.
|
BrokerCompleteClientGroup(BrokerClientGroupInfo info)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
refresh(BrokerAdminClient client)
Refreshes the information about the Client Group using the given client.
|
static BrokerCompleteClientGroup |
retrieve(BrokerAdminClient client,
java.lang.String client_group_name)
Retrieves the information about the specified Client Group with the given client.
|
void |
store(BrokerAdminClient client)
Stores the information from this Client Group into the broker for which the given client object has been provided.
|
java.lang.String |
toString()
Converts this Client Group's information into a string.
|
java.lang.String |
toString(int indent_level)
Converts this Client Group's information into a string.
|
void |
write(java.io.Writer writer,
int indent_level)
Writes this Client Group's information out in a textual format.
|
public BrokerClientGroupInfo client_group_info
public boolean ignore_change_errors_on_store
public boolean replace_lists_on_store
public java.lang.String[] can_publish
public java.lang.String[] can_subscribe
public java.lang.String[] log_publish
public java.lang.String[] log_acknowledge
public BrokerAccessControlList acl
public BrokerCompleteClientGroup()
public BrokerCompleteClientGroup(BrokerClientGroupInfo info)
public static BrokerCompleteClientGroup retrieve(BrokerAdminClient client, java.lang.String client_group_name) throws BrokerException
Inability to access the access control list does not cause a permission exception. The value of 'acl' is set to null.
BrokerNullParameterException
- If client or client_group_name is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerNoPermissionException
- If the client does not have permission to read the specified information.BrokerUnknownClientGroupException
- If the client group does not exist on the broker.BrokerException
public void refresh(BrokerAdminClient client) throws BrokerException
Inability to access the access control list does not cause a permission exception. The value of 'acl' is set to null.
BrokerNullParameterException
- If the client parameter is null or the instance variable client_group_info or client_group_info.name are null.BrokerInvalidClientGroupNameException
- If the client group name in client_group_info.name is not valid.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerNoPermissionException
- If the client does not have permission to read the specified information.BrokerUnknownClientGroupException
- If the client group does not exist on the broker.BrokerException
public void store(BrokerAdminClient client) throws BrokerException
If the Client Group does not exist, the Client Group is created and initialized with whatever information is set in this object.
If the Client Group does exist, then some items are overwritten and some are merged.
If the client group is system-defined, any attempt to change the life cycle, storage type, or description will generate an error unless 'ignore_change_errors_on_store' is true.
If any exception is thrown, nothing is changed on the broker.
BrokerInvalidAccessListException
- If the access list is not valid.BrokerNullParameterException
- If the client parameter is null or the instance variable client_group_info or client_group_info.name are null.BrokerInvalidClientGroupNameException
- If the client group name in client_group_info.name is not valid.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerNoPermissionException
- If the client does not have permission to change the specified information.BrokerOutOfRangeException
- If the life cycle, storage type, or required encryption level are not valid values.BrokerUnknownEventTypeException
- If an event type in the can_publish or can_subscribe lists does not exist on the broker.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 'client_group_info' 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.