com.ibm.mq.pcf

Class PCFMessageAgent

1. java.lang.Object
2. com.ibm.mq.jmqi.JmqiObject
3. com.ibm.mq.pcf.PCFAgent
4. com.ibm.mq.pcf.PCFMessageAgent

---

1. public class PCFMessageAgent
2. extends PCFAgent

General-purpose agent for sending PCF queries to a queue manager. Like the PCFAgent it extends, a PCFMessageAgent maintains a single queue manager connection and provides a simple method for sending PCF requests and returning the set of response messages. The PCFMessageAgent uses the PCFMessage class for requests and replies, which avoids exposure to the details of underlying PCF header structures. The PCFMessageAgent also provides the capability to check the header contents of a PCF response and throw a PCFException if the response indicates an error.

The following example uses a PCFMessageAgent to obtain the list of local queues on the queue manager.

     import com.ibm.mq.pcf.*;

     ...

     try
     {
       PCFMessageAgent agent = new PCFMessageAgent ("localhost", 1414, "CLIENT");
       PCFMessage   request = new PCFMessage (CMQCFC.MQCMD_INQUIRE_Q_NAMES);

       request.addParameter (CMQC.MQCA_Q_NAME, "*");
       request.addParameter (CMQC.MQIA_Q_TYPE, MQC.MQQT_LOCAL);

       PCFMessage []   responses = agent.send (request);
       String []   names = (String []) responses [0].getParameterValue (CMQCFC.MQCACF_Q_NAMES);

       for (int i = 0; i < names.length; i++)
       {
         System.out.println ("Queue: " + names [i]);
       }
     }

     catch (PCFException pcfe)
     {
       System.err.println ("PCF error: " + pcfe);
     }

     catch (MQException mqe)
     {
       System.err.println (mqe);
     }

     catch (IOException ioe)
     {
       System.err.println (ioe);
     }

 

---

Field Summary

Fields inherited from class com.ibm.mq.pcf.PCFAgent
MAXIMUM_ALLOWED_PREFIX_LENGTH, replyQueueName

Fields inherited from class com.ibm.mq.jmqi.JmqiObject
COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructor and Description
PCFMessageAgent() Default constructor.
PCFMessageAgent(MQQueueManager qmanager) Initializes a new PCFMessageAgent with an existing queue manager connection.
PCFMessageAgent(java.lang.String qmanager) Initializes a new PCFMessageAgent with a bindings connection to a queue manager.
PCFMessageAgent(java.lang.String host,int port,java.lang.String channel) Initializes a new PCFMessageAgent with a client connection to a queue manager.

Method Summary

Modifier and Type	Method and Description
PCFMessage[]	send(PCFMessage request) Sends a PCF request to the connected queue manager and returns the responses.
PCFMessage[]	send(PCFMessage request,boolean check) Deprecated. Use setCheckResponses and send(com.ibm.mq.pcf.PCFMessage)
PCFMessage[]	send(PCFMessage request,boolean check,boolean usePlatformSettings) Deprecated. Use setCheckResponses/setUsePlatformSettings and send(com.ibm.mq.pcf.PCFMessage)
void	setCheckResponses(boolean option) If this option is set, the send method throws a PCFException if the responses include a PCF message with the reason code MQRCCF_COMMAND_FAILED in the MQCFH header.
void	setUsePlatformSettings(boolean option) If this option is set, the send method alters the MQCFH contained within the PCFMessage request if necessary to match the platform of the connected queue manager.

Methods inherited from class com.ibm.mq.pcf.PCFAgent
connect, connect, connect, connect, connect, connect, disconnect, getCommandLevel, getExpiry, getModelQueueName, getPlatform, getQManagerName, getReplyQueueName, getReplyQueuePrefix, getWaitInterval, send, setCharacterSet, setEncoding, setModelQueueName, setReplyQueuePrefix, setWaitInterval, setWaitInterval

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PCFMessageAgent

1. public PCFMessageAgent()

---

PCFMessageAgent

1. public PCFMessageAgent(MQQueueManager qmanager)
2. throws MQException

---

PCFMessageAgent

1. public PCFMessageAgent(java.lang.String host,
2. int port,
3. java.lang.String channel)
4. throws MQException

---

PCFMessageAgent

1. public PCFMessageAgent(java.lang.String qmanager)
2. throws MQException

Method Detail

send

1. public PCFMessage[] send(PCFMessage request)
2. throws PCFException
3. MQException
4. java.io.IOException

---

send

1. public PCFMessage[] send(PCFMessage request,
2. boolean check)
3. throws PCFException
4. MQException
5. java.io.IOException

---

send

1. public PCFMessage[] send(PCFMessage request,
2. boolean check,
3. boolean usePlatformSettings)
4. throws PCFException
5. MQException
6. java.io.IOException

---

setCheckResponses

1. public void setCheckResponses(boolean option)

---

setUsePlatformSettings

1. public void setUsePlatformSettings( boolean option)