com.ibm.broker.config.proxy

Class ApplicationProxy

java.lang.Object

com.ibm.broker.config.proxy.AdministeredObject

com.ibm.broker.config.proxy.DeployedObjectGroupProxy

com.ibm.broker.config.proxy.ApplicationProxy

All Implemented Interfaces:

com.ibm.broker.config.common.CommonServiceInterface, DeployableObject, DeployedObject, ServiceInterface

public class ApplicationProxy
extends DeployedObjectGroupProxy
implements DeployedObject, ServiceInterface

Each application deployed to an execution group can be represented by an ApplicationProxy.

In order to use ApplicationProxy 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");
     ApplicationProxy appl = e.getApplicationByName("application1");
 

com.ibm.broker.config.proxy.ApplicationProxy extends com.ibm.broker.config.proxy.DeployedObjectGroupProxy implements com.ibm.broker.config.proxy.DeployedObject
Responsibilities	Acts as a container of deployed message flows. Provides the ability to deploy information to the application represented by each instance.
Internal Collaborators	com.ibm.broker.config.proxy.MessageFlowProxy

 Change Activity:
 -------- ----------- -------------   ------------------------------------
 Reason:  Date:       Originator:     Comments:
 -------- ----------- -------------   ------------------------------------
 80006.1  2011-04-10  HDCAB           Initial creation

 

Field Summary

Fields inherited from interface com.ibm.broker.config.proxy.DeployableObject

BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD

Method Summary

Methods

Modifier and Type	Method and Description
DeployResult	deleteDeployedObjects(DeployedObject[] forDeletion, long timeToWaitMs) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
DeployResult	deleteDeployedObjectsByName(java.lang.String[] forDeletion, long timeToWaitMs) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
void	deploy(java.io.InputStream barStream) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
DeployResult	deploy(java.io.InputStream barStream, java.lang.String barFileLabel, boolean isIncremental, long timeToWaitMs) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
void	deploy(java.lang.String barFileName) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
DeployResult	deploy(java.lang.String barFileName, boolean isIncremental, long timeToWaitMs) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
boolean	fullNameMatches(java.lang.String fileName) Tests if the name of this deployed object matches the fileName passed in.
java.lang.String	getBARFileName() Returns the name of the BAR file that was used to deploy the application to the execution 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.
java.util.Properties	getDeployProperties() Returns a list of the properties associated with the deployment of this application.
java.util.Date	getDeployTime() Returns the time that the current message flow was last deployed to the execution group.
java.util.Vector<java.lang.String>	getErrorHandlerNames() Returns a Vector of all the names of the implementation objects for error handlers for this service.
ExecutionGroupProxy	getExecutionGroup() Returns a reference to the execution group on which this application was deployed.
java.lang.String	getFileExtension() Returns the file extension relevant to applications, not preceded by a '.' character.
java.lang.String	getFullName() Returns the name of the current deployable as it existed in the BAR file at deployment time, including any file extension but excluding any path information.
java.util.Map<java.lang.String,java.lang.String>	getInterfaceFiles() Returns a Map of all the WSDL and XSD files for this service.
java.lang.String[]	getKeywords() Returns the set of keywords for this deployed object which were found embedded in the object at deploy time.
java.lang.String	getKeywordValue(java.lang.String keyword) Returns the value of the supplied keyword.
java.util.Enumeration<LibraryProxy>	getLibraries(java.util.Properties filter) Returns an Enumeration of all the LibraryProxy objects that match the filter specified by the Properties argument.
LibraryProxy	getLibrary(java.util.Properties props) Returns the first LibraryProxy object that matches the filter specified by the Properties argument.
LibraryProxy	getLibraryByName(java.lang.String libraryName) Returns the LibraryProxy object with the supplied name, or null if an library of that name does not exist or if the supplied argument was null.
MessageFlowProxy	getMessageFlowByName(java.lang.String messageFlowName, java.lang.String libraryName) Returns the MessageFlowProxy object with the supplied name in the named libary, or null if a flow of that name does not exist at the given location or if the supplied messageFlowName argument was null.
java.util.Date	getModifyTime() Returns the time that the current message flow was last modified, according to the file modification associated with the cmf file in the broker archive.
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.
java.lang.String	getServiceDescriptor() This method returns the service descriptor
java.lang.String	getServiceName()
ServiceOperation	getServiceOperation(java.lang.String operationName) Returns a ServiceOperation object for a particular operation for this service.
java.util.Enumeration<ServiceOperation>	getServiceOperations() Returns an Enumeration of all the ServiceOperation objects for this service.
java.net.URL	getServiceQueryURL() Returns the URL for querying the WSDL for the service, if this service has a binding that uses WSDL (and ?wsdl support is wswitch on for the service)
java.net.URL	getServiceURL() Returns the URL for the service, if this service has a binding that can be represented as a URL
java.lang.String	getStartMode() Returns the current value of start mode for this application
java.lang.String	getVersion() Returns the version string associated with the current message flow.
boolean	isJavaIsolated() Returns the current value of Java isolation for this application or integration service.
boolean	isRunEnabled() Returns true only if the application is able to run when the execution group is started.
boolean	isRunning() Returns true only if the application is currently running.
boolean	isServiceInternalComponent(java.lang.String objectName) Returns true if a named resource (a flow, for example) is an internal piece of the service
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	setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) Asks the broker to configure an arbitrary application property.
void	setStartMode(java.lang.String newStartMode) Configures the start mode setting for the application.
void	start() Asks the broker to start the execution group process.
void	stop() Asks the broker to stop the Application.
void	stop(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.

Methods inherited from class com.ibm.broker.config.proxy.DeployedObjectGroupProxy

getDeployedObjectByName, getDeployedObjectFromSubcomponentString, getDeployedObjects, getDeployedObjects, getDeployedObjectsCount, getDeployedPolicySetBindingsNames, getDeployedPolicySetNames, getMessageFlow, getMessageFlowByName, getMessageFlowDependencies, getMessageFlows, getMessageSets, getNodeTypes, getQueues, setUserTrace, startMessageFlows, stopMessageFlows, stopMessageFlows, stopMessageFlows

Methods inherited from class com.ibm.broker.config.proxy.AdministeredObject

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

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.broker.config.proxy.DeployableObject

getName

Method Detail

isRunning

public boolean isRunning()
                  throws ConfigManagerProxyPropertyNotInitializedException

Returns true only if the application is currently running. This method reports the actual run state of the application; use isRunEnabled() to report whether the application is configured to run when the execution group starts (which can return true even if the execution group is stopped).

Returns:

boolean True if and only if the application is running.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.

isRunEnabled

public boolean isRunEnabled()
                     throws ConfigManagerProxyPropertyNotInitializedException

Returns true only if the application is able to run when the execution group is started. This method reports the logical runstate of the application, which means that it can return 'true' even if the execution group in which the broker is defined is currently stopped. Use isRunning() to report whether the application is currently running.

Returns:

boolean True if and only if the application is able to run when the execution group is started.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.

stop

public void stop()
          throws ConfigManagerProxyLoggedException

Asks the broker to stop the Application. If the application is already stopped, the broker will do nothing.

Throws:

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.

stop

public void stop(BrokerProxy.StopMode stopMode)
          throws ConfigManagerProxyLoggedException

Throws:

ConfigManagerProxyLoggedException

start

public void start()
           throws ConfigManagerProxyLoggedException

Asks the broker to start the execution group process. Only those message flows that were running when the execution group process was last stopped will be restarted. All other message flows will remain stopped until they are explicitly started.

Throws:

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.

getStartMode

public java.lang.String getStartMode()
                              throws ConfigManagerProxyPropertyNotInitializedException

Returns the current value of start mode for this application

Returns:

String One of:

• AttributeConstants.STARTMODE_MAINTAINED which means at deploy time or restart the application will start based on its isRunEnabled value.
• AttributeConstants.STARTMODE_MANUAL which means at deploy time or restart the application will be stopped.
• AttributeConstants.STARTMODE_AUTOMATIC which means at deploy time or restart the application will be running.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the field could not be determined because the value has not yet been supplied to from the broker.

setStartMode

public void setStartMode(java.lang.String newStartMode)
                  throws ConfigManagerProxyLoggedException

Configures the start mode setting for the application.

Parameters:

newStartMode - One of:

• AttributeConstants.STARTMODE_MAINTAINED which means at deploy time or restart the application will start based on its isRunEnabled value.
• AttributeConstants.STARTMODE_MANUAL which means at deploy time or restart the application will be stopped.
• AttributeConstants.STARTMODE_AUTOMATIC which means at deploy time or restart the application will be running.

Throws:

ConfigManagerProxyLoggedException

isJavaIsolated

public boolean isJavaIsolated()
                       throws ConfigManagerProxyPropertyNotInitializedException

Returns the current value of Java isolation for this application or integration service. If an application or integration service has Java isolation enabled, then any Java deployed in that application or integration service is not visible to any other applications or integration services.

Returns:

true if Java isolation is enabled, false if Java isolation is disabled.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the field could not be determined because the value has not yet been supplied to from the broker.

withUUID

public 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. This provides an easy way of supplying filters to the get*() calls.

withName

public 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. This provides an easy way of supplying filters to the get*() calls.

getConfigurationObjectType

public ConfigurationObjectType getConfigurationObjectType()

Returns the ConfigurationObjectType associated with this AdministeredObject type.

Overrides:

getConfigurationObjectType in class DeployedObjectGroupProxy

Returns:

ConfigurationObjectType associated with this class.

getConfigurationObjectTypeOfParent

public ConfigurationObjectType getConfigurationObjectTypeOfParent()

Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.

Overrides:

getConfigurationObjectTypeOfParent in class DeployedObjectGroupProxy

Returns:

ConfigurationObjectType associated with the logical parent of this class.

setRuntimeProperty

public void setRuntimeProperty(java.lang.String objectAndPropertyName,
                      java.lang.String propertyValue)
                        throws ConfigManagerProxyLoggedException,
                               java.lang.IllegalArgumentException

Asks the broker to configure an arbitrary application property. The set of properties configurable using this method are those available in the getRuntimePropertyNames() method.

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.

Parameters:

objectAndPropertyName - The complete object and property name of the property being manipulated

propertyValue - The new value to associate with the property

Throws:

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 objectAndPropertyName is not of a valid syntax.

getRuntimePropertyNames

public java.lang.String[] getRuntimePropertyNames()

Returns a string array of all runtime configurable service properties associated with this object. Use getRuntimeProperty() to get the current value associated with a given property and setRuntimeProperty() to set it. Each String is of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters of mqsireportproperties. The '/' character that separates the two values is defined in AttributeConstants.OBJECT_NAME_DELIMITER.

Returns:

String[] containing configurable service property names that have been defined on the broker

getRuntimeProperty

public java.lang.String getRuntimeProperty(java.lang.String objectAndPropertyName)
                                    throws ConfigManagerProxyPropertyNotInitializedException,
                                           java.lang.IllegalArgumentException

Returns the value of the runtime property with the supplied name. The set of properties discoverable in this way are those reported by the getRuntimePropertyNames() method.

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.

Parameters:

objectAndPropertyName - The name of the property to be reported

Returns:

String The value of the supplied property. A value of null means that the property does not exist or has not been set on the broker.

Throws:

ConfigManagerProxyPropertyNotInitializedException - 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.

getDeployProperties

public java.util.Properties getDeployProperties()
                                         throws ConfigManagerProxyPropertyNotInitializedException

Returns a list of the properties associated with the deployment of this application.

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 be null.

Specified by:

getDeployProperties in interface DeployedObject

Returns:

Properties where each key is a deploy related property with its associated value. Keywords are not returned as part of the returned properties. Returns null if no deploy related properties are found.

Throws:

ConfigManagerProxyPropertyNotInitializedException

getExecutionGroup

public ExecutionGroupProxy getExecutionGroup()
                                      throws ConfigManagerProxyLoggedException

Returns a reference to the execution group on which this application was deployed. This method is the same as calling getParent(), except that getExecutionGroup() returns an ExecutionGroupProxy object rather than an object of the parent AdministeredObject type.

Specified by:

getExecutionGroup in interface DeployedObject

Returns:

ExecutionGroup

Throws:

ConfigManagerProxyLoggedException - if the parent object is not immediately available and has to be requested from the broker, but the request could not be sent to the broker.

See Also:

DeployedObject.getExecutionGroup()

getBARFileName

public java.lang.String getBARFileName()
                                throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the BAR file that was used to deploy the application to the execution group. This method will return null if the BAR file was deployed by specifying an InputStream parameter to ExecutionGroupProxy.deploy() and a valid BAR file label was not supplied.

Specified by:

getBARFileName in interface DeployedObject

Returns:

String name of the BAR file that deployed the message flow

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

getKeywords

public java.lang.String[] getKeywords()
                               throws ConfigManagerProxyPropertyNotInitializedException

Returns the set of keywords for this deployed object which were found embedded in the object at deploy time. Use DeployedObject.getKeywordValue() to look up the value of a given keyword.

See the DeployedObject class for an overview of how to associate keywords with deployed objects.

Specified by:

getKeywords in interface DeployableObject

Returns:

String[] the set of keywords that were found.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

See Also:

DeployableObject.getKeywords()

getKeywordValue

public java.lang.String getKeywordValue(java.lang.String keyword)
                                 throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the supplied keyword. If the supplied keyword was not found during the deployment of this object, this method returns null.

See the DeployedObject class for an overview of how to associate keywords with deployed objects.

Specified by:

getKeywordValue in interface DeployableObject

Parameters:

keyword - The keyword to look up

Returns:

String value of the supplied keyword, or null if the keyword could not be found for the object.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

See Also:

DeployableObject.getKeywordValue(java.lang.String)

getVersion

public java.lang.String getVersion()
                            throws ConfigManagerProxyPropertyNotInitializedException

Returns the version string associated with the current message flow. If the version string was not set by the user the return value is null.

Specified by:

getVersion in interface DeployableObject

Returns:

String version information

Throws:

ConfigManagerProxyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

See Also:

DeployableObject.getVersion()

getDeployTime

public java.util.Date getDeployTime()

Returns the time that the current message flow was last deployed to the execution group.

Specified by:

getDeployTime in interface DeployedObject

Returns:

Date the time of the most recent deployment.

See Also:

DeployedObject.getDeployTime()

getModifyTime

public java.util.Date getModifyTime()

Returns the time that the current message flow was last modified, according to the file modification associated with the cmf file in the broker archive.

Specified by:

getModifyTime in interface DeployableObject

Returns:

Date the time of the last modification.

See Also:

DeployableObject.getModifyTime()

getFileExtension

public java.lang.String getFileExtension()

Returns the file extension relevant to applications, not preceded by a '.' character. This is the constant string "appzip".

Specified by:

getFileExtension in interface DeployableObject

Returns:

String file extension

See Also:

DeployableObject.getFileExtension()

getFullName

public java.lang.String getFullName()
                             throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the current deployable as it existed in the BAR file at deployment time, including any file extension but excluding any path information.

Specified by:

getFullName in interface DeployableObject

Returns:

String name of the deployable

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

getServiceName

public java.lang.String getServiceName()

Specified by:

getServiceName in interface com.ibm.broker.config.common.CommonServiceInterface

fullNameMatches

public boolean fullNameMatches(java.lang.String fileName)
                        throws ConfigManagerProxyPropertyNotInitializedException

Tests if the name of this deployed object matches the fileName passed in. This method returns true if the deployed object name matches either with the source extension or the compiled resource extension

Specified by:

fullNameMatches in interface DeployedObject

Returns:

boolean true if the fileName matches the deployed resource name

Throws:

ConfigManagerProxyLoggedException - if the parent object is not immediately available and has to be requested from the broker, but the request could not be sent to the broker.

ConfigManagerProxyPropertyNotInitializedException

getLibraries

public java.util.Enumeration<LibraryProxy> getLibraries(java.util.Properties filter)
                                                 throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all the LibraryProxy objects that match the filter specified by the Properties argument.

Parameters:

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 application.

Returns:

Enumeration The LibraryProxy objects that matched the supplied filter.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if library information could not be determined because the information was not supplied from the broker before a timeout occurred.

See Also:

AttributeConstants

getLibrary

public LibraryProxy getLibrary(java.util.Properties props)
                        throws ConfigManagerProxyPropertyNotInitializedException

Returns the first LibraryProxy object that matches the filter specified by the Properties argument. If multiple libraries match the supplied filter, an arbitrary match is returned.

Parameters:

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 application.

Returns:

LibraryProxy The first object that matched the supplied filter, or null if no objects matched.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if library information could not be determined because the information was not supplied from the broker before a timeout occurred.

getLibraryByName

public LibraryProxy getLibraryByName(java.lang.String libraryName)
                              throws ConfigManagerProxyPropertyNotInitializedException

Returns the LibraryProxy object with the supplied name, or null if an library of that name does not exist or if the supplied argument was null.

Parameters:

libraryName - Name of the library to look up

Returns:

LibraryProxy Object representing the named library

Throws:

ConfigManagerProxyPropertyNotInitializedException - if library information could not be determined because the information was not supplied from the broker before a timeout occurred.

getMessageFlowByName

public MessageFlowProxy getMessageFlowByName(java.lang.String messageFlowName,
                                    java.lang.String libraryName)
                                      throws ConfigManagerProxyPropertyNotInitializedException

Returns the MessageFlowProxy object with the supplied name in the named libary, or null if a flow of that name does not exist at the given location or if the supplied messageFlowName argument was null.

Parameters:

messageFlowName - Name of the message flow to look up

libraryName - Name of the library in which to look for the flow, or null if the flow is not in a library

Returns:

MessageFlowProxy Object representing the named message flow

Throws:

ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.

setName

public void setName(java.lang.String name)
             throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the name of an application.

Overrides:

setName in class AdministeredObject

Parameters:

name - (this is ignored)

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

deploy

public DeployResult deploy(java.lang.String barFileName,
                  boolean isIncremental,
                  long timeToWaitMs)
                    throws ConfigManagerProxyLoggedException,
                           java.io.IOException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to deploy to an application. All parameters are ignored.

Overrides:

deploy in class DeployedObjectGroupProxy

Parameters:

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:

• A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
• A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
• A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until responses have been received from the broker.
• If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
• If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deployment, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.

Returns:

DeployResult object that can be used to query the results of the deployment.

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

java.io.FileNotFoundException - if the Bar file could not be found

java.io.IOException - if the file could not be closed. In this case the deployment might have succeeded.

deploy

public DeployResult deploy(java.io.InputStream barStream,
                  java.lang.String barFileLabel,
                  boolean isIncremental,
                  long timeToWaitMs)
                    throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to deploy to an application. All parameters are ignored.

Overrides:

deploy in class DeployedObjectGroupProxy

Parameters:

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:

• A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
• A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the connected broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
• A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until responses have been received from the broker.
• If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
• If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deployment, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.

Returns:

DeployResult object that can be used to query the results of the deployment.

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

deploy

public void deploy(java.lang.String barFileName)
            throws ConfigManagerProxyLoggedException,
                   java.io.IOException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to deploy to an application. All parameters are ignored.

Overrides:

deploy in class DeployedObjectGroupProxy

Parameters:

barFileName - Path and file name of the Bar file, relative to the current directory.

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

java.io.FileNotFoundException - if the Bar file could not be found

java.io.IOException - if the file could not be closed. In this case the deployment might have succeeded.

deploy

public void deploy(java.io.InputStream barStream)
            throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to deploy to an application. All parameters are ignored.

Overrides:

deploy in class DeployedObjectGroupProxy

Parameters:

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.

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

deleteDeployedObjects

public DeployResult deleteDeployedObjects(DeployedObject[] forDeletion,
                                 long timeToWaitMs)
                                   throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to delete deployed objects from an application. All parameters are ignored.

Overrides:

deleteDeployedObjects in class DeployedObjectGroupProxy

Parameters:

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:

• A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
• A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the connected broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
• A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until the response has been received from the broker.
• If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
• If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deletion, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

deleteDeployedObjectsByName

public DeployResult deleteDeployedObjectsByName(java.lang.String[] forDeletion,
                                       long timeToWaitMs)
                                         throws ConfigManagerProxyLoggedException,
                                                ConfigManagerProxyPropertyNotInitializedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to delete deployed objects from an application. All parameters are ignored.

Overrides:

deleteDeployedObjectsByName in class DeployedObjectGroupProxy

Parameters:

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:

• A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
• A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
• A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until the response has been received from the broker affected by the deploy.
• If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
• If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deletion, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

ConfigManagerProxyPropertyNotInitializedException - if deployed object information could not be determined because the information was not supplied from the broker before a timeout occurred.

getServiceDescriptor

public java.lang.String getServiceDescriptor()
                                      throws ConfigManagerProxyPropertyNotInitializedException

This method returns the service descriptor

Specified by:

getServiceDescriptor in interface ServiceInterface

Returns:

Service descriptor string

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

ConfigManagerProxyPropertyNotInitializedException

getErrorHandlerNames

public java.util.Vector<java.lang.String> getErrorHandlerNames()
                                                        throws ConfigManagerProxyPropertyNotInitializedException

Returns a Vector of all the names of the implementation objects for error handlers for this service.

Specified by:

getErrorHandlerNames in interface ServiceInterface

Returns:

Vector The names of the implementation objects

Throws:

ConfigManagerProxyPropertyNotInitializedException - if operation information could not be determined because the information was not supplied from the broker before a timeout occurred.

getServiceOperation

public ServiceOperation getServiceOperation(java.lang.String operationName)
                                     throws ConfigManagerProxyPropertyNotInitializedException

Returns a ServiceOperation object for a particular operation for this service.

Specified by:

getServiceOperation in interface ServiceInterface

Returns:

Enumeration The ServiceOperation object, or null if the operation doesn't exist.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if operation information could not be determined because the information was not supplied from the broker before a timeout occurred.

getServiceOperations

public java.util.Enumeration<ServiceOperation> getServiceOperations()
                                                             throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all the ServiceOperation objects for this service.

Specified by:

getServiceOperations in interface ServiceInterface

Returns:

Enumeration The ServiceOperation objects

Throws:

ConfigManagerProxyPropertyNotInitializedException - if operation information could not be determined because the information was not supplied from the broker before a timeout occurred.

See Also:

AttributeConstants

isServiceInternalComponent

public boolean isServiceInternalComponent(java.lang.String objectName)
                                   throws ConfigManagerProxyPropertyNotInitializedException

Returns true if a named resource (a flow, for example) is an internal piece of the service

Specified by:

isServiceInternalComponent in interface ServiceInterface

Parameters:

objectName - Name of object to check

Returns:

true if the named component is internal

Throws:

ConfigManagerProxyPropertyNotInitializedException

getServiceURL

public java.net.URL getServiceURL()
                           throws ConfigManagerProxyPropertyNotInitializedException

Returns the URL for the service, if this service has a binding that can be represented as a URL

Specified by:

getServiceURL in interface ServiceInterface

Returns:

URL Base URL for the service or blank if unavailable

Throws:

ConfigManagerProxyPropertyNotInitializedException - if operation information could not be determined because the information was not supplied from the broker before a timeout occurred.

getServiceQueryURL

public java.net.URL getServiceQueryURL()
                                throws ConfigManagerProxyPropertyNotInitializedException

Returns the URL for querying the WSDL for the service, if this service has a binding that uses WSDL (and ?wsdl support is wswitch on for the service)

Specified by:

getServiceQueryURL in interface ServiceInterface

Returns:

URL Query URL for the service or blank if unavailable

Throws:

ConfigManagerProxyPropertyNotInitializedException - if operation information could not be determined because the information was not supplied from the broker before a timeout occurred.

getInterfaceFiles

public java.util.Map<java.lang.String,java.lang.String> getInterfaceFiles()
                                                                   throws ConfigManagerProxyPropertyNotInitializedException

Returns a Map of all the WSDL and XSD files for this service.

Specified by:

getInterfaceFiles in interface ServiceInterface

Returns:

Map The files for the service

Throws:

ConfigManagerProxyPropertyNotInitializedException - if operation information could not be determined because the information was not supplied from the broker before a timeout occurred.