MQControl Interface
- public interface MQControl
extends Control
MQ Control base interface
-
All Superinterfaces
-
Control
, Serializable
Nested classes from interface com.bea.control.Control |
Control.Callback |
public void |
-
begin ()
- Begins a MQ transaction
|
public void |
-
commit ()
- Commits a MQ transaction
|
public byte[] |
-
getMessageAsBytes (String queue, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
- Gets a byte array(binary) message from the queue This function calls the
generic getMessage function
|
public String |
-
getMessageAsString (String queue, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
- Gets a String(text) message from the queue This function calls the generic
getMessage function
|
public XmlObject |
-
getMessageAsXml (String queue, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
- Gets a XmlObject(xml) message from the queue This function calls the
generic getMessage function
|
public com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument |
-
putMessageAsBytes (byte[] message, String queue, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
- Puts a byte array(binary) message into the queue This function calls the
generic putMessage function
|
public com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument |
-
putMessageAsString (String message, String queue, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
- Puts a String(text) message into the queue This function calls the generic
putMessage function
|
public com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument |
-
putMessageAsXml (XmlObject message, String queue, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
- Puts a XmlObject(xml) message into the queue This function calls the
generic putMessage function
|
public void |
-
rollback ()
- Rolls back a MQ transaction
|
public void |
-
setDynamicProperties (com.bea.wli.control.mqDynamicProperties.MQDynamicPropertiesDocument mqDynPropsDoc)
- Sets the dynamic properties for the control.
|
begin() Method
public void begin()
throws ResourceException
Begins a MQ transaction
Exceptions
-
ResourceException
- if transaction state is invalid
commit() Method
public void commit()
throws ResourceException
Commits a MQ transaction
Exceptions
-
ResourceException
- if transaction state is invalid
getMessageAsBytes(String, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument) Method
public byte[] getMessageAsBytes(String
queue,
com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
throws ResourceException
Gets a byte array(binary) message from the queue This function calls the
generic getMessage function
Parameters
-
queue
- the queue from which the message is to be got
-
mqmd
- the MQMDHeaders document containing the MQMD attributes based on which the message is to be got
Returns
- byte[] the byte array representing the message got
Exceptions
-
ResourceException
- if any exception occurs while get
getMessageAsString(String, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument) Method
public String
getMessageAsString(String
queue,
com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
throws ResourceException
Gets a String(text) message from the queue This function calls the generic
getMessage function
Parameters
-
queue
- the queue from which the message is to be got
-
mqmd
- the MQMDHeaders document containing the MQMD attributes based on which the message is to be got
Returns
- String the String representing the message got
Exceptions
-
ResourceException
- if any exception occurs while get
getMessageAsXml(String, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument) Method
public XmlObject
getMessageAsXml(String
queue,
com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
throws ResourceException
Gets a XmlObject(xml) message from the queue This function calls the
generic getMessage function
Parameters
-
queue
- the queue from which the message is to be got
-
mqmd
- the MQMDHeaders document containing the MQMD attributes based on which the message is to be got
Returns
- XmlObject the XmlObject representing the message got
Exceptions
-
ResourceException
- if any exception occurs while get
putMessageAsBytes(byte[], String, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument) Method
public com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument putMessageAsBytes(byte[] message,
String
queue,
com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
throws ResourceException
Puts a byte array(binary) message into the queue This function calls the
generic putMessage function
Parameters
-
message
- the byte array message to be put into the queue
-
queue
- the queue to which the message is to be put
-
mqmd
- the MQMDHeaders document containing the MQMD attributes of the message to be put
Returns
- MQMDHeadersDocument representing the attributes of the message put
Exceptions
-
ResourceException
- if any exception occurs while put
putMessageAsString(String, String, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument) Method
public com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument putMessageAsString(String
message,
String
queue,
com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
throws ResourceException
Puts a String(text) message into the queue This function calls the generic
putMessage function
Parameters
-
message
- the String message to be put into the queue
-
queue
- the queue to which the message is to be put
-
mqmd
- the MQMDHeaders document containing the MQMD attributes of the message to be put
Returns
- MQMDHeadersDocument representing the attributes of the message put
Exceptions
-
ResourceException
- if any exception occurs while put
putMessageAsXml(XmlObject, String, com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument) Method
public com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument putMessageAsXml(XmlObject
message,
String
queue,
com.bea.wli.control.mqmdHeaders.MQMDHeadersDocument mqmd)
throws ResourceException
Puts a XmlObject(xml) message into the queue This function calls the
generic putMessage function
Parameters
-
message
- the xml message to be put into the queue
-
queue
- the queue to which the message is to be put
-
mqmd
- the MQMDHeaders document containing the MQMD attributes of the message to be put
Returns
- MQMDHeadersDocument representing the attributes of the message put
Exceptions
-
ResourceException
- if any exception occurs while put
rollback() Method
public void rollback()
throws ResourceException
Rolls back a MQ transaction
Exceptions
-
ResourceException
- if transaction state is invalid
setDynamicProperties(com.bea.wli.control.mqDynamicProperties.MQDynamicPropertiesDocument) Method
public void setDynamicProperties(com.bea.wli.control.mqDynamicProperties.MQDynamicPropertiesDocument mqDynPropsDoc)
Sets the dynamic properties for the control.
Parameters
-
mqDynPropsDoc
- the MQDynamicProperties document containing
the dynamic properties to be set