public class ExecutionGroupProxy extends DeployedObjectGroupProxy
Each execution group associated with a broker can be represented by an ExecutionGroupProxy.
In order to use ExecutionGroupProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); ExecutionGroupProxy e = b.getExecutionGroupByName("default");
com.ibm.broker.config.proxy.ExecutionGroupProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Acts as a container of deployed message flows. Provides the ability to deploy information to the execution group represented by each instance. |
Internal Collaborators | com.ibm.broker.config.proxy.MessageFlowProxy |
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 getQueues() Added getNodeTypes() Added setRuntimeProperty(String, String) Added getRuntimeProperty(String) Added getRuntimePropertyNames() Added getDeployedPolicySetBindingsNames() Added getDeployedPolicySetNames() 51619 2008-08-20 HDMPL v7 release: Deprecated immediate parameter on stopMessageFlows() Deprecated methods related to ACLs Added setServiceTrace() Added getLocalInstance() Added start() Added stop() Added setResourceStatisticsEnabled() Added getResourceStatisticsEnabled() Added getDebugPort() Added setDebugPort() Added isDebugPortActive() 54148.6 2009-08-05 HDMJB Added getServiceFederationManager() 80006.2 2011-04-10 HDCAB v8 release: Inherit from DeployedObjectGroupProxy Added getApplications() Added getApplication() Added getApplicationByName() Added getLibraries() Added getLibrary() Added getLibraryByName() Added startApplications() Added stopApplications() Added getResourceManagers() Added getResourceManagerByName() 80006.8 2011-10-10 HDDJS Added getDataCapture() methods
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
sccsid
Version information
|
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
Modifier | Constructor and Description |
---|---|
protected |
ExecutionGroupProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
DO NOT USE THIS CONSTRUCTOR - use BrokerProxy.getExecutionGroupByName()
instead.
|
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.
|
void |
clearRecordedTestData()
Clear all recorded test data for the execution group.
|
void |
clearRecordedTestData(java.util.Properties filterProps)
Clear recorded test data for the specified resources.
|
void |
clearRecordedTestData(java.lang.String appName,
java.lang.String libName,
java.lang.String flowName)
Clear recorded test data for the specified resources.
|
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 execution
group.
|
AccessControlEntry[] |
getAccessControlEntries()
Deprecated.
This method is unique to Configuration Manager connections,
and as such is no longer used as of WebSphere Message Broker V7.
|
ApplicationProxy |
getApplication(java.util.Properties props)
Returns the first ApplicationProxy object that matches the
filter specified by the Properties argument.
|
ApplicationProxy |
getApplicationByName(java.lang.String applicationName)
Returns the ApplicationProxy object with the supplied name,
or null if an application of that name does not exist or if
the supplied argument was null.
|
java.util.Enumeration<ApplicationProxy> |
getApplications(java.util.Properties filter)
Returns an Enumeration of all the ApplicationProxy objects
that match the filter specified by the Properties argument.
|
protected java.util.Properties |
getBasicProperties(boolean waitIfNotUpdated)
Returns a filtered list of the properties table associated with the
current object, filtered to basic properties only.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
DataCaptureProxy |
getDataCapture(java.util.Properties queryProps)
Returns a DataCaptureProxy object that contains the
DataCaptureEntry objects for the supplied query properties
|
DataCaptureProxy |
getDataCapture(java.lang.String dataCaptureStore,
DataCaptureEntry filterDataCaptureEntry)
Returns a DataCaptureProxy object that contains the
DataCaptureEntry objects for the supplied filter, represented
by a DataCaptureEntry, on the given DataCaptureStore.
|
int |
getDebugPort()
Returns the configured value of the debug port associated with the current execution group,
or 0 if the debug port has not been configured.
|
java.lang.String |
getInjectionMode()
Returns the current value of injection mode for this execution group.
|
java.util.Enumeration<LibraryProxy> |
getLibraries(java.util.Properties filter)
Deprecated.
As of Integration Bus V10, libraries have been
renamed to static libraries. Use getStaticLibraries instead.
|
LibraryProxy |
getLibrary(java.util.Properties props)
Deprecated.
As of Integration Bus V10, libraries have been
renamed to static libraries. Use getStaticLibrary instead.
|
LibraryProxy |
getLibraryByName(java.lang.String libraryName)
Deprecated.
As of Integration Bus V10, libraries have been
renamed to static libraries. Use getStaticLibraryByName instead.
|
static ExecutionGroupProxy |
getLocalInstance()
Returns the ExecutionGroupProxy object that represents the execution group in
which the current application is deployed.
|
MessageFlowProxy |
getMessageFlowByName(java.lang.String messageFlowName,
java.lang.String applicationName,
java.lang.String libraryName)
Returns the MessageFlowProxy object with the supplied name in
the named application and libary, or null if a flow of that
name does not exist at the given location or if the supplied
messageFlowName argument was null.
|
int |
getProcessorArchitecture()
Deprecated.
As of WebSphere Message Broker V7, the execution group's
processor architecture is wholly dependent on the OS architecture
of the underlying processor. Use BrokerProxy.getBrokerOSArch()
to determine the OS architecture.
|
java.util.List<RecordedTestData> |
getRecordedTestData(java.util.Properties filterProps)
Return recorded test data for this execution group.
|
int |
getRecordedTestDataCount(java.util.Properties filterProps)
Return the number of recorded messages available for retrieval.
|
ResourceManagerProxy |
getResourceManagerByName(java.lang.String resourceTypeName)
Returns the ResourceManagerProxy object responsible for
managing resources of the supplied type.
|
java.util.Enumeration<ResourceManagerProxy> |
getResourceManagers(java.util.Properties props)
Returns an enumeration of all the ResourceManagerProxy
objects that match the filter specified by the Properties
argument.
|
boolean |
getResourceStatisticsEnabled(java.lang.String resourceType)
Returns true only if statistics gathering is enabled for the resource type of the supplied name.
|
RestApiProxy |
getRestApi(java.util.Properties props)
Returns the first RestApiProxy object that matches the
filter specified by the Properties argument.
|
RestApiProxy |
getRestApiByName(java.lang.String restApiName)
Returns the RestApiProxy object with the supplied name,
or null if an REST API of that name does not exist or if
the supplied argument was null.
|
java.util.Enumeration<RestApiProxy> |
getRestApis(java.util.Properties filter)
Returns an Enumeration of all the RestApiProxy objects
that match the filter specified by the Properties argument.
|
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.
|
ServiceInterface |
getService(java.util.Properties props)
Returns the first ServiceInterface object that matches the
filter specified by the Properties argument.
|
ServiceInterface |
getServiceByName(java.lang.String serviceName)
Returns the ServiceInterface object with the supplied name,
or null if a service of that name does not exist or if
the supplied argument was null.
|
ServiceFederationManagerProxy |
getServiceFederationManager()
Deprecated.
|
java.util.Enumeration<ServiceInterface> |
getServices(java.util.Properties filter)
Returns an Enumeration of all the ServiceInterface objects
that match the filter specified by the Properties argument.
|
java.util.Enumeration<SharedLibraryProxy> |
getSharedLibraries(java.util.Properties filter)
Returns an Enumeration of all the SharedLibraryProxy objects
that match the filter specified by the Properties argument.
|
SharedLibraryProxy |
getSharedLibrary(java.util.Properties props)
Returns the first SharedLibraryProxy object that matches the
filter specified by the Properties argument.
|
SharedLibraryProxy |
getSharedLibraryByName(java.lang.String sharedLibraryName)
Returns the SharedLibraryProxy object with the supplied name,
or null if an shared library of that name does not exist or if
the supplied argument was null.
|
java.util.Enumeration<StaticLibraryProxy> |
getStaticLibraries(java.util.Properties filter)
Returns an Enumeration of all the StaticLibraryProxy objects
that match the filter specified by the Properties argument.
|
StaticLibraryProxy |
getStaticLibrary(java.util.Properties props)
Returns the first StaticLibraryProxy object that matches the
filter specified by the Properties argument.
|
StaticLibraryProxy |
getStaticLibraryByName(java.lang.String staticLibraryName)
Returns the StaticLibraryProxy object with the supplied name,
or null if an static library of that name does not exist or if
the supplied argument was null.
|
java.lang.String |
getTestRecordMode()
Returns the current value of the record mode for this execution group.
|
boolean |
injectTestData(Checkpoint checkpoint,
TestData data,
boolean waitForResponse)
Inject test data at a specified input node.
|
boolean |
injectTestData(java.util.Properties injectionProps,
boolean waitForResponse)
Inject test data at a specified input node.
|
boolean |
isDebugPortActive()
Returns true only if a debug port has been configured for the current execution
group AND that the debug port is currently listening.
|
boolean |
isRunEnabled()
Returns true only if the execution group is able to run when the
broker is started.
|
boolean |
isRunning()
Returns true only if the execution group is currently running.
|
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 |
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 |
setAllMessageFlowsRuntimeProperties(java.util.Properties props)
Asks the broker to configure an arbitrary
set of properties of all message flows owned by the execution group.
|
void |
setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary
property of all message flows owned by the execution group.
|
void |
setDebugPort(int newPortValue)
Configures the value of the debug port for the execution group.
|
void |
setInjectionMode(java.lang.String newInjectionMode)
Configures the injection mode setting for this execution group.
|
void |
setResourceStatisticsEnabled(java.lang.String resourceType,
boolean isEnabled)
Enables or disables resources statistics gathering for the supplied resource type.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary execution group
property.
|
void |
setServiceTrace(MessageFlowProxy.UserTrace newTrace)
Configures the service trace setting for the execution group.
|
void |
setTestRecordMode(java.lang.String newTestRecordMode)
Configures the record mode setting for this execution group.
|
void |
start()
Asks the broker to start the execution group process.
|
void |
startApplications()
Asks the broker to start all applications in the deployed
execution group.
|
void |
startApplications(boolean includeExecutionGroupFlows)
Asks the broker to start all applications in the deployed
execution group.
|
void |
stop()
Asks the broker to stop the execution group process.
|
void |
stop(BrokerProxy.StopMode stopMode) |
void |
stopApplications()
Stops all applications in the execution group, but allows the
execution group process to continue to run.
|
void |
stopApplications(boolean includeExecutionGroupFlows)
Stops all applications in the execution group, but allows the
execution group process to continue to run.
|
void |
stopApplications(boolean includeExecutionGroupFlows,
BrokerProxy.StopMode stopMode) |
static java.util.Properties |
withName(java.lang.String name)
Returns a new Properties object that has the name 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.
|
deleteDeployedObjects, deleteDeployedObjectsByName, deploy, deploy, deploy, deploy, deploy, getDeployedObjectByName, getDeployedObjectFromSubcomponentString, getDeployedObjects, getDeployedObjects, getDeployedObjectsCount, getDeployedPolicySetBindingsNames, getDeployedPolicySetNames, getMessageFlow, getMessageFlowByName, getMessageFlowDependencies, getMessageFlows, getMessageSets, getNodeTypes, getQueues, getSubFlow, getSubFlowByName, getSubFlows, setUserTrace, startMessageFlows, stopMessageFlows, stopMessageFlows, stopMessageFlows
checkTypeAndBase64DecodePropertyValue, checkTypeAndBase64EncodePropertyValue, clearPredictedNewSubcomponents, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, deleteManagedSubcomponents, deregisterListener, deregisterListener, elements, equals, execute, getAdvancedProperties, getAdvancedProperties, getBasicProperties, getGrandParentUUIDProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyBaseName, getPropertyInt, getPropertyInternal, getRefreshRequired, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, getUUIDOfGrandParent, getUUIDOfParent, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAUserDefinedObjectDestructor, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isLastPropertyIdentifier, isPartOfAPropertyGroup, isShared, predictPropertiesOfNewObject, refresh, refresh, registerListener, registerListener, registerListener, removeLocalProperty, setIsAwaitingSubmissionForCreation, setIsAwaitingSubmissionForDeletion, setLastBIPMessages, setLastCompletionCode, setLocalProperty, setLongDescription, setName, setProperties, setProperties, setRefreshRequired, setShortDescription, setTimeOfLastUpdate, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected ExecutionGroupProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.public static ExecutionGroupProxy getLocalInstance() throws ConfigManagerProxyLoggedException
When deploying an IBM Integration API (CMP) application inside a Java node, take care when using methods that might affect the message flow in which the IBM Integration API application is running; for example, stopping, deleting or redeploying the message flow. As the IBM Integration API 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 an
execution group.public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the run state could not be determined from
the broker.public boolean isRunEnabled() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the run state could not be determined from
the broker.public void stop() throws ConfigManagerProxyLoggedException
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 stop(BrokerProxy.StopMode stopMode) throws ConfigManagerProxyLoggedException
public void start() throws ConfigManagerProxyLoggedException
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 setServiceTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException
newTrace
- One of:
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.public int getProcessorArchitecture() throws ConfigManagerProxyPropertyNotInitializedException
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 DeployedObjectGroupProxy
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class DeployedObjectGroupProxy
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 void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty(). Changes are applied immediately.
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, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the execution group's user trace level property. 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 of a valid syntax.public void setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
To set runtime properties that affect the broker, use BrokerProxy.setRuntimeProperty(). To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty(). Changes are applied immediately.
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, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the execution group's user trace level property. 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.
setAllMessageFlowsRuntimeProperty
in class DeployedObjectGroupProxy
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 setAllMessageFlowsRuntimeProperties(java.util.Properties props) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
To set runtime properties that affect the broker, use BrokerProxy.setRuntimeProperty(). To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty(). Changes are applied immediately.
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, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the execution group's user trace level property. 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.
setAllMessageFlowsRuntimeProperties
in class DeployedObjectGroupProxy
props
- A set of properties to set on all message flows owned by the execution group.
The key is the complete object and property name of the property being manipulated.
The value is 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[] 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.public boolean getResourceStatisticsEnabled(java.lang.String resourceType) throws ConfigManagerProxyPropertyNotInitializedException
resourceType
- Name of the resource type to show statistics for, or null.ConfigManagerProxyPropertyNotInitializedException
- if the setting could not be
determined because the information was not supplied from the broker before a timeout occurred.public void setResourceStatisticsEnabled(java.lang.String resourceType, boolean isEnabled) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
resourceType
- Name of the resource type to modify, or null.isEnabled
- True to enable resource-level statistics for the supplied resource type,
or false to disable.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.ConfigManagerProxyPropertyNotInitializedException
- if the list of all resource
types could not be determined because the information was not supplied from the broker
before a timeout occurred.public ServiceFederationManagerProxy getServiceFederationManager() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the Service Federation Management object could not be retrieved
because the information was not supplied from the broker before a
timeout occurred.public DataCaptureProxy getDataCapture(java.lang.String dataCaptureStore, DataCaptureEntry filterDataCaptureEntry) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
dataCaptureStore
- The name of the DataCaptureStore to usefilterDataCaptureEntry
- The DataCaptureEntry to use as a filter on the DataCaptureStoreConfigManagerProxyPropertyNotInitializedException
- if the data capture entries could not be retrieved because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
public DataCaptureProxy getDataCapture(java.util.Properties queryProps) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
queryProps
- List of DATACAPTURE.* properties to use to drive the query and DATACAPTUREENTRIES.* to use as filters on the queryConfigManagerProxyPropertyNotInitializedException
- if the DataCaptureEntries could not be retrieved because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
public int getDebugPort() throws ConfigManagerProxyPropertyNotInitializedException
A non-zero value does not mean that the debug port is currently enabled. Use isDebugPortEnabled() to determine whether or not the debug port is currently enabled and listening.
Note: This method is functionally equivalent to getRuntimeProperty(AttributeConstants.EG_COMIBMJVMMANAGER_JVMDEBUGPORT_PROPERTY) followed by with a conversion to an int. Use getRuntimeProperty(AttributeConstants.EG_COMIBMJVMMANAGER_JVMDEBUGPORTACTIVEVALUE_PROPERTY) to return the actual value in use.
ConfigManagerProxyPropertyNotInitializedException
- if the setting could not be
determined because the information was not supplied from the broker before a timeout occurred.public boolean isDebugPortActive() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the setting could not be
determined because the information was not supplied from the broker before a timeout occurred.public void setDebugPort(int newPortValue) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
Note that enabling debug can significantly reduce the performance of the execution group.
After changing the value of the debug port, the execution group must be restarted in order for the new value to take effect. To do this using the IBM Integration API (CMP), use ExecutionGroupProxy.stop() followed by ExecutionGroupProxy.start().
A single execution group must have a unique port on any given machine, and that port cannot be used by any other process, execution group or broker on that machine. If the configured port is already in use when the execution group starts, the debugger will not be enabled for that execution group and isDebugPortActive() will return false.
newPortValue
- The TCP/IP port on which the debugger should listen,
or 0 to disable the debugger.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.ConfigManagerProxyPropertyNotInitializedException
- if the list of all resource
managers could not be determined because the information was not supplied from the broker
before a timeout occurred.public java.util.Enumeration<ApplicationProxy> getApplications(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
filter
- Filter to select which applications 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 applications deployed
to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if application information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
public ApplicationProxy getApplication(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
props
- Filter to select the ApplicationProxy
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 an arbitrary application
deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if application information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public ApplicationProxy getApplicationByName(java.lang.String applicationName) throws ConfigManagerProxyPropertyNotInitializedException
applicationName
- Name of the application to look upConfigManagerProxyPropertyNotInitializedException
- if application information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<RestApiProxy> getRestApis(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
filter
- Filter to select which REST APIs 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 REST APIs deployed
to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if REST API information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
public RestApiProxy getRestApi(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
props
- Filter to select the RestApiProxy
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 an arbitrary REST API
deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if REST API information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public RestApiProxy getRestApiByName(java.lang.String restApiName) throws ConfigManagerProxyPropertyNotInitializedException
restApiName
- Name of the REST API to look upConfigManagerProxyPropertyNotInitializedException
- if REST API information could not be determined because
the information was not supplied from the broker before a
timeout occurred.@Deprecated public java.util.Enumeration<LibraryProxy> getLibraries(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
filter
- Filter to select which libraries 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 libraries deployed
to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if library information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
@Deprecated public LibraryProxy getLibrary(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
props
- Filter to select the LibraryProxy
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 an arbitrary library
deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if library information could not be determined because
the information was not supplied from the broker before a
timeout occurred.@Deprecated public LibraryProxy getLibraryByName(java.lang.String libraryName) throws ConfigManagerProxyPropertyNotInitializedException
libraryName
- Name of the library to look upConfigManagerProxyPropertyNotInitializedException
- if library information could not be determined because the
information was not supplied from the broker before a timeout
occurred.public java.util.Enumeration<StaticLibraryProxy> getStaticLibraries(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
filter
- Filter to select which static libraries 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 static libraries deployed
to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if static library information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
public StaticLibraryProxy getStaticLibrary(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
props
- Filter to select the StaticLibraryProxy
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 an arbitrary static library
deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if static library information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public StaticLibraryProxy getStaticLibraryByName(java.lang.String staticLibraryName) throws ConfigManagerProxyPropertyNotInitializedException
staticLibraryName
- Name of the static library to look upConfigManagerProxyPropertyNotInitializedException
- if static library information could not be determined because the
information was not supplied from the broker before a timeout
occurred.public java.util.Enumeration<SharedLibraryProxy> getSharedLibraries(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
filter
- Filter to select which shared libraries 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 shared libraries deployed
to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if shared library information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
public SharedLibraryProxy getSharedLibrary(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
props
- Filter to select the SharedLibraryProxy
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 an arbitrary shared library
deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if shared library information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public SharedLibraryProxy getSharedLibraryByName(java.lang.String sharedLibraryName) throws ConfigManagerProxyPropertyNotInitializedException
sharedLibraryName
- Name of the shared library to look upConfigManagerProxyPropertyNotInitializedException
- if shared library information could not be determined because the
information was not supplied from the broker before a timeout
occurred.public MessageFlowProxy getMessageFlowByName(java.lang.String messageFlowName, java.lang.String applicationName, java.lang.String libraryName) throws ConfigManagerProxyPropertyNotInitializedException
messageFlowName
- Name of the message flow to look upapplicationName
- Name of the application in which to
look for the flow, or null if the flow is
not in an application.libraryName
- Name of the library in which to look
for the flow, or null if the flow is not
in a libraryConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void startApplications() throws ConfigManagerProxyLoggedException
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 startApplications(boolean includeExecutionGroupFlows) throws ConfigManagerProxyLoggedException
includeExecutionGroupFlows
- Indicates if the request is
to include flows at the execution group level. Therefore if
true is specified this means that all flows will be started
throughout the 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.public void stopApplications() throws ConfigManagerProxyLoggedException
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 stopApplications(boolean includeExecutionGroupFlows) throws ConfigManagerProxyLoggedException
includeExecutionGroupFlows
- Indicates if the request is
to include flows at the execution group level. Therefore if
true is specified this means that all flows will be started
throughout the 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.public void stopApplications(boolean includeExecutionGroupFlows, BrokerProxy.StopMode stopMode) throws ConfigManagerProxyLoggedException
public java.util.Enumeration<ResourceManagerProxy> getResourceManagers(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the ResourceManagerProxy objects that match the filter specified by the Properties argument.
props
- Filter to select the ResourceManagerProxy 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 resourcemanagers of
this execution group.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 ResourceManagerProxy getResourceManagerByName(java.lang.String resourceTypeName) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
resourceTypeName
- Name of the resource type.ConfigManagerProxyPropertyNotInitializedException
- if ResourceManager information could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
public java.util.Enumeration<ServiceInterface> getServices(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
filter
- Filter to select which applications 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 applications deployed
to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if service information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
public ServiceInterface getService(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
props
- Filter to select the service
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 an arbitrary service
deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if service information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public ServiceInterface getServiceByName(java.lang.String serviceName) throws ConfigManagerProxyPropertyNotInitializedException
serviceName
- Name of the service to look upConfigManagerProxyPropertyNotInitializedException
- if service information could not be determined because
the information was not supplied from the broker before a
timeout occurred.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).protected java.util.Properties getBasicProperties(boolean waitIfNotUpdated) throws ConfigManagerProxyPropertyNotInitializedException
This method will pause until the object has received at least one update from the broker. If an update is not received before the timeout specified in BrokerProxy.setRetryCharacteristics() is reached, AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned Properties object will contain a much smaller set of properties, that the IBM Integration API (CMP) has derived from other sources.
getBasicProperties
in class AdministeredObject
waitIfNotUpdated
- Only if this value is true, the method
will pause until the object has received at least one update from
the broker. If an update is not received before the timeout specified
in BrokerProxy.setRetryCharacteristics() is reached,
AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned
Properties object will contain a much smaller set of properties,
that the IBM Integration API (CMP) has derived from other
sources.ConfigManagerProxyPropertyNotInitializedException
public void setInjectionMode(java.lang.String newInjectionMode) throws ConfigManagerProxyLoggedException
When injection is enabled you can inject messages using injectTestData
.
newInjectionMode
- One of:
ConfigManagerProxyLoggedException
public java.lang.String getInjectionMode() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public void setTestRecordMode(java.lang.String newTestRecordMode) throws ConfigManagerProxyLoggedException
(You can retrieve recorded messages using getRecordedTestData
. You can clear recorded messages using clearRecordedTestData
.
newTestRecordMode
- One of:
ConfigManagerProxyLoggedException
public java.lang.String getTestRecordMode() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public void clearRecordedTestData() throws ConfigManagerProxyPropertyNotInitializedException
public void clearRecordedTestData(java.util.Properties filterProps) throws ConfigManagerProxyPropertyNotInitializedException
filterProps
- a list of properties specifying the application, library or flow to clear.ConfigManagerProxyPropertyNotInitializedException
public void clearRecordedTestData(java.lang.String appName, java.lang.String libName, java.lang.String flowName) throws ConfigManagerProxyPropertyNotInitializedException
appName
- specifies the application to clear recorded data fromlibName
- specifies the library to clear recorded data fromflowName
- specifies the message flow to clear recorded data fromConfigManagerProxyPropertyNotInitializedException
public java.util.List<RecordedTestData> getRecordedTestData(java.util.Properties filterProps) throws ConfigManagerProxyPropertyNotInitializedException
These are messages recorded whilst recording mode was enabled, and since the messages were last cleared.
Enable and disable recording mode using setTestRecordMode
.
Clear previously recorded messages using clearRecordedTestData
.
filterProps
- specifies the properties to filter on. Valid keys are specified at RecordedTestData.PROPERTY_*ConfigManagerProxyPropertyNotInitializedException
public int getRecordedTestDataCount(java.util.Properties filterProps) throws ConfigManagerProxyPropertyNotInitializedException
This is the number of messages recorded since the messages were last cleared.
You can clear recorded messages using clearRecordedTestData
.
You can retrieve recorded messages using getRecordedTestData
.
filterProps
- specifies the properties to filter on. Valid keys are specified at RecordedTestData.PROPERTY_*ConfigManagerProxyPropertyNotInitializedException
public boolean injectTestData(java.util.Properties injectionProps, boolean waitForResponse) throws ConfigManagerProxyPropertyNotInitializedException, java.io.UnsupportedEncodingException, ConfigManagerProxyLoggedException
Specify the node using the properties defined in AttributeConstants
; typically by defining your application, message flow and node.
(Enable and disable injection mode using setInjectionMode
.)
injectionProps
- specifies location and data to be injected.waitForResponse
- signals whether the method should wait for the injected message to finish processing before returning.ConfigManagerProxyPropertyNotInitializedException
java.io.UnsupportedEncodingException
ConfigManagerProxyLoggedException
public boolean injectTestData(Checkpoint checkpoint, TestData data, boolean waitForResponse) throws ConfigManagerProxyPropertyNotInitializedException, java.io.UnsupportedEncodingException, ConfigManagerProxyLoggedException
(Enable and disable injection mode using setInjectionMode
.)
checkpoint
- specifies location to inject the data.data
- specifies the data to be injected.waitForResponse
- signals whether the method should wait for the injected message to finish processing before returning.ConfigManagerProxyPropertyNotInitializedException
java.io.UnsupportedEncodingException
ConfigManagerProxyLoggedException