public class BrokerProxy extends AdministeredObject
Each BrokerProxy instance represents a broker and all of its configuration and operational state.
BrokerProxy objects are the root of an administration object hierarchy, and are obtained by describing the connection details of the broker and passing them to either the getInstance() or getLocalInstance() methods of this class. For example, to connect to the locally defined broker "MYBROKER":
BrokerProxy b = BrokerProxy.getLocalInstance("MYBROKER");Alternatively, to connect to the remote broker on queue manager "QMGR" on the machine "mymachine.mydomain.com", port 1414:
BrokerConnectionParameters bcp = new MQBrokerConnectionParameters("mymachine.mydomain.com", 1414, "QMGR"); BrokerProxy b = BrokerProxy.getInstance(bcp);
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 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 setRegistryProperty(String, String) Added getRegistryProperty(String) Added getRegistryPropertyNames() Added SyncType enum Added getLastDiscoveryTime(SyncType) Deprecated getters and setters that can be controlled as runtime properties Added getQueues() Added getNodeTypes() Added discoverConfiguration() Added getAutoDiscoveryEnabled() Added setAutoDiscoveryEnabled(boolean) Added PolicyType enum Added getPolicySet(PolicyType, String) Added getPolicySetBindings(PolicyType, String) Added getPolicySetBindingsNames() Added getPolicySetNames() 48003.3 2008-01-08 HDMPL v6.1.0.2 release: Added getOperationMode() Added getOperationModeValidity() Added getOperationModeViolations() 51619.1 2008-07-17 HDMPL v7 release: Deprecated all methods related to publish/subscribe Deprecated all methods specific to Configuration Manager connections Deprecated immediate parameter on stopMessageFlows() Deprecated getRuntimeProperty() Deprecated getRuntimePropertyNames() Deprecated setRuntimeProperty() Overridden setName() (now throws an exception) Added getLog() Added getInstance() Added getBrokerVersion() Added getBrokerLongVersion() Added getBrokerOSArch() Added getBrokerOSName() Added getBrokerOSVersion() Added getAdministrationAPIVersion() Added setRetryCharacteristics() and MAX_WAIT_TIME Added getLocalInstance() Added getConfigurableService() Added getConfigurableServices() Added getConfigurableServiceTypes() Added createConfigurableService() Added deleteConfigurableService() Added isAdminSecurityEnabled() Added getResourceTypeNames() Added getResourceTypeStatisticsPropertyNames() 51619.40 2009-05-26 HDCAB Added getAdministrationQueue() 61984.1 2011-11-11 HDCAB v8 release: Added getModesOfOperation()Version @(#) MQMBID sn=S900-L150302 su=_DSj_s8EsEeSQdeb_Pq7vLQ pn=Config/com/ibm/broker/config/proxy/BrokerProxy.java]
Modifier and Type | Class and Description |
---|---|
static class |
BrokerProxy.MulticastParameterSet
Deprecated.
This class is no longer used as of WebSphere Message Broker V7.
The effects of using it are no longer defined.
|
static class |
BrokerProxy.PolicyType
Enumerates the possible types of policy that can
be used when retrieving the defined policy sets from
the broker.
|
static class |
BrokerProxy.StopMode
Enum for stoping message flows
|
static class |
BrokerProxy.SyncType
Deprecated.
This property is specific to previous versions of WebSphere Message Broker
and is not used as of V7.
|
Modifier and Type | Field and Description |
---|---|
static long |
MAX_WAIT_TIME
The maximum amount of time the IBM Integration API (CMP) can
be told to wait for broker messages before a
ConfigManagerProxyPropertyNotInitialisedException
is thrown.
|
Modifier and Type | Method and Description |
---|---|
void |
addAccessControlEntries(AccessControlEntry[] accessControlList)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
com.ibm.broker.config.common.CommonServiceInterface |
addService(com.ibm.broker.config.common.CommonServiceInterface service)
Deprecated.
This method is for IBM internal use only.
|
void |
beginUpdates()
Tells the IBM Integration API (CMP) to hold back from sending
any subsequent state-changing requests to the broker,
so multiple requests can be later sent off in a single message
(or "batch").
|
void |
cancelDeployment()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
Cancelling deployment is no longer required. Use
AdminQueueEntry.cancel() to cancel a specific unprocessed
request on a broker.
|
DeployResult |
cancelDeployment(long timeToWaitMs)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
Cancelling deployment is no longer required.
Use AdminQueueEntry.cancel() to cancel a specific unprocessed
request on a broker.
|
void |
clearUpdates()
Tells the IBM Integration API (CMP) to discard any
state-changing requests received since the last call to
beginUpdates().
|
static byte[] |
convertHexStringToBytes(java.lang.String hex) |
void |
createConfigurableService(java.lang.String csType,
java.lang.String csName)
Asks the broker to create a new configurable service of the supplied type and name.
|
ExecutionGroupProxy |
createExecutionGroup(java.lang.String name)
Asks the broker to create an Execution Group of the supplied name.
|
ExecutionGroupProxy |
createExecutionGroup(java.lang.String name,
int arch)
Deprecated.
As of WebSphere Message Broker V7, the arch parameter is ignored.
Use createExecutionGroup(String) instead.
|
PolicyProxy |
createPolicy(PolicyProxy policy)
Asks the broker to create a new policy based on the PolicyProxy object pass in.
|
PolicyProxy |
createPolicy(java.lang.String policyType,
java.lang.String policyName,
java.lang.String policyDocument)
Asks the broker to create a new policy based on the string objects pass in.
|
SubscriptionQuery |
createSubscriptionQuery()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
The effects of invoking it are no longer defined.
|
void |
deleteAllExecutionGroupsAndDeploy()
Deprecated.
Use BrokerProxy.deleteExecutionGroup() to delete individual
execution groups, or delete the broker to delete all execution groups.
|
DeployResult |
deleteAllExecutionGroupsAndDeploy(long timeToWaitMs)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
deleteConfigurableService(java.lang.String csType,
java.lang.String csName)
Asks the broker to delete the configurable service of the supplied type and name.
|
void |
deleteExecutionGroup(java.lang.String name)
Asks the broker to delete the execution group with
the supplied name from the broker.
|
DeployResult |
deleteExecutionGroup(java.lang.String name,
long timeToWaitMs)
Deprecated.
As of WebSphere Message Broker V7 applications connect directly
to brokers, and so deployment of execution group deletions and the resulting
DeployResult object are no longer relevant.
Use deleteExecutionGroup(String) instead.
|
void |
deletePolicy(PolicyProxy policy)
Asks the broker to delete a policy based on the PolicyProxy object pass in.
|
void |
deletePolicy(java.lang.String policyType,
java.lang.String policyName)
Asks the broker to delete a policy based on the string objects pass in.
|
void |
deleteService(com.ibm.broker.config.common.CommonServiceInterface service)
Deprecated.
This method is for IBM internal use only.
|
void |
deploy()
Deprecated.
This method is not used as of WebSphere Message Broker V7,
as configuration changes are sent directly to the broker and
applied immediately.
|
DeployResult |
deploy(long timeToWaitMs)
Deprecated.
This method is should not be used as of WebSphere Message
Broker V7, as configuration changes are sent directly to the broker and
applied immediately. Older applications that were using this method
to make property changes synchronously should use
BrokerProxy.setSynchronous(long) to achieve the same effect.
|
static void |
disableAdministrationAPITracing()
Stops service tracing of the IBM Integration API (CMP).
|
void |
disconnect()
When connected directly to a broker, this method deregisters
all listeners registered to this BrokerProxy instance and
closes the link to the broker.
|
void |
discoverConfiguration()
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
void |
discoverConfiguration(BrokerProxy.SyncType typeOfDiscovery)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
static void |
enableAdministrationAPITracing(java.lang.String filename)
Enables service tracing of the IBM Integration API (CMP),
sending output to the file with the supplied name.
|
void |
forceSubscribe()
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
static java.lang.String |
generateModProxyPlugin(java.util.Map<BrokerProxy,java.lang.String[]> brokerHostsMap,
long timeOutMillis)
This method generates a String representation of a configuration used for mod_proxy
|
static java.lang.String |
generateWASPlugin(java.util.Map<BrokerProxy,java.lang.String[]> brokerHostsMap,
long timeOutMillis)
This method generates a String representation of a configuration used for the WAS plugin
|
AccessControlEntry[] |
getAccessControlEntries()
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
static int |
getAdministrationAPIVersion()
Returns the version number of the IBM Integration API (CMP).
|
AdminQueueProxy |
getAdministrationQueue()
Returns an AdminQueueProxy object that contains the
administration queue entries that are associated with the
current broker.
|
java.lang.String |
getAuthenticationProtocols()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
boolean |
getAutoDiscoveryEnabled()
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
java.lang.String |
getBrokerLongVersion()
Returns the complete version identifier of the broker
to which the application is connected.
|
java.lang.String |
getBrokerOSArch()
Returns a String representing the architecture of the machine
on which the connected broker is running.
|
java.lang.String |
getBrokerOSName()
Returns a String representing the name of the OS
on which the connected broker is running.
|
java.lang.String |
getBrokerOSVersion()
Returns a String representing the version of the OS
on which the connected broker is running.
|
int |
getBrokerVersion()
Returns the short version identifier of the broker
to which the application is connected.
|
java.lang.String |
getCacheManagerProperty(java.lang.String objectAndPropertyName)
Returns the value of the CacheManager broker level runtime property with the supplied name.
|
java.lang.String[] |
getCacheManagerPropertyNames()
Returns a string array of all broker level CacheManager properties
associated with this object.
|
ConfigurableService |
getConfigurableService(java.lang.String type,
java.lang.String name)
Returns a ConfigurableService object with the supplied name
and type.
|
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.
|
ConfigurableService[] |
getConfigurableServices(java.lang.String type)
Returns an array of ConfigurableService objects that describes all the
configurable services defined on the broker that match the
supplied type.
|
java.lang.String[] |
getConfigurableServiceTypes()
Returns a list of all the ConfigurableService types that are known
to the 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(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.
|
static BrokerProxy |
getInstance(BrokerConnectionParameters bcp)
Asks the IBM Integration API (CMP) to connect to a broker
with the supplied parameters.
|
java.lang.String |
getInterbrokerHost()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
int |
getInterbrokerPort()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
TopicProxy.QoP |
getISysQualityOfProtectionLevel()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
java.util.Date |
getLastDiscoveryTime(BrokerProxy.SyncType syncType)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
static BrokerProxy |
getLocalInstance()
Returns the BrokerProxy object that represents the broker in
which the current application is deployed.
|
static BrokerProxy |
getLocalInstance(java.lang.String brokerName)
Asks the IBM Integration API (CMP) to connect to a
locally-defined broker with the supplied name.
|
LogProxy |
getLog()
Returns a LogProxy object that contains the log messages that
are associated with the current broker.
|
java.lang.String[] |
getModesOfOperation()
Returns the modes of operation which are available on the
broker.
|
BrokerProxy.MulticastParameterSet |
getMulticastParameters()
Deprecated.
This method is no longer used as of WebSphere Message Broker V7.
|
java.lang.String[] |
getNodeTypes()
Returns a list of the types of nodes used in this broker.
|
java.lang.String |
getOperationMode()
Returns the logical mode of operation in which the broker is
currently running.
|
boolean |
getOperationModeValidity()
Returns a boolean value that indicates whether the set of the
artefacts deployed to the current broker are valid given the
mode of operation in which the broker is running.
|
java.util.List<LogEntry> |
getOperationModeViolations()
Goes through the artefacts deployed on the supplied broker
and returns a list of LogEntry messages that describe each violation
of the broker, based on the current value of the OperationMode
parameter.
|
PolicyProxy |
getPolicy(PolicyProxy policy)
Asks the broker to get a policy based on the string objects pass in.
|
PolicyProxy |
getPolicy(java.lang.String policyType,
java.lang.String policyName)
Asks the broker to get a policy based on the PolicyProxy object pass in.
|
PolicyManagerProxy |
getPolicyManager(java.lang.String policyType)
Asks the broker to get a policy manager for a given type of policy.
|
java.io.InputStream |
getPolicySet(BrokerProxy.PolicyType policyType,
java.lang.String policySetName)
Asks the broker to return the contents of a policy set with the supplied name.
|
java.io.InputStream |
getPolicySetBindings(BrokerProxy.PolicyType policyType,
java.lang.String policySetBindingsName)
Asks the broker to return the contents of a policy set bindings with the supplied name.
|
java.lang.String[] |
getPolicySetBindingsNames()
Asks the broker to return the names of the policy set bindings
that have been defined on the broker.
|
java.lang.String[] |
getPolicySetNames()
Asks the broker to return the names of the policy sets defined on the broker.
|
java.lang.String[] |
getPolicyTypes()
Asks the broker for a list of all valid policy types.
|
java.lang.String |
getPortConfigAsCSV() |
java.lang.String |
getPortConfigAsCSV(long timeOutMillis) |
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 |
getRegistryProperty(java.lang.String objectAndPropertyName)
Returns the value of the registry property with the supplied name.
|
java.lang.String[] |
getRegistryPropertyNames()
Returns a string array of all registry properties associated with this object.
|
java.lang.String[] |
getResourceTypeNames()
Returns a String array of all resource types available on the broker
that have the ability to emit resource-level statistics.
|
java.lang.String[] |
getResourceTypeStatisticsPropertyNames(java.lang.String resourceTypeName)
Returns the names of the statistics properties that are reported for a given resource type.
|
java.lang.String |
getRuntimeProperty(java.lang.String objectAndPropertyName)
Deprecated.
This method is not used as of WebSphere Message Broker V7,
and there are several methods that should be used instead; for example,
use BrokerProxy.getRegistryProperty() to get broker registry properties,
BrokerProxy.getConfigurableServiceProperty() to get configurable service
properties and ExecutionGroupProxy.getRuntimeProperty() to get execution
group runtime properties.
|
java.lang.String[] |
getRuntimePropertyNames()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
No runtime properties are returned.
|
java.lang.String |
getSecurityCacheProperty(java.lang.String objectAndPropertyName)
Returns the value of the security cache property with the supplied name.
|
java.lang.String[] |
getSecurityCachePropertyNames()
Returns a string array of all security cache properties associated with this object.
|
com.ibm.broker.config.common.CommonServiceInterface |
getService(com.ibm.broker.config.common.CommonServiceInterface other)
Deprecated.
This method is for IBM internal use only.
|
com.ibm.broker.config.common.CommonServiceInterface[] |
getServices()
Deprecated.
This method is for IBM internal use only.
|
boolean |
getSSLConnectorEnabled()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
java.lang.String |
getSSLKeyRingFileName()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
java.lang.String |
getSSLPasswordFileName()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
int |
getSynchronous()
Returns a int describing how synchronous property change methods
have been configured to be.
|
TopicProxy.QoP |
getSysQualityOfProtectionLevel()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
TopicProxy.QoP |
getTemporaryTopicQualityOfProtectionLevel()
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
WebAdminProxy |
getWebAdminProxy()
Returns the singleton WebAdminProxy object against which the
web administration interface can be controlled.
|
boolean |
isAdminSecurityEnabled()
Returns true only if administrative security has been enabled on the broker.
|
boolean |
isBatching()
Returns true if and only if the creation of a batch is currently in progress.
|
boolean |
isRunning()
Returns a boolean describing the run state of the broker.
|
void |
removeAccessControlEntries(AccessControlEntry[] accessControlList)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
void |
sendUpdates()
Tells the IBM Integration API (CMP) to send to the broker all
requests received since the beginUpdates() call.
|
void |
sendUpdates(int correlationID)
Tells the IBM Integration API (CMP) to send to the broker all
requests received since the beginUpdates() call.
|
void |
setAccessControlEntries(AccessControlEntry[] accessControlList)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
void |
setAuthenticationProtocols(java.lang.String authProtocols)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setAutoDiscoveryEnabled(boolean isEnabled)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
void |
setCacheManagerProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary property on the
broker's CacheManager component.
|
void |
setConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary broker-wide
configurable service property.
|
void |
setHTTPListenerProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary property on the
broker's HTTP listener component.
|
void |
setInterbrokerHost(java.lang.String ibHost)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setInterbrokerPort(int ibPort)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setISysQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setMulticastParameters(BrokerProxy.MulticastParameterSet newParameterSet)
Deprecated.
This method is no longer used as of WebSphere Message Broker V7.
|
void |
setName(java.lang.String name)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
setPolicySet(BrokerProxy.PolicyType policyType,
java.lang.String policySet,
java.io.InputStream policySetContents)
Asks the broker to save a policy set with the supplied contents.
|
void |
setPolicySetBindings(BrokerProxy.PolicyType policyType,
java.lang.String policySetBindings,
java.io.InputStream policySetBindingsContent)
Asks the broker to save policy set binding information with the supplied contents.
|
void |
setQueueManagerName(java.lang.String newQMgr)
Deprecated.
Since the Configuration Manager is no longer used to hold
broker connection information, this particular method has been deprecated
as of WebSphere Message Broker V7. To change a broker's queue manager
you need to delete and recreate the broker.
|
void |
setRegistryProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary broker-wide registry property.
|
static void |
setRetryCharacteristics(long maxWaitTimeMs)
Sets the retry characteristics for all broker connections
originating from this JVM instance.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setSecurityCacheProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary broker-wide
security cache property.
|
void |
setSSLConnectorEnabled(boolean isEnabled)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setSSLKeyRingFileName(java.lang.String keyRingFile)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setSSLPasswordFileName(java.lang.String passwordFile)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setSynchronous(int timeToWaitMs)
Configures whether the IBM Integration API (CMP) should wait
for broker configuration changes to be fully completed before
returning to the caller.
|
void |
setSysQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setTemporaryTopicQualityOfProtectionLevel(TopicProxy.QoP newQoP)
Deprecated.
This method is not used as of WebSphere Message Broker V7.
|
void |
setUserTrace(MessageFlowProxy.UserTrace newTrace)
Iterates through every deployed message flow in every
execution group, configuring its user trace settings.
|
void |
setUUID(java.lang.String newUUID)
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
void |
startMessageFlows()
Asks the broker to start all message flows that exist on the broker.
|
void |
stopMessageFlows()
Asks the broker to stop all message flows that exist on the broker.
|
void |
stopMessageFlows(boolean immediate)
Deprecated.
The immediate flag is ignored. Use stopMessageFlows() instead.
|
PolicyProxy |
updatePolicy(PolicyProxy policy)
Asks the broker to update a policy based on the PolicyProxy object pass in.
|
PolicyProxy |
updatePolicy(java.lang.String policyType,
java.lang.String policyName,
java.lang.String policyDocument)
Asks the broker to update a policy based on the string objects pass in.
|
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.
|
deregisterListener, deregisterListener, elements, equals, getAdvancedProperties, getBasicProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setLongDescription, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates
public static final long MAX_WAIT_TIME
public int getBrokerVersion() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's version was not supplied
before a timeout occurred.public java.lang.String getBrokerLongVersion() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's version was not supplied
before a timeout occurred.public java.lang.String getBrokerOSArch() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's architecture was not supplied
before a timeout occurred.public java.lang.String getBrokerOSName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's OS name was not supplied
before a timeout occurred.public java.lang.String getBrokerOSVersion() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's OS version was not supplied
before a timeout occurred.public static int getAdministrationAPIVersion()
public void beginUpdates() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if a batch is already
in progress.sendUpdates()
,
clearUpdates()
,
isBatching()
public void sendUpdates() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- If a batch was not
in progress, if the batch contained no requests, or if
the request could not be sent to the broker.beginUpdates()
,
clearUpdates()
,
isBatching()
public void sendUpdates(int correlationID) throws ConfigManagerProxyLoggedException
correlationID
- Identifier that will accompany any actionresponse
messages sent back to the caller through the AdministeredObjectListener
interface.ConfigManagerProxyLoggedException
- if a batch was not
in progress, if the batch contained no requests or if the request could not
be sent to the broker.beginUpdates()
,
sendUpdates()
,
clearUpdates()
,
isBatching()
public void clearUpdates()
beginUpdates()
,
sendUpdates()
,
isBatching()
public boolean isBatching()
beginUpdates()
,
sendUpdates()
,
clearUpdates()
public void setSynchronous(int timeToWaitMs)
For all new IBM Integration API (CMP) applications*, the default behavior is for all property change methods to return immediately after the change request has been queued for processing at the broker. This means that if a method to return a property's value is called immediately after setting it, the old value is typically returned as the request is unlikely yet to have been processed and a response returned.
A positive timeToWaitMs parameter to this method causes configuration change methods to pause until a positive or negative response is received by the broker, which means that a successful return from the property change method implies that the broker successfully processed the request. In this case, if the configuration change request is rejected by the broker, a ConfigManagerProxyRequestFailedException is thrown. If the broker does not respond in the configured time period, a ConfigManagerProxyRequestTimeoutException is thrown (which does not mean that the request to set the property failed).
This method affects all subsequent calls to all methods based on AdministeredObject.setProperties(), AdministeredObject.createManagedSubcomponent() and AdministeredObject.deleteManagedSubcomponents(). This includes all variants of setShortDescription(), setLongDescription(), startMessageFlows(), stopMessageFlows(), createExecutionGroup(), createConfigurableService(), deleteExecutionGroup(), deleteConfigurableService() and set*RuntimeProperty(). It affects this BrokerProxy instance and all ExecutionGroupProxy and MessageFlowProxy children that are derived from it. Deployment methods such as ExecutionGroupProxy.deploy() and ExecutionGroupProxy.deleteDeployedObjects() are unaffected by this setting, as it is possible to configure synchronous behavior directly on these method calls.
Enabling synchronous behavior is not recommended when the IBM Integration API (CMP) application is deployed inside a JavaCompute node. This is because, if the application subsequently invokes a method to affect the message flow in which the IBM Integration API (CMP) application is running, the application might deadlock and the operation will time out.
*If you are running a V6.x CMP application connected through the deprecated ConfigManagerProxy root object, the default behavior is to run synchronously with a time limit of 60 seconds. This is to emulate the single-threaded nature of the old Configuration Manager; the broker now processes administration requests on multiple threads, and so any call to BrokerProxy.deploy() will no longer guarantee that any previous set*Property() calls will have completed by the time deploy() returns. Making these older applications synchronous by default helps ensure that the deploy() method continues to work as it did previously.
timeToWaitMs
- A positive value describes the maximum length of time to wait
for broker responses (in milliseconds) before the change property method returns.
Alternatively:
public int getSynchronous()
public WebAdminProxy getWebAdminProxy() throws ConfigManagerProxyPropertyNotInitializedException
Returns the singleton WebAdminProxy object against which the web administration interface can be controlled. Principally, this WebAdminProxy object manages the web user accounts.
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.AdministeredObject.getManagedSubcomponent(Properties)
public static BrokerProxy getLocalInstance(java.lang.String brokerName) throws ConfigManagerProxyLoggedException
brokerName
- Name of the locally-defined broker to connect to.ConfigManagerProxyLoggedException
- if a broker of the supplied name could
not be found, or if a connection could not be established for whatever reason.public static BrokerProxy getLocalInstance() throws ConfigManagerProxyLoggedException
When a IBM Integration API (CMP) application is run inside such an environment, take care when using methods that might affect the message flow in which the IBM Integration API (CMP) application is running; for example, stopping, deleting or redeploying the message flow. As the IBM Integration API (CMP) application can never receive notifications that such operations have successfully completed, their use in such scenarios is not recommended.
ConfigManagerProxyLoggedException
- if the application is not deployed inside a broker.public static BrokerProxy getInstance(BrokerConnectionParameters bcp) throws ConfigManagerProxyLoggedException
bcp
- An object describing the connection parameters to the broker.
Cannot be null.ConfigManagerProxyLoggedException
- if a connection could not
be established for whatever reason.public void disconnect()
public DeployResult cancelDeployment(long timeToWaitMs) throws ConfigManagerProxyLoggedException
public void cancelDeployment() throws ConfigManagerProxyLoggedException
public ExecutionGroupProxy createExecutionGroup(java.lang.String name) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
If synchronous updates have been enabled using BrokerProxy.setSynchronous(), this method will only return an ExecutionGroupProxy object once the execution group has been fully initialized on the broker. If synchronous updates have not been enabled, an object will be returned but it might not yet exist on the target broker at the point of return, and any subsequent operations on that object will only be attempted by the broker if and only if the actual execution group has been fully initialized.
name
- Name of the new execution group.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if the supplied name is null or the
empty string.public ExecutionGroupProxy createExecutionGroup(java.lang.String name, int arch) throws ConfigManagerProxyLoggedException
If synchronous updates have been enabled using BrokerProxy.setSynchronous(), this method will only return an ExecutionGroupProxy object once the execution group has been fully initialized on the broker. If synchronous updates have not been enabled, an object will be returned but it might not yet exist on the target broker at the point of return, and any subsequent operations on that object will only be attempted by the broker if and only if the actual execution group has been fully initialized.
name
- Name of the new execution group.arch
- IgnoredConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void deleteExecutionGroup(java.lang.String name) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If synchronous updates have been enabled using BrokerProxy.setSynchronous(), this method will only return once the execution group has been fully deleted. Otherwise, the request to delete the execution group will be processed asynchronously and the execution group might still exist when the method returns.
name
- of the execution group to be deleted from the broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if the supplied name is null or
the empty String.public DeployResult deleteExecutionGroup(java.lang.String name, long timeToWaitMs) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
If synchronous updates have been enabled using BrokerProxy.setSynchronous(), this method will only return once the execution group has been fully deleted. Otherwise, the request to delete the execution group will be processed asynchronously and the execution group might still exist when the method returns.
name
- of the execution group to be deleted from the broker.timeToWaitMs
- This parameter is ignored.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void deleteAllExecutionGroupsAndDeploy() throws ConfigManagerProxyLoggedException
public DeployResult deleteAllExecutionGroupsAndDeploy(long timeToWaitMs) throws ConfigManagerProxyLoggedException
timeToWaitMs
- IgnoredConfigManagerProxyLoggedException
public void deploy() throws ConfigManagerProxyLoggedException
public DeployResult deploy(long timeToWaitMs) throws ConfigManagerProxyLoggedException
Using this method is unnecessary and will cause your application to work more slowly.
In previous versions of WebSphere Message Broker, this method deployed configuration changes to a broker. This had the effect of pausing the application until the request was completed by the broker, and thus provided the ability to make configuration changes synchronously.
As of WebSphere Message Broker V7, property changes are applied
immediately and so a separate deployment step is not required.
Calling BrokerProxy.deploy(long) now sends a dummy request to
the broker, and causes the application to pause until the
response is received.
This achieves largely the same effect as the pre-v7 behavior,
but does not guarantee that any previously submitted property change
requests have been processed by the time the method returns.
However to help ensure consistent behavior, when older applications
(i.e. those connected through the deprecated ConfigManagerProxy root
object) attempt to modify the broker's configuration the IBM
Integration API (CMP) will, by default, pause for up to 60
seconds until the request has been fully processed by the
broker. See setSynchronous(int)
for more
information.
It is recommended that applications that have a requirement to make property changes synchronously and that currently use BrokerProxy.deploy(long) are changed to use the IBM Integration API (CMP) synchronization framework instead. This means removing any calls to BrokerProxy.deploy(long) and instead calling BrokerProxy.setSynchronous(long) before a property change is made. Alternatively, consider using the AdministeredObjectListener interface to have your application register for object change notifications.
timeToWaitMs
- Maximum length of time to wait (in milliseconds)
for the response message before returning. Use -1 to wait indefinitely.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. Subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public java.lang.String getSSLKeyRingFileName() throws ConfigManagerProxyPropertyNotInitializedException
public boolean getSSLConnectorEnabled() throws ConfigManagerProxyPropertyNotInitializedException
public java.lang.String getAuthenticationProtocols() throws ConfigManagerProxyPropertyNotInitializedException
public java.lang.String getSSLPasswordFileName() throws ConfigManagerProxyPropertyNotInitializedException
public java.lang.String getInterbrokerHost() throws ConfigManagerProxyPropertyNotInitializedException
public int getInterbrokerPort() throws ConfigManagerProxyPropertyNotInitializedException
public TopicProxy.QoP getTemporaryTopicQualityOfProtectionLevel() throws ConfigManagerProxyPropertyNotInitializedException
public TopicProxy.QoP getSysQualityOfProtectionLevel() throws ConfigManagerProxyPropertyNotInitializedException
public TopicProxy.QoP getISysQualityOfProtectionLevel() throws ConfigManagerProxyPropertyNotInitializedException
public void setTemporaryTopicQualityOfProtectionLevel(TopicProxy.QoP newQoP) throws ConfigManagerProxyLoggedException
public void setSysQualityOfProtectionLevel(TopicProxy.QoP newQoP) throws ConfigManagerProxyLoggedException
public void setISysQualityOfProtectionLevel(TopicProxy.QoP newQoP) throws ConfigManagerProxyLoggedException
public java.lang.String getQueueManagerName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setQueueManagerName(java.lang.String newQMgr) throws ConfigManagerProxyLoggedException
public void setSSLKeyRingFileName(java.lang.String keyRingFile) throws ConfigManagerProxyLoggedException
public void setSSLPasswordFileName(java.lang.String passwordFile) throws ConfigManagerProxyLoggedException
public void setSSLConnectorEnabled(boolean isEnabled) throws ConfigManagerProxyLoggedException
public void setAuthenticationProtocols(java.lang.String authProtocols) throws ConfigManagerProxyLoggedException
public void setInterbrokerHost(java.lang.String ibHost) throws ConfigManagerProxyLoggedException
public void setInterbrokerPort(int ibPort) throws ConfigManagerProxyLoggedException
public java.lang.String[] getConfigurableServicePropertyNames()
Consider using BrokerProxy.getConfigurableServices(String) to access configurable services and their properties in a more consumable way.
Each String is of the form "CSType/CSName/PropertyName", where CSType is the type of the configurable service, CSName is the name of the configurable service and PropertyName is the name of the property. The '/' character that separates the two values is defined in AttributeConstants.OBJECT_NAME_DELIMITER.
public ConfigurableService[] getConfigurableServices(java.lang.String type) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
Any returned objects are not updated by the IBM Integration API (CMP) once they have been returned to the caller. If a configurable service or any of its properties is subsequently modified on the broker, the object will be out of date and this method should be called again.
type
- Type of the configurable service (e.g. "EISProviders").
If the parameter is null or the empty string, all configurable services are
returned.ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's configurable services was not supplied
before a timeout occurred.java.lang.IllegalArgumentException
public ConfigurableService getConfigurableService(java.lang.String type, java.lang.String name) throws ConfigManagerProxyPropertyNotInitializedException
Any returned object is not updated by the IBM Integration API (CMP) once it has been returned to the caller. If the configurable service or any of its properties is subsequently modified on the broker, the returned object will be out of date and this method should be called again.
type
- Type of the configurable service (e.g. "EISProviders").
If this parameter is null or the empty string, all configurable service
types are searched.name
- Name of the configurable service (e.g. "SAP1").
If this parameter is null or the empty string, all configurable service
names are searched for the given type. Names are unique on a broker
for a given configurable service type.ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's configurable services was not supplied
before a timeout occurred.public java.lang.String[] getConfigurableServiceTypes() throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
ConfigManagerProxyPropertyNotInitializedException
- if information on the broker's configurable services was not supplied
before a timeout occurred.java.lang.IllegalArgumentException
public void createConfigurableService(java.lang.String csType, java.lang.String csName) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
csType
- Type of the new configurable service (e.g. JMSProviders)csName
- Name of the new configurable service.
The name must be unique on the broker.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if either the supplied name or type
is null or the empty String.public void deleteConfigurableService(java.lang.String csType, java.lang.String csName) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
csType
- Type of the configurable service (e.g. JMSProviders)csName
- Name of the configurable service.
The name must exist on the broker.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if either the supplied name or type
is null or the empty String.public java.lang.String[] getHTTPListenerPropertyNames()
public java.lang.String[] getRuntimePropertyNames()
public java.lang.String[] getRegistryPropertyNames()
public java.lang.String[] getSecurityCachePropertyNames()
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 the value of the parameter could not be determined because
the information was not supplied from the broker 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 the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.AdministeredObject.getManagedSubcomponent(Properties)
public ExecutionGroupProxy getExecutionGroupByName(java.lang.String executionGroupName) throws ConfigManagerProxyPropertyNotInitializedException
executionGroupName
- Name of the execution groupConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void startMessageFlows() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void stopMessageFlows(boolean immediate) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
immediate
- Not usedConfigManagerProxyPropertyNotInitializedException
- if information
on the broker's execution groups is not available.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void stopMessageFlows() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public boolean getAutoDiscoveryEnabled() throws ConfigManagerProxyPropertyNotInitializedException
public void setAutoDiscoveryEnabled(boolean isEnabled) throws ConfigManagerProxyLoggedException
public void setUserTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
newTrace
- One of:
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker or if the current user is not authorized to
view the list of execution groups on this broker, or to view the list
of message flows on any execution group.
If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void forceSubscribe() throws ConfigManagerProxyLoggedException
public void setUUID(java.lang.String newUUID) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
ConfigManagerProxyLoggedException
java.lang.IllegalArgumentException
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)
public BrokerProxy.MulticastParameterSet getMulticastParameters() throws ConfigManagerProxyPropertyNotInitializedException
public void setMulticastParameters(BrokerProxy.MulticastParameterSet newParameterSet) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
ConfigManagerProxyLoggedException
java.lang.IllegalArgumentException
public void setName(java.lang.String name) throws ConfigManagerProxyLoggedException
setName
in class AdministeredObject
name
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public AccessControlEntry[] getAccessControlEntries()
public void setAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
public void addAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
public void removeAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
public SubscriptionQuery createSubscriptionQuery()
public void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
ConfigManagerProxyLoggedException
java.lang.IllegalArgumentException
public void setConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
Consider using ConfigurableService.setProperty() to set configurable service properties in a more consumable way.
The set of properties configurable using this method are those that can be manipulated using the mqsichangeproperties command that has the -c flag specified.
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 that affect the broker's registry, use BrokerProxy.setRegistryProperty(). To set runtime properties that affect the security cache, use BrokerProxy.setSecurityCacheProperty(). To set other runtime properties, use BrokerProxy.setRuntimeProperty().
Constants exist for many common property names in the AttributeConstants 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 AttributeConstants.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 propertyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if serviceObjectAndPropertyName is not a valid syntax.public void setRegistryProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
objectAndPropertyName
- The name of the property being manipulated.
Used the constants beginning AttributeConstants.BROKER_REGISTRY or
return values from getRegistryPropertyNames().propertyValue
- The new value to associate with the propertyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public void setSecurityCacheProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
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 that affect the broker's registry, use BrokerProxy.setRegistryProperty(). To set runtime properties that affect the security cache, use BrokerProxy.setSecurityCacheProperty(). To set runtime properties for a configurable service, use BrokerProxy.setConfigurableServiceProperty().
Constants exist for many common objectAndPropertyName values in the AttributeConstants 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. The '/' separator is defined as AttributeConstants.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 propertyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public void setHTTPListenerProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
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().
Constants exist for many common objectAndPropertyName values in the AttributeConstants 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 AttributeConstants.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 propertyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public java.lang.String getRuntimeProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
ConfigManagerProxyPropertyNotInitializedException
java.lang.IllegalArgumentException
public java.lang.String getConfigurableServiceProperty(java.lang.String serviceObjectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants 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 AttributeConstants.OBJECT_NAME_DELIMITER.
serviceObjectAndPropertyName
- The complete name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if serviceObjectAndPropertyName is not a valid syntax.public java.lang.String getRegistryProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants interface.
objectAndPropertyName
- The name of the property whose value is to be reported
The format of this String is the same as the format returned by getRegistryPropertyNames().ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public boolean isAdminSecurityEnabled() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String getSecurityCacheProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants 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 AttributeConstants.OBJECT_NAME_DELIMITER.
objectAndPropertyName
- The name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public java.lang.String getHTTPListenerProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants 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 AttributeConstants.OBJECT_NAME_DELIMITER.
objectAndPropertyName
- The name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public void setPolicySet(BrokerProxy.PolicyType policyType, java.lang.String policySet, java.io.InputStream policySetContents) throws ConfigManagerProxyLoggedException, java.io.IOException, java.lang.IllegalArgumentException
This is a convenience method for a specific invocation of the BrokerProxy.setRuntimeProperty() method.
policyType
- Type of the file to retrieve from the policy set. Currently,
only PolicyType.WS_SECURITY is supported.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 broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.io.IOException
- if policySetContents is invalidjava.lang.IllegalArgumentException
- if policySet is not a valid syntax.public void setPolicySetBindings(BrokerProxy.PolicyType policyType, java.lang.String policySetBindings, java.io.InputStream policySetBindingsContent) throws ConfigManagerProxyLoggedException, java.io.IOException, java.lang.IllegalArgumentException
This is a convenience method for a specific invocation of the BrokerProxy.setRuntimeProperty() method.
policyType
- Type of the file to retrieve from the policy set. Currently,
only PolicyType.WS_SECURITY is supported.policySetBindings
- Name of the policy set bindingpolicySetBindingsContent
- An InputStream containing the contents of the policy set
binding file.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.io.IOException
- if policySetBindingContents is invalidjava.lang.IllegalArgumentException
- if policySetBindings is not a valid syntax.public java.io.InputStream getPolicySet(BrokerProxy.PolicyType policyType, java.lang.String policySetName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
policyType
- Type of the file to retrieve from the policy set. Currently,
only PolicyType.WS_SECURITY and PolicyType.WS_RM are supported.policySetName
- Name of the policy setConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if policySetName is not a valid syntax.public java.io.InputStream getPolicySetBindings(BrokerProxy.PolicyType policyType, java.lang.String policySetBindingsName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
policyType
- Type of the file to retrieve from the policy set. Currently,
only PolicyType.WS_SECURITY is supported.policySetBindingsName
- Name of the policy set bindingsConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if policySetBindingsName is not a valid syntax.public java.lang.String[] getPolicySetNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String[] getPolicySetBindingsNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public PolicyProxy createPolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error creating the policy.public PolicyProxy createPolicy(java.lang.String policyType, java.lang.String policyName, java.lang.String policyDocument) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error creating the policy.public void deletePolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error deleting the policy.public void deletePolicy(java.lang.String policyType, java.lang.String policyName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error deleting the policy.public PolicyProxy updatePolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error updating the policy.public PolicyProxy updatePolicy(java.lang.String policyType, java.lang.String policyName, java.lang.String policyDocument) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error updating the policy.public PolicyProxy getPolicy(java.lang.String policyType, java.lang.String policyName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the policy.public PolicyProxy getPolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the policy.public PolicyManagerProxy getPolicyManager(java.lang.String policyType) throws ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the PolicyManagerProxy.public java.lang.String[] getPolicyTypes()
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the array of policy types.public void discoverConfiguration() throws ConfigManagerProxyLoggedException
public void discoverConfiguration(BrokerProxy.SyncType typeOfDiscovery) throws 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.
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.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.
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the broker.public java.lang.String getOperationMode() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public boolean getOperationModeValidity()
public java.util.List<LogEntry> getOperationModeViolations()
public java.lang.String[] getModesOfOperation()
public static void enableAdministrationAPITracing(java.lang.String filename) throws ConfigManagerProxyLoggedException
An alternative way of tracing the IBM Integration API (CMP) is to set the environment variable 'MQSI_CMP_TRACE' to the value of the file name to which trace will be directed, for example:
set MQSI_CMP_TRACE=c:\trace.txtThis approach does not require you to recompile your application. This environment variable is discovered and acted upon when a BrokerProxy object is first connected (using BrokerProxy.getInstance() or one of its variants), which means that any methods that are called before a BrokerProxy handle is first obtained will not be traced. If the environment variable is set and the trace file could not be written at the time the BrokerProxy.getInstance() method is called, that method will throw a ConfigManagerProxyLoggedException.
filename
- File spec of the output file, which cannot be null.ConfigManagerProxyLoggedException
- if the logger could not
be instantiated.public static void disableAdministrationAPITracing()
public static void setRetryCharacteristics(long maxWaitTimeMs)
The IBM Integration API (CMP) may not always have been supplied a required piece of information that is needed to perform an operation (e.g. it can't return a broker's execution group list if that broker's information has not been supplied to it by the broker). This can happen if the API has a slow link to the broker, or if the broker is heavily burdened or just not running.
maxWaitTimeMs
- the maximum length of time the
IBM Integration API (CMP) will wait for a response from the
broker before a ConfigManagerProxyPropertyNotInitalizedException
is thrown.
The maximum value allowed value is BrokerProxy.MAX_WAIT_TIME
If the supplied value is greater than this,
BrokerProxy.MAX_WAIT_TIME will be used instead.public LogProxy getLog() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the log could not be retrieved because
the information was not supplied from the broker before a
timeout occurred.public AdminQueueProxy getAdministrationQueue() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the administration queue could not be retrieved because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String[] getResourceTypeNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the list could not be
determined because the information was not supplied from the broker before a timeout occurred.public java.lang.String[] getResourceTypeStatisticsPropertyNames(java.lang.String resourceTypeName) throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the list could not be
determined because the information was not supplied from the broker before a timeout occurred.getResourceTypeNames()
,
ExecutionGroupProxy.getResourceStatisticsEnabled(String)
,
ExecutionGroupProxy.setResourceStatisticsEnabled(String, boolean)
public void setCacheManagerProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
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().
Constants exist for many common objectAndPropertyName values in the AttributeConstants 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, "CacheManager/policy" would request a change to the Cache policy value. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.
The list of currently defined property names can be obtained using the method getCacheManagerPropertyNames(). 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 propertyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public java.lang.String getCacheManagerProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants 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 AttributeConstants.OBJECT_NAME_DELIMITER.
objectAndPropertyName
- The name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public java.lang.String[] getCacheManagerPropertyNames()
public java.lang.String getPortConfigAsCSV() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
public java.lang.String getPortConfigAsCSV(long timeOutMillis) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
public static byte[] convertHexStringToBytes(java.lang.String hex)
public static java.lang.String generateWASPlugin(java.util.Map<BrokerProxy,java.lang.String[]> brokerHostsMap, long timeOutMillis) throws ConfigManagerProxyLoggedException
brokerHostsMap
- Map of BrokerProxys to Host NamesConfigManagerProxyLoggedException
public static java.lang.String generateModProxyPlugin(java.util.Map<BrokerProxy,java.lang.String[]> brokerHostsMap, long timeOutMillis) throws ConfigManagerProxyLoggedException
brokerHostsMap
- Map of BrokerProxys to Host NamesConfigManagerProxyLoggedException
public com.ibm.broker.config.common.CommonServiceInterface addService(com.ibm.broker.config.common.CommonServiceInterface service) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException, com.ibm.broker.config.common.UnsupportedServiceException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
java.lang.IllegalArgumentException
com.ibm.broker.config.common.UnsupportedServiceException
ConfigManagerProxyPropertyNotInitializedException
public com.ibm.broker.config.common.CommonServiceInterface[] getServices() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
public com.ibm.broker.config.common.CommonServiceInterface getService(com.ibm.broker.config.common.CommonServiceInterface other) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
public void deleteService(com.ibm.broker.config.common.CommonServiceInterface service) throws com.ibm.broker.config.common.UnsupportedServiceException, ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
com.ibm.broker.config.common.UnsupportedServiceException
ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException