Package COM.activesw.api.client

Class BrokerCompleteBroker

java.lang.Object

COM.activesw.api.client.BrokerCompleteBroker

public class BrokerCompleteBroker
extends java.lang.Object

Holds all of the information describing a broker as far as import and export are concerned.

Field Summary

Fields

Modifier and Type	Field	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 Summary

Constructors

Constructor	Description
BrokerCompleteBroker()	Constructor.
BrokerCompleteBroker(BrokerInfo info)	Constructor.

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

broker_name

public java.lang.String broker_name

description

public java.lang.String description

is_default

public boolean is_default

clients

public BrokerCompleteClient[] clients

client_groups

public BrokerCompleteClientGroup[] client_groups

event_types

public BrokerCompleteEventType[] event_types

territory

public BrokerCompleteTerritory territory

territory_gateways

public BrokerCompleteTerritoryGateway[] territory_gateways

Constructor Detail

BrokerCompleteBroker

public BrokerCompleteBroker()

Constructor.

BrokerCompleteBroker

public BrokerCompleteBroker(BrokerInfo info)
                     throws BrokerException

Constructor. Sets fields using the BrokerInfo.

Throws:

BrokerNullParameterException - If info is null.

BrokerException

Method Detail

retrieve

public static BrokerCompleteBroker retrieve(BrokerAdminClient client)
                                     throws BrokerException

Retrieves the information about a Broker based on the given client. Does not determine whether it is the default broker on its host.

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.

Throws:

BrokerNullParameterException - If client is null.

BrokerInvalidClientException - If client has been destroyed or disconnected.

BrokerException

deepRetrieve

public static BrokerCompleteBroker deepRetrieve(BrokerAdminClient client)
                                         throws BrokerException

Retrieves the information about a Broker based on the given client. Does not determine whether it is the default broker on its host.

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().

Throws:

BrokerNullParameterException - If client is null.

BrokerInvalidClientException - If client has been destroyed or disconnected.

BrokerException

refresh

public void refresh(BrokerAdminClient client)
             throws BrokerException

Refreshes the information about a Broker based on the given client. Does not determine whether it is the default broker on its host.

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.

Throws:

BrokerNullParameterException - If client is null.

BrokerInvalidClientException - If client has been destroyed or disconnected.

BrokerException

deepRefresh

public void deepRefresh(BrokerAdminClient client)
                 throws BrokerException

Refreshes the information about a Broker based on the given client. Does not determine whether it is the default broker on its host.

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.

Throws:

BrokerNullParameterException - If client is null.

BrokerInvalidClientException - If client has been destroyed or disconnected.

BrokerException

refreshTerritoryAndGateways

public void refreshTerritoryAndGateways(BrokerAdminClient client)
                                 throws BrokerException

Refreshes only information about a Broker's territory and gateways.

Any Territory, or Territory Gateways which no longer exist are removed from this object.

Throws:

BrokerNullParameterException - If client is null.

BrokerInvalidClientException - If client has been destroyed or disconnected.

BrokerException

store

public void store(BrokerAdminClient client)
           throws BrokerException

Stores the information from this object into the Broker for which the given client object has been provided.

The broker name in this object and whether or not it is the default are ignored. Other values may be overwritten or merged.

• If the description is set, it replaces the existing value. created.

Does NOT store the Territory, Territory Gateway, Client Group or Event Type information from this object into the Broker.

If an exception is thrown, nothing is changed.

Throws:

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

deepStore

public void deepStore(BrokerAdminClient client)
               throws BrokerException

Stores the information from this object into the Broker for which the given client object has been provided.

The broker name in this object and whether or not it is the default are ignored. Other values may be overwritten or merged.

• If the description is set, it replaces the existing value.

Also stores the Client Group, Event Type, Territory, and Territory Gateway information from this object following the rules in BrokerCompleteClientGroup.store() and BrokerCompleteEventType.store(). BrokerCompleteTerritory.store(). BrokerCompleteTerritoryGateway.store() .

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.

Throws:

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

write

public void write(java.io.Writer writer,
                  int indent_level)
           throws BrokerException,
                  java.io.IOException

Writes this broker's information out in a textual format. This is usually done to a file. The indent_level is the number of 4 character indents to use.

Unicode characters in the output are escaped using backslash-u notiation (e.g. ӿ).

Does not write anything if broker_name is null.

Throws:

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

toString

public java.lang.String toString(int indent_level)
                          throws BrokerException

Converts this broker's information into a string. The indent_level is the number of 4 character indents to use. The string is in proper format for saving to a file.

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.

Throws:

BrokerOutOfRangeException - If indent_level is less than 0.

BrokerException

toString

public java.lang.String toString()

Converts this broker's information into a string. The string is in proper format for saving to a file.

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.

Overrides:

toString in class java.lang.Object