com.ibm.mq.pcf

Class MQCFH

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.headers.internal.Header

com.ibm.mq.pcf.PCFHeader

com.ibm.mq.pcf.MQCFH

All Implemented Interfaces:

com.ibm.mq.headers.internal.CachingHeader, MQData, MQHeader

Deprecated.

use MQCFH instead.

        struct tagMQCFH {
                MQLONG  Type;            // Structure type
                MQLONG  StrucLength;     // Structure length
                MQLONG  Version;         // Structure version number
                MQLONG  Command;         // Command identifier
                MQLONG  MsgSeqNumber;    // Message sequence number
                MQLONG  Control;         // Control options
                MQLONG  CompCode;        // Completion code
                MQLONG  Reason;          // Reason code qualifying completion code
                MQLONG  ParameterCount;  // Count of parameter structures
        };
 

public class MQCFH
extends PCFHeader

MQCFH (PCF header) header class.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader

MQHeader.Field

Field Summary

Fields

Modifier and Type	Field and Description
int	command Deprecated. command identifier
int	compCode Deprecated. completion code
int	control Deprecated. control options
int	msgSeqNumber Deprecated. message sequence number
int	parameterCount Deprecated. count of parameter structures
int	reason Deprecated. reason code qualifying completion code
static int	strucLength Deprecated. structure length
int	type Deprecated. structure type
int	version Deprecated. version number of the structure format

Fields inherited from class com.ibm.mq.headers.internal.Header

DEFAULT_CCSID, DEFAULT_ENCODING

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

COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructors

Constructor and Description
MQCFH() Deprecated. Constructs an MQCFH instance with default field values.
MQCFH(java.io.DataInput message, int encoding, int characterSet) Deprecated. Constructs an MQCFH instance populated from a DataInput source.
MQCFH(int command, int parameterCount) Deprecated. Initializes an MQCFH instance with the specified command and parameter count.
MQCFH(MQMessage message) Deprecated. Constructs an MQCFH instance populated from an MQMessage.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Deprecated. Returns true when invoked with another MQCFH instance with the same type, parameter, operator and value.
int	getCommand() Deprecated. gets the command identifier
int	getCompCode() Deprecated. gets the completion code
int	getControl() Deprecated. gets the control options
int	getMsgSeqNumber() Deprecated. gets the message sequence number
int	getParameterCount() Deprecated. gets the count of parameter structures
int	getReason() Deprecated. gets the reason code qualifying completion code
int	getStrucLength() Deprecated. Get the length of the structure.
int	getType() Deprecated. gets the structure type
int	getVersion() Deprecated. gets the structure version number
void	setCommand(int value) Deprecated. sets the command identifier
void	setCompCode(int value) Deprecated. sets the completion code
void	setControl(int value) Deprecated. sets the control options
void	setMsgSeqNumber(int value) Deprecated. sets gets the message sequence number
void	setParameterCount(int value) Deprecated. sets the count of parameter structures
void	setReason(int value) Deprecated. sets the reason code qualifying completion code
void	setType(int value) Deprecated. sets the structure type
void	setVersion(int value) Deprecated. sets the structure version number
static int	write(MQMessage message, int command, int parameterCount) Deprecated. A convenience method for writing an MQCFH header structure with the specified values to a message.
static int	write(MQMessage message, int command, int parameterCount, int type, int version) Deprecated. A convenience method for writing an MQCFH header structure with the specified values to a message.

Methods inherited from class com.ibm.mq.pcf.PCFHeader

initialize, size, toString, write

Methods inherited from class com.ibm.mq.headers.internal.Header

characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, store, store, type, validate, write

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

getJmqiEnvironment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.mq.headers.internal.CachingHeader

discardCachedContent, readCachedContent, writeCachedContent

Field Detail

type

public int type

Deprecated.

structure type

strucLength

public static final int strucLength

Deprecated.

structure length

See Also:

Constant Field Values

version

public int version

Deprecated.

version number of the structure format

command

public int command

Deprecated.

command identifier

msgSeqNumber

public int msgSeqNumber

Deprecated.

message sequence number

control

public int control

Deprecated.

control options

compCode

public int compCode

Deprecated.

completion code

reason

public int reason

Deprecated.

reason code qualifying completion code

parameterCount

public int parameterCount

Deprecated.

count of parameter structures

Constructor Detail

MQCFH

public MQCFH()

Deprecated.

Constructs an MQCFH instance with default field values.

MQCFH

public MQCFH(MQMessage message)
      throws MQException,
             java.io.IOException

Deprecated.

Constructs an MQCFH instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQException - if the message content does not yield a valid MQCFH stucture

java.io.IOException - if there is a problem reading the message content

MQCFH

public MQCFH(java.io.DataInput message,
             int encoding,
             int characterSet)
      throws MQException,
             java.io.IOException

Deprecated.

Constructs an MQCFH instance populated from a DataInput source.

Parameters:

message - the MQMessage or other DataInput source to read

encoding - the initial numeric encoding of the data in the message

characterSet - the initial CCSID of the data in the message

Throws:

MQException - if the message content does not yield a valid MQCFH stucture

java.io.IOException - if there is a problem reading the message content

MQCFH

public MQCFH(int command,
             int parameterCount)

Deprecated.

Initializes an MQCFH instance with the specified command and parameter count. Other values are set as for the no-args constructor.

Parameters:

command -

parameterCount -

Method Detail

write

public static int write(MQMessage message,
                        int command,
                        int parameterCount)
                 throws java.io.IOException

Deprecated.

A convenience method for writing an MQCFH header structure with the specified values to a message.

Parameters:

message - the message to write to

command - the PCF command (MQCMD_* constants are defined in the CMQCFC class)

parameterCount - the number of parameter structures (MQCFIN, MQCFIL, MQCFST or MQCFSL) to follow the PCF header

Returns:

the number of bytes written

Throws:

java.io.IOException

write

public static int write(MQMessage message,
                        int command,
                        int parameterCount,
                        int type,
                        int version)
                 throws java.io.IOException

Deprecated.

A convenience method for writing an MQCFH header structure with the specified values to a message.

Parameters:

message - the message to write to

command - the PCF command (MQCMD_* constants are defined in the CMQCFC class)

parameterCount - the number of parameter structures (MQCFIN, MQCFIL, MQCFST etc.) to follow the PCF header

type - the PCF message type

version - message version

Returns:

the number of bytes written

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Deprecated.

Returns true when invoked with another MQCFH instance with the same type, parameter, operator and value.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true of the object equals this one

getType

public int getType()

Deprecated.

gets the structure type

Specified by:

getType in class PCFHeader

Returns:

the structure type

setType

public void setType(int value)

Deprecated.

sets the structure type

Parameters:

value - the structure type

getStrucLength

public int getStrucLength()

Deprecated.

Get the length of the structure.

Returns:

the structure length.

getVersion

public int getVersion()

Deprecated.

gets the structure version number

Returns:

the structure version number

setVersion

public void setVersion(int value)

Deprecated.

sets the structure version number

Parameters:

value - the structure version number

getCommand

public int getCommand()

Deprecated.

gets the command identifier

Returns:

the command identifier

setCommand

public void setCommand(int value)

Deprecated.

sets the command identifier

Parameters:

value -

getMsgSeqNumber

public int getMsgSeqNumber()

Deprecated.

gets the message sequence number

Returns:

gets the message sequence number

setMsgSeqNumber

public void setMsgSeqNumber(int value)

Deprecated.

sets gets the message sequence number

Parameters:

value - gets the message sequence number

getControl

public int getControl()

Deprecated.

gets the control options

Returns:

the control options

setControl

public void setControl(int value)

Deprecated.

sets the control options

Parameters:

value - the control options

getCompCode

public int getCompCode()

Deprecated.

gets the completion code

Returns:

the completion code

setCompCode

public void setCompCode(int value)

Deprecated.

sets the completion code

Parameters:

value - the completion code

getReason

public int getReason()

Deprecated.

gets the reason code qualifying completion code

Returns:

the reason code qualifying completion code

setReason

public void setReason(int value)

Deprecated.

sets the reason code qualifying completion code

Parameters:

value - the reason code qualifying completion code

getParameterCount

public int getParameterCount()

Deprecated.

gets the count of parameter structures

Returns:

the count of parameter structures

setParameterCount

public void setParameterCount(int value)

Deprecated.

sets the count of parameter structures

Parameters:

value - the count of parameter structures