public class BrokerCompleteTerritoryGateway
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
BrokerAccessControlList |
acl |
BrokerTerritoryGatewayInfo |
info |
java.lang.String[] |
remote_can_publish |
BrokerSubscription[] |
remote_can_subscribe |
Constructor and Description |
---|
BrokerCompleteTerritoryGateway()
Constructor.
|
BrokerCompleteTerritoryGateway(BrokerClusterGatewayInfo clusterGWInfo)
Constructor.
|
BrokerCompleteTerritoryGateway(BrokerTerritoryGatewayInfo info)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
refresh(BrokerAdminClient client)
Refreshes the information about a Territory Gateway based on the given broker admin client.
|
static BrokerCompleteTerritoryGateway |
retrieve(BrokerAdminClient client,
java.lang.String territory_name)
Retrieves the information about a Territory Gateway based on the given broker admin client.
|
void |
store(BrokerAdminClient client)
Stores the information from this Territory Gateway into the broker for which the given client object has been provided.
|
void |
store(BrokerAdminClient client,
boolean clusterGateway) |
java.lang.String |
toString()
Converts this Territory Gateway's information into a string.
|
java.lang.String |
toString(int indent_level)
Converts this Territory Gateway's information into a string.
|
void |
write(java.io.Writer writer,
int indent_level)
Writes this Territory Gateway's information out in a textual format.
|
public BrokerTerritoryGatewayInfo info
public BrokerAccessControlList acl
public java.lang.String[] remote_can_publish
public BrokerSubscription[] remote_can_subscribe
public BrokerCompleteTerritoryGateway()
public BrokerCompleteTerritoryGateway(BrokerTerritoryGatewayInfo info)
public BrokerCompleteTerritoryGateway(BrokerClusterGatewayInfo clusterGWInfo)
public static BrokerCompleteTerritoryGateway retrieve(BrokerAdminClient client, java.lang.String territory_name) throws BrokerException
BrokerNullParameterException
- If client or territory_name are null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerNotInTerritoryException
- If the broker is not a member of a territory.BrokerUnknownTerritoryException
- If there is no gateway to the specified territory from this broker.BrokerException
public void refresh(BrokerAdminClient client) throws BrokerException
BrokerNullParameterException
- If client or info or info.remote_territory_name are null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerNotInTerritoryException
- If the broker is not a member of a territory.BrokerUnknownTerritoryException
- If there is no gateway to the specified territory from this broker.BrokerException
public void store(BrokerAdminClient client) throws BrokerException
Other gateways already configured for the broker are not deleted.
Only the following BrokerTerritoryGatewayInfo members are used during a store: remote_territory_name, remote_host_name, remote_broker_name, auth_type, and encrypt_level.
All specifics about a Territory Gateway are overwritten, except that if a local territory gateway already exists, but connects to a different remote broker and host than those specified, that part of the situation is not altered.
BrokerInvalidAccessListException
- If the access list is not valid.BrokerNullParameterException
- If the client parameter is null or the instance variable info or info.remote_territory_name are null.BrokerInvalidClientException
- If client has been destroyed or disconnected.BrokerOutOfRangeException
- If a gateway already exists between the broker's territory and the remote territory specified in in the 'info' member, but that gateway
was established by either another broker in the broker's territory or, if established through the broker, is connected to a different
broker in the remote territory than that specified in in the 'info' member. Nothing about the gateway will have been altered if this
exception is thrown.BrokerNotRunningException
- If the other side of the gateway doesn't existing yet and shared event types cannot be established. Everything else about the gateway will
have been setup, and so this object needs to be stored again once the other side of the gateway is up.BrokerUnknownBrokerNameException
- If the other side of the gateway doesn't exist yet and the remote broker couldn't be found. Bring up the remote broker and try again.BrokerException
public void store(BrokerAdminClient client, boolean clusterGateway) throws BrokerException
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 'info' or 'info.remote_territory_name' are 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.