|
|||||||||
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
public class BrokerProxy
Each broker within the Configuration 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 45112.7 2007-07-30 HDMPL v6.1 release: Methods now return genericized types where relevant Added setRuntimeProperty(String, String) Added getRuntimeProperty(String) Added getRuntimePropertyNames() Added setHTTPListenerProperty(String, String) Added getHTTPListenerProperty(String) Added getHTTPListenerPropertyNames() Added setConfigurableServiceProperty(String, String) Added getConfigurableServiceProperty(String) Added getConfigurableServicePropertyNames() Added getLastDiscoveryTime(SyncType) Deprecated getters and setters that can be controlled as runtime properties Added getQueues() Added getNodeTypes() Added discoverConfiguration() Added getPolicySet(String) Added getPolicySetBinding(String) Added getPolicySetBindingNames() Added getPolicySetNames()
Nested Class Summary | |
---|---|
static class |
BrokerProxy.MulticastParameterSet
Deprecated. This technique of changing multicast parameters is not compatible with values changed using the mqsichangeproperties command; use ExecutionGroupProxy.setRuntimeProperties() and BrokerProxy.setRuntimeProperties() instead. |
static class |
BrokerProxy.SyncType
Enumerates the possible types of synchronization that the Configuration Manager can perform with the broker. |
Method Summary | |
---|---|
void |
addAccessControlEntries(AccessControlEntry[] accessControlList)
Adds this list to the list of access control entries that applies to this object. |
void |
cancelDeployment()
Tells the Configuration Manager to remove any deployment lock that may currently be in place for the current broker. |
DeployResult |
cancelDeployment(long timeToWaitMs)
Tells the Configuration Manager to remove any deployment lock that may currently be in place for the current broker. |
ExecutionGroupProxy |
createExecutionGroup(java.lang.String name)
Asks the Configuration Manager to add an Execution Group of the supplied name to the broker. |
ExecutionGroupProxy |
createExecutionGroup(java.lang.String name,
int arch)
Asks the Configuration Manager to add an Execution Group of the supplied name and architecture to the broker. |
SubscriptionQuery |
createSubscriptionQuery()
Create a SubscriptionQuery object that can be used to query this
brokers subscriptions. |
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(java.lang.String name)
Asks the Configuration Manager to remove the execution group with the supplied name from the broker. |
DeployResult |
deleteExecutionGroup(java.lang.String name,
long timeToWaitMs)
Asks the Configuration 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. |
void |
discoverConfiguration()
Asks the Configuration Manager to replace the information that it holds regarding a broker and its configuration with information provided by the broker itself. |
void |
forceSubscribe()
Asks the Configuration Manager to (re)subscribe itself to the broker's status topics. |
AccessControlEntry[] |
getAccessControlEntries()
Creates and returns a set of AccessControlEntry objects that describes the set of (principal,permission) tuples that have been applied specifically to this object. |
java.lang.String |
getAuthenticationProtocols()
Deprecated. Use getRuntimeProperty(RuntimePropertyConstants.NAME_BROKERAUTHPROTOCOLS) instead. |
java.lang.String |
getConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName)
Returns the value of the configurable service runtime property with the supplied name. |
java.lang.String[] |
getConfigurableServicePropertyNames()
Returns a string array of all runtime configurable service properties associated with this object. |
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(java.util.Properties props)
Returns the first ExecutiongroupProxy object that matches the filter specified by the Properties argument. |
ExecutionGroupProxy |
getExecutionGroupByName(java.lang.String executionGroupName)
Returns the ExecutionGroupProxy object with the supplied name, or null if an execution group of that name does not exist or if the supplied argument was null. |
java.util.Enumeration<ExecutionGroupProxy> |
getExecutionGroups(java.util.Properties props)
Returns an enumeration of all the ExecutionGroupProxy objects that match the filter specified by the Properties argument. |
java.lang.String |
getHTTPListenerProperty(java.lang.String objectAndpropertyName)
Returns the value of the HTTP listener runtime property with the supplied name. |
java.lang.String[] |
getHTTPListenerPropertyNames()
Returns a string array of all runtime HTTPListener properties associated with this object. |
java.lang.String |
getInterbrokerHost()
Deprecated. Use BrokerProxy.getRuntimeProperty(RuntimePropertyConstants.NAME_INTERBROKERHOST, ...) instead. |
int |
getInterbrokerPort()
Deprecated. Use BrokerProxy.getRuntimeProperty(RuntimePropertyConstants.NAME_INTERBROKERPORT, ...) instead. |
TopicProxy.QoP |
getISysQualityOfProtectionLevel()
Deprecated. Use BrokerProxy.getRuntimeProperty(RuntimePropertyConstants.NAME_ISYSQOPLEVEL, ...) instead. |
java.util.Date |
getLastDiscoveryTime(BrokerProxy.SyncType syncType)
Returns the time that the Configuration Manager last discovered the configuration held by the broker. |
BrokerProxy.MulticastParameterSet |
getMulticastParameters()
Deprecated. This method will not reflect any values changed changed using the mqsichangeproperties command; use ExecutionGroupProxy.getRuntimeProperty() instead. |
java.lang.String[] |
getNodeTypes()
Returns a list of the types of nodes used in this broker. |
java.io.InputStream |
getPolicySet(java.lang.String policySet)
Asks the broker to return the contents of a policy set with the supplied name. |
java.io.InputStream |
getPolicySetBinding(java.lang.String policySetBinding)
Asks the broker to return the contents of a policy set binding with the supplied name. |
java.lang.String[] |
getPolicySetBindingNames()
Asks the broker to return the names of the policy set bindings deployed on the broker. |
java.lang.String[] |
getPolicySetNames()
Asks the broker to return the names of the policy sets deployed on the broker. |
java.lang.String |
getQueueManagerName()
Returns the name of the Queue Manager associated with this broker. |
java.lang.String[] |
getQueues()
Returns a list of the MQ queues referenced by the message flows in use by this broker. |
java.lang.String |
getRuntimeProperty(java.lang.String objectAndpropertyName)
Returns the value of the runtime property with the supplied name. |
java.lang.String[] |
getRuntimePropertyNames()
Returns a string array of all basic runtime properties associated with this object. |
boolean |
getSSLConnectorEnabled()
Returns true if and only if the SSL connector is enabled on the broker. |
java.lang.String |
getSSLKeyRingFileName()
Returns the name of the SSL Key ring file associated with this broker. |
java.lang.String |
getSSLPasswordFileName()
Returns the name of the SSL Password file associated with this broker. |
TopicProxy.QoP |
getSysQualityOfProtectionLevel()
Deprecated. Use BrokerProxy.getRuntimeProperty(RuntimePropertyConstants.NAME_SYSQOPLEVEL, ...) instead. |
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 |
removeAccessControlEntries(AccessControlEntry[] accessControlList)
Deletes this list from the list of access control entries that applies to this object. |
void |
setAccessControlEntries(AccessControlEntry[] accessControlList)
Sets the complete list of access control entries that apply to this object. |
void |
setAuthenticationProtocols(java.lang.String authProtocols)
Sets the authentication parameter for the broker. |
void |
setConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName,
java.lang.String propertyValue)
Asks the Configuration Manager to configure an arbitrary broker-wide configurable service property. |
void |
setHTTPListenerProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the Configuration Manager to configure an arbitrary property on the broker's HTTP listener component. |
void |
setInterbrokerHost(java.lang.String ibHost)
Deprecated. Use BrokerProxy.setRuntimeProperty(RuntimePropertyConstants.NAME_INTERBROKERHOST, ibHost) instead. |
void |
setInterbrokerPort(int ibPort)
Deprecated. Use BrokerProxy.setRuntimeProperty(RuntimePropertyConstants.NAME_INTERBROKERPORT, ibPort) instead. |
void |
setISysQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Deprecated. Use BrokerProxy.setRuntimeProperty(RuntimePropertyConstants.NAME_ISYSQOPLEVEL, newQoP) instead. |
void |
setMulticastParameters(BrokerProxy.MulticastParameterSet newParameterSet)
Deprecated. This method is not compatible with values changed using the mqsichangeproperties command; use ExecutionGroupProxy.setRuntimeProperties() instead. |
void |
setPolicySet(java.lang.String policySet,
java.io.InputStream policySetContents)
Asks the broker to save a policy set with the supplied contents. |
void |
setPolicySetBinding(java.lang.String policySetBinding,
java.io.InputStream policySetBindingContents)
Asks the broker to save policy set binding information with the supplied contents. |
void |
setQueueManagerName(java.lang.String newQMgr)
Sets the queue manager name of the broker. |
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the Configuration Manager to configure an arbitrary broker-wide property. |
void |
setSSLConnectorEnabled(boolean isEnabled)
Enables or disables the SSL connector on this broker. |
void |
setSSLKeyRingFileName(java.lang.String keyRingFile)
Sets the SSL key ring file parameter for the broker. |
void |
setSSLPasswordFileName(java.lang.String passwordFile)
Sets the SSL password file parameter for the broker. |
void |
setSysQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Deprecated. Use BrokerProxy.setRuntimeProperty(RuntimePropertyConstants.NAME_SYSQOPLEVEL, newQoP) instead. |
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(java.lang.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 java.util.Properties |
withName(java.lang.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 java.util.Properties |
withUUID(java.lang.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 DeployResult cancelDeployment(long timeToWaitMs) throws ConfigManagerProxyLoggedException
The Configuration Manager will attempt to recall any unprocessed deployment messages from the broker's SYSTEM.BROKER.ADMIN.QUEUE, but this can only succeed if the broker is on the same queue manager as the Configuration Manager. Usually, the Configuration Manager cannot recall deployment messages that have been sent to the broker, and so it is essential that, after cancelling deployment, any unprocessed deployment messages are manually removed from the broker's SYSTEM.BROKER.ADMIN.QUEUE queue. If this is not done, and a broker subsequently processes a deployment message that was cancelled, the Configuration Manager may become out of sync with the broker.
Only use this method if you are sure that any outstanding deployment message will never be processed by the broker to which it is addressed.
Cancelling deployment to a specific broker does not work if the Configuration Manager Proxy is connected to a v5 Configuration Manager. Use ConfigManagerProxy.cancelDeployment() if this is the case.
timeToWaitMs
- A positive value describes the
maximum length of time to wait for a response from
the Configuration Manager (in milliseconds) before returning
the DeployResult. Alternatively:
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Configuration Manager.public void cancelDeployment() throws ConfigManagerProxyLoggedException
The Configuration Manager will attempt to recall any unprocessed deployment messages from the broker's SYSTEM.BROKER.ADMIN.QUEUE, but this can only succeed if the broker is on the same queue manager as the Configuration Manager. Usually, the Configuration Manager cannot recall deployment messages that have been sent to the broker, and so it is essential that, after cancelling deployment, any unprocessed deployment messages are manually removed from the broker's SYSTEM.BROKER.ADMIN.QUEUE queue. If this is not done, and a broker subsequently processes a deployment message that was cancelled, the Configuration Manager may become temporarily or permanently out of sync with the broker.
Only use this method if you are sure that any outstanding deployment message will never be processed by the broker to which it is addressed.
Cancelling deployment to a specific broker does not work if the Configuration 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(java.lang.String name) throws ConfigManagerProxyLoggedException
Upon processing this action, the Configuration Manager will not have deployed the execution group to the broker. Use ExecutionGroupProxy.deploy() to do this.
If an execution group already exists with the supplied name, the existing execution group is returned.
name
- Name of the new execution group.
ConfigManagerProxyLoggedException
- if the request to create the execution
group could not be sent to the Configuration Manager.public ExecutionGroupProxy createExecutionGroup(java.lang.String name, int arch) throws ConfigManagerProxyLoggedException
Upon processing this action, the Configuration Manager will not have deployed the execution group to the broker. Use ExecutionGroupProxy.deploy() to do this.
If an execution group already exists with the supplied name, the existing execution group is returned.
name
- Name of the new execution group.arch
- Desired processor architecture of the new execution group.
Valid values are AttributeConstants.EG_PROCESSOR_ARCHITECTURE_32BIT (to create a
32-bit execution group) and AttributeConstants.EG_PROCESSOR_ARCHITECTURE_64BIT
(to create a 64-bit execution group).
If the target broker is of a version earlier than V6 FixPack 01, the execution group must be 32-bit. If the Configuration Manager to which this Configuration Manager Proxy is connected is of a version earlier than V6 FixPack 01, the the architecture property will be ignored and the execution group will be created as 32-bit.
ConfigManagerProxyLoggedException
- if the request to create the execution
group could not be sent to the Configuration Manager.public void deleteExecutionGroup(java.lang.String name) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
Asks the Configuration Manager to remove the execution group with the supplied name from the broker. The method returns as soon as the deletion request has been enqueued for sending to the Configuration Manager.
Once it has been processed by the Configuration Manager, if the request is successful any resources used by the execution group will be removed and the execution group will no longer appear in the output of mqsilist for that broker. If the execution group had never been successfully deployed to the broker, the execution group reference is simply removed from the Configuration Manager's repository.
If the execution group being deleted is being used as the broker's default execution group (denoted by defaultExecutionGroup 'true' on the execution group BIP2201 start message), note that the broker will not completely remove the execution group until the broker is restarted.
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 Configuration Manager.public DeployResult deleteExecutionGroup(java.lang.String name, long timeToWaitMs) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
Asks the Configuration Manager to remove the execution group with the supplied name from the broker.
If the request is successful, any resources used by the execution group will be removed and the execution group will no longer appear in the output of mqsilist for that broker. If the execution group had never been successfully deployed to the broker, the execution group reference is simply removed from the Configuration Manager's repository.
If the execution group being deleted is being used as the broker's default execution group (denoted by defaultExecutionGroup 'true' on the execution group BIP2201 start message), note that the broker will not completely remove the execution group until the broker is restarted.
name
- of the execution group to be deleted.timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult, if
applicable. Alternatively:
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 Configuration 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 Configuration 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 Configuration Manager.public void deploy() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Configuration 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 Configuration Manager.public java.lang.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 java.lang.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 java.lang.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 java.lang.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 Configuration 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 Configuration 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 Configuration Manager, or if the supplied argument was
TopicProxy.QoP.unknown.public java.lang.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(java.lang.String newQMgr) throws ConfigManagerProxyLoggedException
newQMgr
- - The new queue manager name of the broker.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.public void setSSLKeyRingFileName(java.lang.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 Configuration Manager.public void setSSLPasswordFileName(java.lang.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 Configuration 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 Configuration Manager.public void setAuthenticationProtocols(java.lang.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 Configuration Manager.
ConfigManagerProxyLoggedException
- if the supplied
String was invalid.public void setInterbrokerHost(java.lang.String ibHost) throws ConfigManagerProxyLoggedException
ibHost
- - Interbroker host name associated with
this broker.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration 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 Configuration Manager.public java.lang.String[] getConfigurableServicePropertyNames()
public java.lang.String[] getHTTPListenerPropertyNames()
public java.lang.String[] getRuntimePropertyNames()
public java.util.Enumeration<ExecutionGroupProxy> getExecutionGroups(java.util.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 the ExecutionGroupProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all execution groups of this
broker.
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's execution groups
was not supplied by the Configuration Manager before
a timeout occurred.public ExecutionGroupProxy getExecutionGroup(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns the first ExecutiongroupProxy object that matches the filter specified by the Properties argument. This method is an ExecutionGroupProxy-specific wrapper to AdministeredObject.getManagedSubcomponent(Properties). Consider using getExecutionGroupByName(String) to return a execution group by name.
props
- Filter to select the ExecutionGroupProxy to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all execution groups of this
broker.
ConfigManagerProxyPropertyNotInitializedException
- if information on this broker's execution groups
was not supplied by the Configuration Manager before
a timeout occurred.AdministeredObject.getManagedSubcomponent()
public ExecutionGroupProxy getExecutionGroupByName(java.lang.String executionGroupName) throws ConfigManagerProxyPropertyNotInitializedException
executionGroupName
- Name of the execution group
ConfigManagerProxyPropertyNotInitializedException
- if the list of available execution groups could not be determined
because the Configuration Manager did not supply the broker
information to the Configuration 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 Configuration 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.
ConfigManagerProxyLoggedException
- if the request to stop the
message flows could not be sent to the Configuration Manager.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 Configuration 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 void forceSubscribe() throws ConfigManagerProxyLoggedException
It is not usually necessary to call this method. The Configuration Manager will automatically attempt to subscribe to the status topics as required.
This method will have no effect if the connected Configuration Manager is of a version earlier than v6.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.public void setUUID(java.lang.String newUUID) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
If you would like the Configuration Manager to take ownership of a broker that was previously owned by another Configuration Manager, use TopologyProxy.adoptBroker() instead.
This method can be used to attempt to resolve problems with a Configuration Manager's broker definition 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.
A successful processing of the request by the Configuration Manager means that:
As with most other methods in the Configuration 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 Configuration 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.
java.lang.IllegalArgumentException
- if the new UUID was not in the correct
format.public static java.util.Properties withUUID(java.lang.String uuid)
public static java.util.Properties withName(java.lang.String name)
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.util.Date getLastDiscoveryTime(BrokerProxy.SyncType syncType)
syncType
- The type of synchronization that was performed:
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, java.lang.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 Configuration Manager.
java.lang.IllegalArgumentException
- if any of the
policed supplied parameters were found to be invalid.public AccessControlEntry[] getAccessControlEntries()
This method does not return details of permissions that have been implicitly granted by inherited access control entries.
ConfigManagerProxyPropertyNotInitializedException
- if this objects list of Access Control Entries was not supplied by the
Configuration Manager before a timeout occurred.public void setAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
This method submits only changed access control entries to the Configuration Manager. It converts the supplied array into a set of access control entries to add and a set of access control entries to remove, based on the information currently supplied from the Configuration Manager. The add and remove operations are processed separately by the Configuration Manager as two atomic, transactional requests.
If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.
accessControlList
- Array of access control entries which are to apply to this
object.
ConfigManagerProxyLoggedException
- if the request to update the object could
not be sent to the Configuration Manager.
ConfigManagerProxyPropertyNotInitializedException
- if this objects current list of Access Control Entries was not supplied by the
Configuration Manager before a timeout occurred.public void addAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
This operation is completely transactional. If the Configuration Manager successfully processes this request, all access control entries from the supplied array will be associated with this administered object. If not, the access control list for this object will have not been modified.
If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.
accessControlList
- Array of access control entries which are to be added to this
object.
ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request to update the object could
not be sent to the Configuration Manager.public void removeAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
This operation is completely transactional. If the Configuration Manager successfully processes this request, no access control entries from the supplied array will be associated with this administered object. If not, the access control list for this object will have not been modified.
If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.
accessControlList
- Array of access control entries which are to be removed from this
object.
ConfigManagerProxyLoggedException
- if the request to update the object could
not be sent to the Configuration Manager.public SubscriptionQuery createSubscriptionQuery()
SubscriptionQuery
object that can be used to query this
brokers subscriptions.
SubscriptionQuery
query object for this brokerpublic void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException
To set runtime properties that affect an execution group, use ExecutionGroupProxy.setRuntimeProperty(). To set runtime properties that affect the HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a configurable service, use BrokerProxy.setConfigurableServiceProperty().
After calling this method, BrokerProxy.deploy() needs to be called in order to deploy the changed configuration to the broker. It is possible to change multiple runtime properties and invoke the deployment just once at the end.
Constants exist for many common objectAndPropertyName values in the RuntimePropertyConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the objectAndPropertyName parameter can also be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters* of mqsichangeproperties. For example, "DynamicSubscriptionEngine/interbrokerPort" would request a change to the interbroker port property. The '/' separator is defined as RuntimePropertyConstants.OBJECT_NAME_DELIMITER.
The list of currently defined property names can be obtained using the method getRuntimePropertyNames(). However, not all runtime properties returned by this method can be set.
objectAndPropertyName
- The complete object and property name of the
property being manipulatedpropertyValue
- The new value to associate with the property
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.public void setConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException
To set runtime properties that affect an execution group, use ExecutionGroupProxy.setRuntimeProperty(). To set runtime properties that affect the HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set other runtime properties, use BrokerProxy.setRuntimeProperty().
After calling this method, BrokerProxy.deploy() needs to be called in order to deploy the changed configuration to the broker. It is possible to change multiple runtime properties and invoke the deployment just once at the end.
Constants exist for many common property names in the RuntimePropertyConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the serviceObjectAndPropertyName parameter can also be made up of a String of the form "ConfigurableServiceName/ObjectName/PropertyName", where ConfigurableServiceName, ObjectName and PropertyName are the configurable service, object and property names supplied on the -c, -o and -n parameters respectively of mqsichangeproperties. For example, "JDBCProviders/DB2/account" would request a change to the 'JDBCProviders' service, 'DB2' object, 'account' property. The '/' separator is defined as RuntimePropertyConstants.OBJECT_NAME_DELIMITER.
The list of currently defined property names can be obtained using the method getConfigurableServicePropertyNames(). However, not all property names returned by this method can be set.
serviceObjectAndPropertyName
- The complete name of the property being manipulatedpropertyValue
- The new value to associate with the property
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.public void setHTTPListenerProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException
To set runtime properties that affect an execution group, use ExecutionGroupProxy.setRuntimeProperty(). To set runtime properties that affect a configurable service, use BrokerProxy.setConfigurableServiceProperty(). To set other runtime properties, use BrokerProxy.setRuntimeProperty().
After calling this method, BrokerProxy.deploy() needs to be called in order to deploy the changed configuration to the broker. It is possible to change multiple runtime properties and invoke the deployment just once at the end.
Constants exist for many common objectAndPropertyName values in the RuntimePropertyConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the objectAndPropertyName parameter can also be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters* of mqsichangeproperties. For example, "HTTPSConnector/port" would request a change to the HTTPS port property. The '/' separator is defined as RuntimePropertyConstants.OBJECT_NAME_DELIMITER.
The list of currently defined property names can be obtained using the method getHTTPListenerPropertyNames(). However, not all runtime properties returned by this method can be set.
objectAndPropertyName
- The complete object and property name of the
property being manipulatedpropertyValue
- The new value to associate with the property
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.public java.lang.String getRuntimeProperty(java.lang.String objectAndpropertyName) throws ConfigManagerProxyPropertyNotInitializedException
If you wish to directly look up a specific named property, use constants defined in the RuntimePropertyConstants interface wherever possible. If a constant does not exist, the objectAndpropertyName parameter can be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters respectively of mqsireportproperties. The '/' separator is defined as RuntimePropertyConstants.OBJECT_NAME_DELIMITER.
objectAndpropertyName
- The name of the property to be reported
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied it.public java.lang.String getConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException
If you wish to directly look up a specific named property, use constants defined in the RuntimePropertyConstants interface wherever possible. If a constant does not exist, the serviceObjectAndPropertyName parameter can be made up of a String of the form "ServiceName/ObjectName/PropertyName", where ServiceName, ObjectName and PropertyName are the configurable service, object and property names supplied on the -c, -o and -n parameters respectively of mqsireportproperties. The '/' separator is defined as RuntimePropertyConstants.OBJECT_NAME_DELIMITER.
serviceObjectAndPropertyName
- The complete name of the property to be reported
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied it.public java.lang.String getHTTPListenerProperty(java.lang.String objectAndpropertyName) throws ConfigManagerProxyPropertyNotInitializedException
If you wish to directly look up a specific named property, use constants defined in the RuntimePropertyConstants interface wherever possible. If a constant does not exist, the objectAndpropertyName parameter can be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters respectively of mqsireportproperties. The '/' separator is defined as RuntimePropertyConstants.OBJECT_NAME_DELIMITER.
objectAndpropertyName
- The name of the property to be reported
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied it.public void setPolicySet(java.lang.String policySet, java.io.InputStream policySetContents) throws ConfigManagerProxyLoggedException, java.io.IOException
After calling this method, BrokerProxy.deploy() needs to be called in order to deploy the changed configuration to the broker. It is possible to call BrokerProxy configuration methods multiple times and invoke the deployment once at the end.
This is a convenience method for a specific invocation of the BrokerProxy.setRuntimeProperty() method.
policySet
- Name of the policy setpolicySetContents
- An InputStream containing the contents of the policy set
XML file.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.
java.io.IOException
- if policySetContents is invalidpublic void setPolicySetBinding(java.lang.String policySetBinding, java.io.InputStream policySetBindingContents) throws ConfigManagerProxyLoggedException, java.io.IOException
After calling this method, BrokerProxy.deploy() needs to be called in order to deploy the changed configuration to the broker. It is possible to call BrokerProxy configuration methods multiple times and invoke the deployment once at the end.
This is a convenience method for a specific invocation of the BrokerProxy.setRuntimeProperty() method.
policySetBinding
- Name of the policy set bindingpolicySetBindingContents
- An InputStream containing the contents of the policy set
binding file.
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Configuration Manager.
java.io.IOException
- if policySetBindingContents is invalidpublic java.io.InputStream getPolicySet(java.lang.String policySet) throws ConfigManagerProxyPropertyNotInitializedException
The property is discovered directly an synchronously from the broker runtime and will block until the broker has responded or the timeout condition set by the timeToWaitMs value is reached. The value is not cached on the Configuration Manager or within the Configuration Manager Proxy. Therefore, it is advisable to call this method sparingly.
This is a convenience method for a specific invocation of the BrokerProxy.getRuntimeProperty() method.
policySet
- Name of the policy set
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied them.public java.io.InputStream getPolicySetBinding(java.lang.String policySetBinding) throws ConfigManagerProxyPropertyNotInitializedException
The property is discovered directly an synchronously from the broker runtime and will block until the broker has responded or the timeout condition set by the timeToWaitMs value is reached. The value is not cached on the Configuration Manager or within the Configuration Manager Proxy. Therefore, it is advisable to call this method sparingly.
This is a convenience method for a specific invocation of the BrokerProxy.getRuntimeProperty() method.
policySetBinding
- Name of the policy set binding
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied them.public java.lang.String[] getPolicySetNames() throws ConfigManagerProxyPropertyNotInitializedException
The property is discovered directly and synchronously from the broker runtime and will block until the broker has responded or the timeout condition set by the timeToWaitMs value is reached. The value is not cached on the Configuration Manager or within the Configuration Manager Proxy. Therefore, it is advisable to call this method sparingly.
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied them.public java.lang.String[] getPolicySetBindingNames() throws ConfigManagerProxyPropertyNotInitializedException
The property is discovered directly and synchronously from the broker runtime and will block until the broker has responded or the timeout condition set by the timeToWaitMs value is reached. The value is not cached on the Configuration Manager or within the Configuration Manager Proxy. Therefore, it is advisable to call this method sparingly.
ConfigManagerProxyPropertyNotInitializedException
- if
the information could not be determined because the Config
Manager has not yet supplied them.public void discoverConfiguration() throws ConfigManagerProxyLoggedException
Invoking this method is not usually necessary, as the Configuration Manager will automatically synchronize itself every sixty minutes with all brokers in the domain. Use this method if you have recently modified the broker's properties without using a Configuration Manager Proxy application (e.g. using mqsichangeproperties) and this is not yet reflected in Configuration Manager Proxy applications. Also use this method if you suspect that the Configuration Manager and the broker are not synchronized, and you do not wish to wait for the next automatic synchronisation to occur.
This is an asynchronous operation. The Configuration Manager's repository may not be updated until some time after this method returns, although you can use getLastDiscoveryTime() to find out when this occurs.
ConfigManagerProxyLoggedException
public java.lang.String[] getQueues() throws ConfigManagerProxyPropertyNotInitializedException
This method works by aggregating the responses from calling the ExecutionGroupProxy.getQueues() method for each execution group that is currently active on the broker.
This method will return an empty array if the connected Configuration Manager is of a version less than v6.1. Any message flows deployed through a Configuration Manager of a version earlier than v6.1 will not report any queues.
This method
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the Configuration manager.public java.lang.String[] getNodeTypes() throws ConfigManagerProxyPropertyNotInitializedException
This method works by aggregating the responses from calling the ExecutionGroupProxy.getNodeTypes() method for each execution group that is currently active on the broker.
This method will return an empty array if the connected Configuration Manager is of a version less than v6.1, or if the message flow was deployed through a Configuration Manager of a version earlier than v6.1.
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the Configuration manager.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |