public class DeployedObjectGroupProxy extends AdministeredObject
com.ibm.broker.config.proxy.DeployedObjectGroupProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Acts as a container of deployed message flows and resources. Provides the ability to deploy information to execution groups, applications and libraries represented by each instance. |
Internal Collaborators | com.ibm.broker.config.proxy.MessageFlowProxy |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 80006.1 2011-04-06 HDCAB v8 Release
Modifier and Type | Method and Description |
---|---|
DeployResult |
deleteDeployedObjects(DeployedObject[] forDeletion,
long timeToWaitMs)
Attempts to remove deployed objects from the object group.
|
DeployResult |
deleteDeployedObjectsByName(java.lang.String[] forDeletion,
long timeToWaitMs)
Attempts to remove deployed objects from the object group.
|
void |
deploy(java.io.InputStream barStream)
Starts an incremental deploy of the Bar file, whose
contents are embedded in the supplied InputStream,
to the object group.
|
DeployResult |
deploy(java.io.InputStream barStream,
java.lang.String barFileLabel,
boolean isIncremental,
long timeToWaitMs)
Starts a deploy of the Bar file, whose contents are
embedded in the supplied InputStream, to the object group.
|
void |
deploy(java.lang.String barFileName)
Starts an incremental deploy of the Bar file pointed
to by the supplied filename, to the object group.
|
DeployResult |
deploy(java.lang.String barFileName,
boolean isIncremental,
long timeToWaitMs)
Starts a deploy of the Bar file pointed
to by the supplied filename, to the object group.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
DeployedObject |
getDeployedObjectByName(java.lang.String filename)
Returns a reference to the deployed object with the supplied
name (e.g.
|
DeployedObject |
getDeployedObjectFromSubcomponentString(java.lang.String subcomponentString)
If the supplied string is the value part of a property in the dependency or
subcomponent groups, AND it represents a DeployedObject instance, this
method returns a DeployedObject instance that represents it.
|
java.util.Enumeration<DeployedObject> |
getDeployedObjects()
Returns an Enumeration of all the objects directly
deployed to the current object group.
|
java.util.Enumeration<DeployedObject> |
getDeployedObjects(java.lang.String fileExtension)
Returns an Enumeration of all the deployed objects
with the supplied extension that are directly deployed to the current
object group.
|
int |
getDeployedObjectsCount(java.lang.String name)
Returns the number of deployed objects that match the
supplied name.
|
MessageFlowProxy.PolicySetBindingsName[] |
getDeployedPolicySetBindingsNames()
Returns the names of the PolicySetBindings associated with the message flows in use by this object group.
|
MessageFlowProxy.PolicySetName[] |
getDeployedPolicySetNames()
Returns the names of the PolicySets associated with the message flows in use by this object group.
|
MessageFlowProxy |
getMessageFlow(java.util.Properties props)
Returns the first MessageflowProxy object that matches the
filter specified by the Properties argument.
|
MessageFlowProxy |
getMessageFlowByName(java.lang.String messageFlowName)
Returns the MessageFlowProxy object with the supplied name, or null
if a flow of that name does not exist or if the supplied argument
was null.
|
java.util.Enumeration<DeployedObject> |
getMessageFlowDependencies()
Returns an Enumeration of all the dependencies directly
deployed to the current object group.
|
java.util.Enumeration<MessageFlowProxy> |
getMessageFlows(java.util.Properties filter)
Returns an Enumeration of all the MessageFlowProxy objects
that match the filter specified by the Properties argument.
|
java.util.Enumeration<DeployedObject> |
getMessageSets()
Returns an Enumeration of all the message sets
deployed to the current object group.
|
java.lang.String[] |
getNodeTypes()
Returns a list of the types of nodes used in this object group.
|
java.lang.String[] |
getQueues()
Returns a list of the MQ queues referenced by the message flows in use by this
deployed object group.
|
void |
setUserTrace(MessageFlowProxy.UserTrace newTrace)
Iterates through every deployed message flow configuring its
user trace settings.
|
void |
startMessageFlows()
Asks the broker to start all message flows in the
deployed object group.
|
void |
stopMessageFlows()
Stops all message flows in the deployed object group, but allows the
object group container (e.g.
|
void |
stopMessageFlows(boolean immediate)
Deprecated.
The immediate flag is ignored. Use stopMessageFlows() instead.
|
void |
stopMessageFlows(BrokerProxy.StopMode stopMode) |
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, setName, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
public java.util.Enumeration<MessageFlowProxy> getMessageFlows(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
Note that only those message flows that are deployed directly to the current deployed object group are returned. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those message flows deployed directly to the execution group will be returned by this method, and any message flows that have been deployed as part of an application or library will not be returned. To return the message flows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.
filter
- Filter to select which message flows 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 message flows directly deployed
to this deployed object group,ConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
public MessageFlowProxy getMessageFlow(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
Note that only those message flows that are deployed directly to the current deployed object group are accessible from this method. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those message flows deployed directly to the execution group can be returned by this method, and any message flows that have been deployed as part of an application or library cannot be returned. To return the message flows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.
props
- Filter to select the MessageFlowProxy
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 message flow
deployed to this deployed object group.ConfigManagerProxyPropertyNotInitializedException
- if message flow 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) throws ConfigManagerProxyPropertyNotInitializedException
Note that only those message flows that are deployed directly to the current deployed object group are accessible. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those message flows deployed directly to the execution group can be returned by this method, and any message flows that have been deployed as part of an application or library cannot be returned. To return the message flows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.
messageFlowName
- Name of the message flow to look upConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void startMessageFlows() 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 stopMessageFlows(boolean immediate) throws ConfigManagerProxyLoggedException
immediate
- Not usedConfigManagerProxyLoggedException
- 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
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(BrokerProxy.StopMode stopMode) throws ConfigManagerProxyLoggedException
public java.util.Enumeration<DeployedObject> getMessageSets() throws ConfigManagerProxyPropertyNotInitializedException
This method is the same as calling getDeployedObjects("dictionary").
ConfigManagerProxyPropertyNotInitializedException
- if message set information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public DeployedObject getDeployedObjectByName(java.lang.String filename) throws ConfigManagerProxyPropertyNotInitializedException
If there is more than one dependency that matches the supplied filter, an arbitrary (unspecified) match is returned.
This method discovers deployed objects that are required by message flows in order to run (e.g. message sets). In order to discover message flows themselves, use getMessageFlowByName() instead.
filename
- A non-null value means to return
the object with the supplied name. A null value will return
an arbitrary object deployed to this object group.ConfigManagerProxyPropertyNotInitializedException
- if deployed object information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<DeployedObject> getMessageFlowDependencies() throws ConfigManagerProxyPropertyNotInitializedException
This method discovers deployed objects that might be required by message flows in order to run (e.g. message sets). In order to discover everything deployed to this object group (i.e. including message flows themselves), use getDeployedObjects() instead.
ConfigManagerProxyPropertyNotInitializedException
- if dependency information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<DeployedObject> getDeployedObjects() throws ConfigManagerProxyPropertyNotInitializedException
This method discovers all objects deployed on the object group, including message flows, message sets and others.
ConfigManagerProxyPropertyNotInitializedException
- if deployed object information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<DeployedObject> getDeployedObjects(java.lang.String fileExtension) throws ConfigManagerProxyPropertyNotInitializedException
fileExtension
- A non-null value means to filter
the results so only those dependencies with the supplied
file extension are returned. A null value will return
all dependencies deployed to this execution group.ConfigManagerProxyPropertyNotInitializedException
- if deployed object information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public int getDeployedObjectsCount(java.lang.String name) throws ConfigManagerProxyPropertyNotInitializedException
name
- Name of the object to matchConfigManagerProxyPropertyNotInitializedException
- if the deployed objects count could not be determined because
the information was not supplied from the broker before a
timeout occurred.public DeployedObject getDeployedObjectFromSubcomponentString(java.lang.String subcomponentString)
subcomponentString
- String representation of a subcomponentpublic void setUserTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
newTrace
- One of:
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker or if the current user is not authorized to
view the list of message flows on this 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.ConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public DeployResult deploy(java.lang.String barFileName, boolean isIncremental, long timeToWaitMs) throws ConfigManagerProxyLoggedException, java.io.IOException
barFileName
- Path and file name of the Bar file,
relative to the current directory.isIncremental
- If true, the contents of the Bar
file will add or modify what has already been
deployed on the execution group.
If false, the contents of the execution group will
be completely cleared before deployment (also known
as a "complete" deploy).timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the Bar file
could not be sent to the broker.java.io.FileNotFoundException
- if the Bar file could not be foundjava.io.IOException
- if the file could not be closed.
In this case the deployment might have succeeded.public DeployResult deploy(java.io.InputStream barStream, java.lang.String barFileLabel, boolean isIncremental, long timeToWaitMs) throws ConfigManagerProxyLoggedException
barStream
- InputStream containing the BAR file
contents. The first byte read by the stream must be the
first byte of the Bar file's contents.barFileLabel
- the name of the Bar file being
deployed. Every DeployedObject that results from
this deployment will return this value (which may be null)
from the getBARFileName() method.isIncremental
- If true, the contents of the Bar
file will add or modify what has already been
deployed on the execution group.
If false, the contents of the execution group will
be completely cleared before deployment (also known
as a "complete" deploy).timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the Bar file
could not be sent to the broker.public void deploy(java.lang.String barFileName) throws ConfigManagerProxyLoggedException, java.io.IOException
barFileName
- Path and file name of the Bar file,
relative to the current directory.ConfigManagerProxyLoggedException
- if the Bar file
could not be sent to the broker.java.io.FileNotFoundException
- if the Bar file could not be foundjava.io.IOException
- if the file could not be closed.
In this case the deployment might have succeeded.public void deploy(java.io.InputStream barStream) throws ConfigManagerProxyLoggedException
barStream
- InputStream containing the Bar file contents.
The first byte read by the stream must be the
first byte of the Bar file's contents.ConfigManagerProxyLoggedException
- if the Bar file
could not be sent to the broker.public DeployResult deleteDeployedObjects(DeployedObject[] forDeletion, long timeToWaitMs) throws ConfigManagerProxyLoggedException
forDeletion
- representing the DeployedObject objects
that require deletion (e.g. message flows, message sets).
If the value is null or empty, this method does nothing.
If an element in the array is null, the element is ignored.timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the request could
not be sent to the brokerpublic DeployResult deleteDeployedObjectsByName(java.lang.String[] forDeletion, long timeToWaitMs) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
It is acceptable to remove objects of different types in the same request. It is the caller's responsibility to ensure that the supplied names refer to exactly one object deployed in the execution group. If a deployed object with the supplied name cannot be found, that element of the array is ignored and no exception is thrown. If an ambiguous String is supplied (e.g. "doc1" when "doc1.xsl" and "doc1.dictionary" are both deployed) then the call will fail with ConfigManagerProxyLoggedException.
forDeletion
- An array of Strings, with each element
being the name (e.g. "mf1") or fullname (e.g. "mf1.cmf")
of an object that is to be removed from the execution group.
If the array is null or empty, this method does nothing.
If an element in the array is null, the element is ignored.timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the request could
not be sent to the broker, or if at least one supplied name is ambiguous.ConfigManagerProxyPropertyNotInitializedException
- if deployed object information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String[] getQueues() throws ConfigManagerProxyPropertyNotInitializedException
This method works by aggregating the responses from calling the MessageFlowProxy.getQueues() method for each message flow that is currently deployed to the execution group.
ConfigManagerProxyPropertyNotInitializedException
- if queue information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public MessageFlowProxy.PolicySetName[] getDeployedPolicySetNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
policy set information was not supplied from the broker before a
timeout occurred.public MessageFlowProxy.PolicySetBindingsName[] getDeployedPolicySetBindingsNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if policy set bindings information 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 MessageFlowProxy.getNodeTypes() method for each message flow that is currently deployed to the execution group.
ConfigManagerProxyPropertyNotInitializedException
- if node information could not be determined because
the information was not supplied from the broker before a
timeout occurred.public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject