public class ResourceManagerProxy extends AdministeredObject
Each ResourceManagerProxy instance represents a component of the execution group that is responsible for interacting with a specific protocol or endpoint type. Examples include the JMS and CICS resource managers. Each instance can report on the capabilities supported by the resource manager, such as whether activity logging is available.
In order to use ResourceManagerProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
BrokerConnectionParameters bcp = MQBrokerConnectionParameters("localhost", 1414, "QMGR"); BrokerProxy b = BrokerProxy.getInstance(bcp); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); ResourceManagerProxy rmp = e.getResourceManagerByName("CICS");
com.ibm.broker.config.proxy.ResourceManagerProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Describes a resource manager and its supported capabilities. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 80006 2011-07-18 HOSIE V8 release (initial creation) 3779 2012-05-08 HDCAB - Added run-time property support
Modifier and Type | Method and Description |
---|---|
AdminQueueEntry |
execute(java.lang.String action,
java.util.Properties actionParameters,
java.lang.String objectName,
java.util.Properties objectProperties)
Asks the broker to execute an action against this
resource manager.
|
ActivityLogProxy |
getActivityLog()
Returns an ActivityLogProxy object that contains the activity
log messages that are associated with the current resource manager.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
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 runtime configurable service properties
associated with this object.
|
boolean |
isActivityLogSupported()
Returns true if this resource manager supports an activity
log, else returns false
|
void |
setLongDescription(java.lang.String desc)
Calling this method always results in a
ConfigManagerProxyLoggedException being thrown.
|
void |
setName(java.lang.String name)
Calling this method always results in a
ConfigManagerProxyLoggedException being thrown.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary resource manager
property.
|
void |
setShortDescription(java.lang.String desc)
Calling this method always results in a
ConfigManagerProxyLoggedException being thrown.
|
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, setProperties, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public boolean isActivityLogSupported() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
public ActivityLogProxy getActivityLog() throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException
- if the log could not be retrieved because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the log could not be created because
the information was not supplied from the broker before a
timeout occurred.public void setName(java.lang.String name) throws ConfigManagerProxyLoggedException
setName
in class AdministeredObject
name
- Does nothingConfigManagerProxyLoggedException
- to indicate this
method should not be called.public void setShortDescription(java.lang.String desc) throws ConfigManagerProxyLoggedException
setShortDescription
in class AdministeredObject
desc
- Does nothingConfigManagerProxyLoggedException
- to indicate this
method should not be called.public void setLongDescription(java.lang.String desc) throws ConfigManagerProxyLoggedException
setLongDescription
in class AdministeredObject
desc
- Does nothingConfigManagerProxyLoggedException
- to indicate this
method should not be called.public AdminQueueEntry execute(java.lang.String action, java.util.Properties actionParameters, java.lang.String objectName, java.util.Properties objectProperties) throws ConfigManagerProxyLoggedException
action
- the action to executeactionParameters
- parameters to apply to the actionobjectName
- optional objectName to which to apply the
action.objectProperties
- properties that are applied to the
objectConfigManagerProxyLoggedException
- if the request could not be
sent to the broker, or (only if synchronous updates have been enabled)
the request was not successfully processed by the broker.ConfigManagerProxyRequestTimeoutException
- if synchronous updates
have been enabled and a response was not received by the broker before
a timeout occurred. (Note that this exception type extends
ConfigManagerProxyLoggedException).ConfigManagerProxyRequestFailureException
- if synchronous updates
have been enabled and the request was rejected by the broker.
(Note that this exception type extends ConfigManagerProxyLoggedException).public void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible.
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 of a valid syntax.public java.lang.String[] getRuntimePropertyNames()
public java.lang.String getRuntimeProperty(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 property 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.