Package com.ibm.mq.headers

Class MQHeaderRegistry

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.headers.MQHeaderRegistry

All Implemented Interfaces:

MQHeaderFactory.Registry

public class MQHeaderRegistry
extends com.ibm.mq.jmqi.JmqiObject
implements MQHeaderFactory.Registry

The MQHeaderRegistry provides resources for decoding or instantiating header instances. The registry associates message formats and header types with MQHeaderFactories that can decode or create headers. Most applications will not have to use this class directly. The MQHeaderIterator and MQHeaderList classes use the default header registry as the basis for their capabilities, and this is pre-registered with the standard MQ message formats and header types. The default header registry can be obtained directly using the getDefault method on this class.

Applications may register additional MQHeaderFactory instances in the default registry, for example, if new MQ or application header types are devised. As a convenience, new MQHeader types can be registered directly without supplying an MQHeaderFactory instance, as long as each header type is associated one-to-one with a format. (For most existing headers, this is the case; but it is not true of PCF, for example.)

As an alternative to updating the default registry, applications can create their own MQHeaderRegistry instances and customize their contents, for example to handle custom application-defined formats. An MQHeaderIterator can be created from any MQHeaderRegistry using the createIterator method.

See Also:

• MQHeaderIterator
• MQHeaderList
• MQHeaderFactory

Field Summary

Fields inherited from class com.ibm.mq.jmqi.JmqiObject

COMP_JM, COMP_JN, COMP_JO

Method Summary

Modifier and Type	Method	Description
MQHeaderIterator	createIterator(DataInput message)
MQHeaderIterator	createIterator(DataInput message, String format, int encoding, int characterSet)
static MQHeaderRegistry	getDefault()
MQHeaderFactory	getFactoryForFormat(String format)
MQHeaderFactory	getFactoryForType(String type)
Collection<?>	getRegisteredFormats()
Collection<?>	getRegisteredTypes()
void	register(MQHeaderFactory factory)	Registers an MQHeaderFactory.
void	register(String format, String type, Class<?> headerClass)
void	register(String format, String type, String className)
String	toString()

Methods inherited from class com.ibm.mq.jmqi.JmqiObject

getJmqiEnvironment

Methods inherited from class java.lang.Object

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

Method Details

getDefault

public static MQHeaderRegistry getDefault()

Returns:

the default (singleton) MQHeaderRegistry instance.

getFactoryForFormat

public MQHeaderFactory getFactoryForFormat(String format)

Specified by:

getFactoryForFormat in interface MQHeaderFactory.Registry

Parameters:

format -

Returns:

an MQHeaderFactory associated with the specified format.

See Also:

• MQHeaderFactory.Registry.getFactoryForFormat(java.lang.String)

getFactoryForType

public MQHeaderFactory getFactoryForType(String type)

Specified by:

getFactoryForType in interface MQHeaderFactory.Registry

Parameters:

type -

Returns:

an MQHeaderFactory that supports the specified header type.

See Also:

• MQHeaderFactory.Registry.getFactoryForType(java.lang.String)

register

public void register(MQHeaderFactory factory)

Description copied from interface: MQHeaderFactory.Registry

Registers an MQHeaderFactory.

Specified by:

register in interface MQHeaderFactory.Registry

Parameters:

factory -

See Also:

• MQHeaderFactory.Registry.register(com.ibm.mq.headers.MQHeaderFactory)

register

public void register(String format,
 String type,
 Class<?> headerClass)

Parameters:

format -

type -

headerClass -

register

public void register(String format,
 String type,
 String className)
              throws ClassNotFoundException

Parameters:

format -

type -

className -

Throws:

ClassNotFoundException

getRegisteredFormats

public Collection<?> getRegisteredFormats()

Specified by:

getRegisteredFormats in interface MQHeaderFactory.Registry

Returns:

the set of formats supported by the registered MQHeaderFactories.

See Also:

• MQHeaderFactory.Registry.getRegisteredFormats()

getRegisteredTypes

public Collection<?> getRegisteredTypes()

Specified by:

getRegisteredTypes in interface MQHeaderFactory.Registry

Returns:

the set of header types supported by the registered MQHeaderFactories.

See Also:

• MQHeaderFactory.Registry.getRegisteredTypes()

createIterator

public MQHeaderIterator createIterator(DataInput message)

Parameters:

message - the message.

Returns:

an MQHeaderIterator capable of decoding messages of formats known to this registry.

createIterator

public MQHeaderIterator createIterator(DataInput message,
 String format,
 int encoding,
 int characterSet)

Parameters:

message - the message.

format -

encoding - the numeric encoding. see (CMQC.MQENC_* for values).

characterSet - the Coded Character Set Identifier.

Returns:

an MQHeaderIterator capable of decoding messages of formats known to this registry.

toString

public String toString()

Overrides:

toString in class Object

Returns:

the string representation of the class instance

See Also:

• Object.toString()