Package com.ibm.mq.pcf

Class PCFHeaderFactory

java.lang.Object
com.ibm.mq.pcf.PCFHeaderFactory
All Implemented Interfaces:
MQHeaderFactory
public class PCFHeaderFactory extends Object implements MQHeaderFactory
Deprecated.
use PCFHeaderFactory instead.
MQHeaderFactory for PCF header structures and formats. The PCFHeaderFactory is registered with the default header registry.
See Also:

  • Constructor Details

    • PCFHeaderFactory

      public PCFHeaderFactory()
      Deprecated.

  • Method Details

    • create

      public MQHeader create(String type) throws InstantiationException
      Deprecated.
      Specified by:
      create in interface MQHeaderFactory
      Parameters:
      type - of the header to create.
      Returns:
      an MQHeader instance of the named type. The types known the header factory can be obtained from the getSupportedTypes method. These types correspond to the values returned by the type method on MQHeader instances.
      Throws:
      InstantiationException - if the header object cannot be created
      See Also:

    • decode

      public MQHeader decode(MQHeaderContext context) throws MQException, IOException
      Deprecated.
      Description copied from interface: MQHeaderFactory
      Decodes (parses) an MQHeader instance from a message. The message context object carries the format, encoding and CCSID associated with the current position in the message or byte stream. The operation of an MQHeaderFactory to fulfil this method is essentially:
      1. Identify the header type that occurs next in the message. This may be known by the factory directly, and associated with the format; or the MQHeaderFactory may need to peek at the message content to detect the type.
      2. Having identified the correct type, instantiate an MQHeader instance of that type.
      3. Invoke the header object's read method on the message.
      4. Optionally, update the format, encoding and characterSet members of the message context object.
      5. Return the header instance.
      This method may return null if no more headers are present or this MQHeaderFactory cannot identify a header at the current position in the message.
      Specified by:
      decode in interface MQHeaderFactory
      Parameters:
      context - the header context.
      Returns:
      the parsed MQHeader
      Throws:
      IOException - if an error occurs while decoding the message
      MQException
      See Also:

    • getSupportedFormats

      public Collection getSupportedFormats()
      Deprecated.
      Specified by:
      getSupportedFormats in interface MQHeaderFactory
      Returns:
      the set of format names associated with the header types supported by this MQHeaderFactory. An MQHeaderFactory instance is capable of decoding messages of these formats.
      See Also:

    • getSupportedTypes

      public Collection getSupportedTypes()
      Deprecated.
      Specified by:
      getSupportedTypes in interface MQHeaderFactory
      Returns:
      the set of header types supported by this MQHeaderFactory. An MQHeaderFactory instance can create new instances of these types.
      See Also: