com.ibm.mq

Class MQProcess

  1. java.lang.Object
  2. extended bycom.ibm.mq.jmqi.JmqiObject
  3. extended bycom.ibm.mq.MQManagedObject
  4. extended bycom.ibm.mq.MQProcess
  1. public class MQProcess
  2. extends MQManagedObject
MQProcess provides inquire operations for WebSphere MQ processes. Use MQQueueManager.accessProcess() to create an MQProcess object.

Field Summary

Fields inherited from class com.ibm.mq.MQManagedObject
alternateUserId, closeOptions, connectionReference, isOpen, name, openOptions
Fields inherited from class com.ibm.mq.jmqi.JmqiObject
COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructor and Description
MQProcess(MQQueueManager qMgr,java.lang.String processName,int openOptions)
Establishes access to a WebSphere MQ process on the specified queue manager in order to inquire about the process attributes.
MQProcess(MQQueueManager qMgr,java.lang.String processName,int openOptions,java.lang.String queueManagerName,java.lang.String alternateUserId)
Establishes access to a WebSphere MQ process on the specified queue manager in order to inquire about the process attributes.

Method Summary

Modifier and Type Method and Description
  1. void
 close()
Closes the process.
  1. java.lang.String
 getApplicationId()
Gets the character string which identifies the application to be started.
  1. int
 getApplicationType()
Identifies the nature of the process to be started in response to a trigger message.
  1. java.lang.String
 getEnvironmentData()
Gets information on the environment of the application which is to be started.
  1. java.lang.String
 getUserData()
Gets information pertaining to the application to be started.
Methods inherited from class com.ibm.mq.MQManagedObject
getAlternateUserId, getAttributeString, getCloseOptions, getConnectionReference, getDescription, getName, getOpenOptions, getResolvedObjectString, getResolvedQName, getResolvedType, inquire, inquire, isOpen, set, setAttributeString, setCloseOptions
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MQProcess

  1. public MQProcess(MQQueueManager qMgr,
  2. java.lang.String processName,
  3. int openOptions)
  4. throws MQException
Establishes access to a WebSphere MQ process on the specified queue manager in order to inquire about the process attributes. The default user authority is used for connection to the queue manager.
Parameters:
qMgr - the queue manager that is running the process.
processName - the name of process to open.
openOptions - options that control the opening of the process. As inquire is automatically added to the options specified there is no need to specify it explicitly. Valid options are: If more than one option is required, the values can be combined using either the '+' or '|' operator.
Throws:
MQException - if the open fails.

MQProcess

  1. public MQProcess(MQQueueManager qMgr,
  2. java.lang.String processName,
  3. int openOptions,
  4. java.lang.String queueManagerName,
  5. java.lang.String alternateUserId)
  6. throws MQException
Establishes access to a WebSphere MQ process on the specified queue manager in order to inquire about the process attributes.
Parameters:
qMgr - the queue manager that is running the process.
processName - the name of process to open.
openOptions - options that control the opening of the process. As inquire is automatically added to the options specified there is no need to specify it explicitly. Valid options are: If more than one option is required, the values can be combined using either the '+' or '|' operator.
queueManagerName - the name of queue manager qMgr.
alternateUserId - if MQC.MQOO_ALTERNATE_USER_AUTHORITY is specified in the openOptions parameter, this parameter specifies the alternative user ID to be used to check the authorization for the open. Otherwise this parameter can be blank or null.
Throws:
MQException - if the open fails.

Method Detail

close

  1. public void close()
  2. throws MQException
Closes the process.
Overrides:
close in class MQManagedObject
Throws:
MQException - if the WebSphere MQ call fails.

getApplicationId

  1. public java.lang.String getApplicationId( )
  2. throws MQException
Gets the character string which identifies the application to be started. This information is used by a trigger monitor application which processes messages on the initiation queue; the information is sent to the initiation queue as part of the trigger message.
Returns:
the application ID.
Throws:
MQException - if you call this method after you have closed the process, indicating that the process is no longer accessible, or if the underlying inquire() call fails.
See Also:
MQC.MQCA_APPL_ID

getApplicationType

  1. public int getApplicationType()
  2. throws MQException
Identifies the nature of the process to be started in response to a trigger message.
Returns:
the following standard types have already been defined but others can be used:
Throws:
MQException - if the underlying inquire() call fails.
See Also:
MQC.MQIA_APPL_TYPE

getEnvironmentData

  1. public java.lang.String getEnvironmentData( )
  2. throws MQException
Gets information on the environment of the application which is to be started.
Returns:
the information as a String.
Throws:
MQException - if an internal error occurs.
See Also:
MQC.MQCA_ENV_DATA

getUserData

  1. public java.lang.String getUserData( )
  2. throws MQException
Gets information pertaining to the application to be started.
Returns:
the information as a String.
Throws:
MQException - if an internal error occurs.
See Also:
MQC.MQCA_USER_DATA