public class BrokerCompleteClient
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
BrokerClientInfo |
client_info |
BrokerEvent |
infoset |
boolean |
replace_subscriptions_on_store |
BrokerSubscription[] |
subscriptions |
Constructor and Description |
---|
BrokerCompleteClient()
Constructor.
|
BrokerCompleteClient(BrokerClientInfo info)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
refresh(BrokerAdminClient client)
Refreshes the information about the Client using the given broker admin client.
|
static BrokerCompleteClient |
retrieve(BrokerAdminClient client,
java.lang.String client_id)
Retrieves the information about the specified Client with the given broker admin client.
|
void |
store(BrokerAdminClient client)
Stores the information from this Client into the broker for which the given broker admin client has been provided.
|
java.lang.String |
toString()
Converts this Client's information into a string.
|
java.lang.String |
toString(int indent_level)
Converts this Client's information into a string.
|
void |
write(java.io.Writer writer,
int indent_level)
Writes this Client's information out in a textual format.
|
public BrokerClientInfo client_info
public boolean replace_subscriptions_on_store
public BrokerSubscription[] subscriptions
public BrokerEvent infoset
public BrokerCompleteClient()
public BrokerCompleteClient(BrokerClientInfo info)
public static BrokerCompleteClient retrieve(BrokerAdminClient client, java.lang.String client_id) throws BrokerException
BrokerNullParameterException
- If client or client_id is null.BrokerInvalidClientException
- If broker admin client has been destroyed or disconnected.BrokerNoPermissionException
- If the broker admin client does not have permission to read the specified information.BrokerUnknownClientIdException
- If the client_id does not exist on the broker.BrokerException
public void refresh(BrokerAdminClient client) throws BrokerException
BrokerNullParameterException
- If the client parameter is null or the instance variable client_info or client_info.client_id are null.BrokerInvalidClientException
- If broker admin client has been destroyed or disconnected.BrokerNoPermissionException
- If the broker admin client does not have permission to read the specified information.BrokerUnknownClientIdException
- If the client id does not exist on the broker.BrokerException
public void store(BrokerAdminClient client) throws BrokerException
Nothing will happen within this function if the Client is not a member of a Client Group with an Explicit Destroy lifecycle.
If the Client does not exist the Client is created and initialized with whatever information is set in this object.
If the Client does exist, then some items are overwritten and some are merged.
If any exception is thrown, nothing is changed on the broker.
BrokerNullParameterException
- If the client parameter is null or the instance variable client_info or client_info.client_id are null or the an elements in the
subscription array are null or any event_type_name in any of the subscriptions is null.BrokerInvalidClientException
- If broker admin client has been destroyed or disconnected.BrokerNoPermissionException
- If the broker admin client does not have permission to read the specified information.BrokerUnknownClientIdException
- If the client id does not exist on the broker.BrokerOutOfRangeException
- If any subcription element's sub_id is less than zero, or the state_share_limit is less than -1.BrokerUnknownEventTypeException
- If the event type name listed in one of the subscriptions does not exist on the broker. All other subscriptions are created if this error
occurs.BrokerInvalidSubscriptionException
- If the filter string in any subscription contains a parse error. All other subscriptions are created if this error occurs.BrokerUnknownClientGroupException
- If the client group in client_info.client_group 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_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.