public class BrokerCompleteBroker
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
java.lang.String |
broker_name |
BrokerCompleteClientGroup[] |
client_groups |
BrokerCompleteClient[] |
clients |
java.lang.String |
description |
BrokerCompleteEventType[] |
event_types |
boolean |
is_default |
BrokerCompleteTerritory |
territory |
BrokerCompleteTerritoryGateway[] |
territory_gateways |
Constructor and Description |
---|
BrokerCompleteBroker()
Constructor.
|
BrokerCompleteBroker(BrokerInfo info)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
deepRefresh(BrokerAdminClient client)
Refreshes the information about a Broker based on the given client.
|
static BrokerCompleteBroker |
deepRetrieve(BrokerAdminClient client)
Retrieves the information about a Broker based on the given client.
|
void |
deepStore(BrokerAdminClient client)
Stores the information from this object into the Broker for which the given client object has been provided.
|
void |
refresh(BrokerAdminClient client)
Refreshes the information about a Broker based on the given client.
|
void |
refreshTerritoryAndGateways(BrokerAdminClient client)
Refreshes only information about a Broker's territory and gateways.
|
static BrokerCompleteBroker |
retrieve(BrokerAdminClient client)
Retrieves the information about a Broker based on the given client.
|
void |
store(BrokerAdminClient client)
Stores the information from this object into the Broker for which the given client object has been provided.
|
java.lang.String |
toString()
Converts this broker's information into a string.
|
java.lang.String |
toString(int indent_level)
Converts this broker's information into a string.
|
void |
write(java.io.Writer writer,
int indent_level)
Writes this broker's information out in a textual format.
|
public java.lang.String broker_name
public java.lang.String description
public boolean is_default
public BrokerCompleteClient[] clients
public BrokerCompleteClientGroup[] client_groups
public BrokerCompleteEventType[] event_types
public BrokerCompleteTerritory territory
public BrokerCompleteTerritoryGateway[] territory_gateways
public BrokerCompleteBroker()
public BrokerCompleteBroker(BrokerInfo info) throws BrokerException
BrokerNullParameterException
- If info is null.BrokerException
public static BrokerCompleteBroker retrieve(BrokerAdminClient client) throws BrokerException
The default broker status is determined from the broker's host if this BrokerCompleteBroker instance was created by a BrokerCompleteServer or BrokerCompleteCollection method.
Does NOT retrieve any information about Client Groups, Event Types, Territories, or Territory Gateways.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public static BrokerCompleteBroker deepRetrieve(BrokerAdminClient client) throws BrokerException
The default broker status is determined from the broker's host if this BrokerCompleteBroker instance was created by a BrokerCompleteServer or BrokerCompleteCollection method.
Retrieves the information about Client Groups, Event Types, Territories, and Territory Gateways as defined by BrokerCompleteClientGroup.retrieve() and BrokerCompleteEventType.retrieve(). BrokerCompleteTerritory.retrieve(). BrokerCompleteTerritoryGateway. retrieve().
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void refresh(BrokerAdminClient client) throws BrokerException
The default broker status is determined from the broker's host if this BrokerCompleteBroker instance was created by a BrokerCompleteServer or BrokerCompleteCollection method.
Does NOT refresh any information about Client Groups, Event Types, Territories, or Territory Gateways.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void deepRefresh(BrokerAdminClient client) throws BrokerException
The default broker status is determined from the broker's host if this BrokerCompleteBroker instance was created by a BrokerCompleteServer or BrokerCompleteCollection method.
Refreshes the information about Client Groups, Event Types, Territories, and Territory Gateways as defined by BrokerCompleteClientGroup.refresh() and BrokerCompleteEventType.refresh(). BrokerCompleteTerritoryGateway.refresh().
Any Client Groups, Event Types, Territory, or Territory Gateways which no longer exist, or for which this client does not have permission to read are removed from this object.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void refreshTerritoryAndGateways(BrokerAdminClient client) throws BrokerException
Any Territory, or Territory Gateways which no longer exist are removed from this object.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerException
public void store(BrokerAdminClient client) throws BrokerException
The broker name in this object and whether or not it is the default are ignored. Other values may be overwritten or merged.
If an exception is thrown, nothing is changed.
BrokerNullParameterException
- If client is null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerNoPermissionException
- If the client does not have permission to change the specified information.BrokerException
public void deepStore(BrokerAdminClient client) throws BrokerException
The broker name in this object and whether or not it is the default are ignored. Other values may be overwritten or merged.
After the Client Groups and Event Types are stored, the Broker will create a Territory or join one if the territory member is set. If the territory_gateway member is non-null a territory gateway will be created.
If an exception is thrown, nothing is changed.
BrokerInvalidAccessListException
- If the access list is not valid.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerInvalidClientGroupNameException
- If a client group has an invalid name.BrokerInvalidEventTypeNameException
- If an invalid event type name is specified to be created.BrokerNoPermissionException
- If the client does not have permission to change the specified information.BrokerNullParameterException
- If client is null, or if any BrokerCompleteEventType's type_def field is null, or if any BrokerCompleteClientGroup's client_group_info
field is null, of if any client_group_info's name is null.BrokerOutOfRangeException
- If a client group contains an invalid value for its life cycle or storage type.BrokerUnknownEventTypeException
- If a client group contains a "can publish" or "can subscribe" list with an event type which 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 broker_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.