|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.broker.config.proxy.AdministeredObject
com.ibm.broker.config.proxy.BrokerProxy
Each broker within the Config Manager's domain can be represented by a BrokerProxy.
In order to use BrokerProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
ConfigManagerConnectionParameters cmcp = new MQConfigManagerConnectionParameters("localhost", 1414, "QMGR"); ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp); TopologyProxy t = cmp.getTopology(); BrokerProxy b = t.getBrokerByName("BROKER1");
com.ibm.broker.config.proxy.BrokerProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Acts as a container of Execution Groups. Provides the ability to deploy to all execution groups. Provides the ability to control the deployed message flows for all owned execution groups. |
Internal Collaborators | com.ibm.broker.config.proxy.ExecutionGroupProxy |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.7 2004-03-18 HDMPL v6 Release
Nested Class Summary | |
---|---|
static class |
BrokerProxy.MulticastParameterSet
A small data structure that represents the set of parameters required to enable multicast on this broker. |
Method Summary | |
---|---|
void |
cancelDeployment()
Tells the Configuration Manager to cancel any deployment actions to this broker that are currently in progress. |
ExecutionGroupProxy |
createExecutionGroup(String name)
Asks the Config Manager to add an Execution Group of the supplied name to the broker. |
ExecutionGroupProxy |
createExecutionGroup(String name,
int arch)
Asks the Config Manager to add an Execution Group of the supplied name to the broker. |
void |
deleteAllExecutionGroupsAndDeploy()
Deletes all execution groups existing in the broker and deploys this change to the broker. |
DeployResult |
deleteAllExecutionGroupsAndDeploy(long timeToWaitMs)
Deletes all execution groups existing in the broker and deploys this change to the broker. |
void |
deleteExecutionGroup(String name)
Asks the Config Manager to remove the Execution Group with the supplied name from the Broker. |
void |
deploy()
Deploys the broker's configuration to the broker. |
DeployResult |
deploy(long timeToWaitMs)
Deploys the broker's configuration to the broker. |
String |
getAuthenticationProtocols()
Returns the name of the 'Authentication Protocols' attribute associated with this broker. |
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated with this AdministeredObject type. |
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject. |
ExecutionGroupProxy |
getExecutionGroup(Properties props)
Returns the first ExecutiongroupProxy object that matches the filter specified by the Properties argument. |
ExecutionGroupProxy |
getExecutionGroupByName(String executionGroupName)
Returns the ExecutionGroupProxy object with the supplied name, or null if a execution group of that name does not exist or if the supplied argument was null. |
Enumeration |
getExecutionGroups(Properties props)
Returns an enumeration of all the ExecutionGroupProxy objects that match the filter specified by the Properties argument. |
String |
getInterbrokerHost()
Returns the interbroker host associated with this broker. |
int |
getInterbrokerPort()
Returns the interbroker port associated with this broker. |
TopicProxy.QoP |
getISysQualityOfProtectionLevel()
Returns the 'ISys' Quality of Protection level associated with this broker. |
Enumeration |
getMessageSets()
Returns an Enumeration of all the message set names deployed at the broker level. |
BrokerProxy.MulticastParameterSet |
getMulticastParameters()
Returns a data structure that contains all the active multicast properties. |
String |
getQueueManagerName()
Returns the name of the Queue Manager associated with this broker. |
boolean |
getSSLConnectorEnabled()
Returns true if and only if the SSL connector is enabled on the broker. |
String |
getSSLKeyRingFileName()
Returns the name of the SSL Key ring file associated with this broker. |
String |
getSSLPasswordFileName()
Returns the name of the SSL Password file associated with this broker. |
TopicProxy.QoP |
getSysQualityOfProtectionLevel()
Returns the 'Sys' Quality of Protection level associated with this broker. |
TopicProxy.QoP |
getTemporaryTopicQualityOfProtectionLevel()
Returns the Quality of Protection level associated with this broker's temporary topic. |
boolean |
isRunning()
Returns true if the broker is running. |
void |
setAuthenticationProtocols(String authProtocols)
Sets the authentication parameter for the broker. |
void |
setInterbrokerHost(String ibHost)
Sets the interbroker host associated with this broker. |
void |
setInterbrokerPort(int ibPort)
Sets the interbroker port associated with this broker. |
void |
setISysQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Sets the 'ISys' Quality of Protection level for this broker. |
void |
setMulticastParameters(BrokerProxy.MulticastParameterSet newParameterSet)
Modifies the set of Multicast parameters for this broker. |
void |
setQueueManagerName(String newQMgr)
Sets the queue manager name of the broker. |
void |
setSSLConnectorEnabled(boolean isEnabled)
Enables or disables the SSL connector on this broker. |
void |
setSSLKeyRingFileName(String keyRingFile)
Sets the SSL key ring file parameter for the broker. |
void |
setSSLPasswordFileName(String passwordFile)
Sets the SSL password file parameter for the broker. |
void |
setSysQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Sets the 'Sys' Quality of Protection level for this broker. |
void |
setTemporaryTopicQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Sets the Quality of Protection level for this broker's temporary topic. |
void |
setUserTrace(MessageFlowProxy.UserTrace newTrace)
Configures the user trace settings for every execution group under the execution group's control. |
void |
setUUID(String newUUID)
Replaces all occurrences of the broker's UUID in the Configuration Manager repository with the supplied value. |
void |
startMessageFlows()
Asks the Configuration Manager to start all message flows deployed to the broker. |
void |
stopMessageFlows(boolean immediate)
Asks the Configuration Manager to stop all message flows deployed to the broker. |
static Properties |
withName(String name)
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. |
static Properties |
withUUID(String uuid)
Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public void cancelDeployment() throws ConfigManagerProxyLoggedException
Cancelling deployment to a specific broker does not work if the Config Manager Proxy is connected to a v5 Configuration Manager. Use ConfigManagerProxy.cancelDeployment() if this is the case.
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Configuration Manager.public ExecutionGroupProxy createExecutionGroup(String name) throws ConfigManagerProxyLoggedException
Upon processing this action, the Configuration Manager will not have deployed the execution group to the broker. Use either ExecutionGroupProxy.deploy() or BrokerProxy.deploy() to do this.
name
- Name of the new execution group.
ConfigManagerProxyLoggedException
- if the request to create the execution
group could not be sent to the Config Manager.public ExecutionGroupProxy createExecutionGroup(String name, int arch) throws ConfigManagerProxyLoggedException
Upon processing this action, the Configuration Manager will not have deployed the execution group to the broker. Use either ExecutionGroupProxy.deploy() or BrokerProxy.deploy() to do this.
name
- Name of the new execution group.arch
- Desired processor architecture of the new execution group.
If this value is less than or equal to zero, the default architecture is used.
ConfigManagerProxyLoggedException
- if the request to create the execution
group could not be sent to the Config Manager.public void deleteExecutionGroup(String name) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
Asks the Config Manager to remove the Execution Group with the supplied name from the Broker.
A successful return from this method does not necessarily mean that the Group was successfully deleted! This is because the Config Manager will process the request asynchronously.
name
- of the Execution Group to be deleted from
the Broker.
ConfigManagerProxyPropertyNotInitializedException
- if
the name could not be resolved because the broker information
was not supplied by the Configuration Manager.
ConfigManagerProxyLoggedException
- If the request to delete the
Execution Group could not be sent to the Config Manager.public void deleteAllExecutionGroupsAndDeploy() throws ConfigManagerProxyLoggedException
Deletes all execution groups existing in the broker and deploys this change to the broker. This method should only be called as a last resort, for example if the broker is out of step with the Configuration Manager and the only alternative would be to delete the broker. Any active message flows on the broker will be deleted. The method returns as soon as the deploy request is enqueued for sending to the Configuration Manager.
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public DeployResult deleteAllExecutionGroupsAndDeploy(long timeToWaitMs) throws ConfigManagerProxyLoggedException
Deletes all execution groups existing in the broker and deploys this change to the broker. This method should only be called as a last resort, for example if the broker is out of step with the Configuration Manager and the only alternative would be to delete the broker. Any active message flows on the broker will be deleted.
timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public void deploy() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public DeployResult deploy(long timeToWaitMs) throws ConfigManagerProxyLoggedException
timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public String getSSLKeyRingFileName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's keyring filename
was not supplied by the Configuration Manager before
a timeout occurred.public boolean getSSLConnectorEnabled() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's SSL connector state
was not supplied by the Configuration Manager before
a timeout occurred.public String getAuthenticationProtocols() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's authentication protocols
was not supplied by the Configuration Manager before
a timeout occurred.public String getSSLPasswordFileName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's SSL password filename
was not supplied by the Configuration Manager before
a timeout occurred.public String getInterbrokerHost() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's interbroker hostname
was not supplied by the Configuration Manager before
a timeout occurred.public int getInterbrokerPort() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's interbroker port
was not supplied by the Configuration Manager before
a timeout occurred.public TopicProxy.QoP getTemporaryTopicQualityOfProtectionLevel() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's temporary topic QoP level
was not supplied by the Configuration Manager before
a timeout occurred.public TopicProxy.QoP getSysQualityOfProtectionLevel() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's Sys QoP level
was not supplied by the Configuration Manager before
a timeout occurred.public TopicProxy.QoP getISysQualityOfProtectionLevel() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's ISys QoP level
was not supplied by the Configuration Manager before
a timeout occurred.public void setTemporaryTopicQualityOfProtectionLevel(TopicProxy.QoP newQoP) throws ConfigManagerProxyLoggedException
newQoP
- - The new Quality of Protection level (TopicProxy.QoP.none,
TopicProxy.QoP.channelIntegrity, TopicProxy.QoP.messageIntegrity or
TopicProxy.QoP.encrypted).
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager, or if the supplied argument was
TopicProxy.QoP.unknown.public void setSysQualityOfProtectionLevel(TopicProxy.QoP newQoP) throws ConfigManagerProxyLoggedException
newQoP
- The new Quality of Protection level (TopicProxy.QoP.none,
TopicProxy.QoP.channelIntegrity, TopicProxy.QoP.messageIntegrity or
TopicProxy.QoP.encrypted).
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager, or if the supplied argument was
TopicProxy.QoP.unknown.public void setISysQualityOfProtectionLevel(TopicProxy.QoP newQoP) throws ConfigManagerProxyLoggedException
newQoP
- - The new Quality of Protection level (TopicProxy.QoP.none,
TopicProxy.QoP.channelIntegrity, TopicProxy.QoP.messageIntegrity or
TopicProxy.QoP.encrypted).
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager, or if the supplied argument was
TopicProxy.QoP.unknown.public String getQueueManagerName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's queue manager
was not supplied by the Configuration Manager before
a timeout occurred.public void setQueueManagerName(String newQMgr) throws ConfigManagerProxyLoggedException
newQMgr
- - The new queue manager name of the broker.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public void setSSLKeyRingFileName(String keyRingFile) throws ConfigManagerProxyLoggedException
keyRingFile
- - Path name of the key ring file (must point to
a file accessible on the broker machine).
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public void setSSLPasswordFileName(String passwordFile) throws ConfigManagerProxyLoggedException
passwordFile
- - Path name of the password file (must point to
a file accessible on the broker machine).
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public void setSSLConnectorEnabled(boolean isEnabled) throws ConfigManagerProxyLoggedException
isEnabled
- if and only if the value is true, SSL connector will
be enabled at the next broker configuration deploy.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public void setAuthenticationProtocols(String authProtocols) throws ConfigManagerProxyLoggedException
authProtocols
- - The authentication protocols string
Must only contain a combination of characters 'P', 'M', 'R' or 'S'.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.
ConfigManagerProxyLoggedException
- if the supplied
String was invalid.public void setInterbrokerHost(String ibHost) throws ConfigManagerProxyLoggedException
ibHost
- - Interbroker host name associated with
this broker.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public void setInterbrokerPort(int ibPort) throws ConfigManagerProxyLoggedException
ibPort
- - Interbroker port associated with
this broker.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public Enumeration getExecutionGroups(Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the ExecutionGroupProxy objects that match the filter specified by the Properties argument.
props
- - Filter to select which ExecutionGroups to return.
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's execution groups
was not supplied by the Configuration Manager before
a timeout occurred.public ExecutionGroupProxy getExecutionGroup(Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns the first ExecutiongroupProxy object that matches the filter specified by the Properties argument.
props
- Filter to select the executiongroup proxy to return.
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's execution groups
was not supplied by the Configuration Manager before
a timeout occurred.public ExecutionGroupProxy getExecutionGroupByName(String executionGroupName) throws ConfigManagerProxyPropertyNotInitializedException
executionGroupName
-
ConfigManagerProxyPropertyNotInitializedException
- if the list of available execution groups could not be determined
because the Config Manager did not supply the broker
information to the Config Manager Proxy before a timeout occurred.public void startMessageFlows() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
Note: This method simply invokes the startMessageFlows() method for each ExecutionGroupProxy object logically owned by this BrokerProxy. As such, response notifications will be sent to AdministeredObjectListeners of the ExecutionGroupProxy objects and not the BrokerProxy.
ConfigManagerProxyPropertyNotInitializedException
- if information
on the broker's execution groups was not supplied by the
Configuration Manager.
ConfigManagerProxyLoggedException
- if the request to start the
message flows could not be sent to the Config Manager.public void stopMessageFlows(boolean immediate) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
Note: This method simply invokes the stopMessageFlows() method for each ExecutionGroupProxy object logically owned by this BrokerProxy. As such, response notifications will be sent to AdministeredObjectListeners of the ExecutionGroupProxy objects and not the BrokerProxy.
immediate
- True if and only if the 'immediate' flag should be used.
ConfigManagerProxyPropertyNotInitializedException
- if information
on the broker's execution groups is not available.
com.ibm.broker.config.ConfigManagerLoggedException
- if the request to stop the
message flows could not be sent to the Config Manager.
ConfigManagerProxyLoggedException
public void setUserTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
Configures the user trace settings for every execution group under the execution group's control.
newTrace
- One of:
ConfigManagerProxyPropertyNotInitializedException
- if the
list of message flows could not be determined for this execution
group because the information was not supplied by the Configuration
Manager.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
Returns true if the broker is running.
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's run state
was not supplied by the Configuration Manager before
a timeout occurred.public Enumeration getMessageSets() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's message sets
was not supplied by the Configuration Manager before
a timeout occurred.public void setUUID(String newUUID) throws ConfigManagerProxyLoggedException, IllegalArgumentException
This method can be used to attempt to take ownership of an existing broker after a failure of the Configuration Manager repository, possibly after receipt of the message BIP2045. In this case, the UUID parameter supplied to this method must equal the UUID parameter that the broker is expecting (included as an insert on the BIP2045 message). This will then allow subsequent deployment requests to succeed on the existing broker without having to recreate it.
This method is not usually required. It must only be called as a last resort.
A successful processing of the request by the Configuration Manager means that:
As with most other methods in the Config Manager Proxy API, note that a successful processing of the request by the Configuration Manager is not the same as a clean return from this method. A successful completion will result in the following notifications:
If the Config Manager Proxy is connected to a Configuration Manager of version 5 or earlier, this method will have no effect.
newUUID
- String of the form "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
where each x is a hexadecimal digit. For example,
"182684ce-0101-0000-0080-db2fb5787d78"). It is expected
to be the same string as reported by insert '&2' of BIP2045.
ConfigManagerProxyLoggedException
- if the request to set
the UUID could not be sent to the Configuration Manager.
IllegalArgumentException
- if the new UUID was not in the correct
format.public static Properties withUUID(String uuid)
public static Properties withName(String name)
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public BrokerProxy.MulticastParameterSet getMulticastParameters() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's multicast parameters
was not supplied by the Configuration Manager before
a timeout occurred.public void setMulticastParameters(BrokerProxy.MulticastParameterSet newParameterSet) throws ConfigManagerProxyLoggedException, IllegalArgumentException
newParameterSet
- BrokerProxy.MulticastParameterSet
object containing the new set of parameters for
this broker.
ConfigManagerProxyLoggedException
- if the request
to modify the parameters could not be sent to
the Config Manager.
IllegalArgumentException
- if any of the
policed supplied parameters were found to be invalid.
|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |