com.ibm.mq.headers

Class MQIIH

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.headers.MQIIH

All implemented interfaces:

public class MQIIH
extends com.ibm.mq.headers.internal.Header
implements MQChainable

MQIIH header class.

    struct tagMQIIH {
                MQCHAR4   StrucId;         // Structure identifier
                MQLONG    Version;         // Structure version number
                MQLONG    StrucLength;     // Length of MQIIH structure
                MQLONG    Encoding;        // Reserved
                MQLONG    CodedCharSetId;  // Reserved
                MQCHAR8   Format;          // MQ format name of data that follows MQIIH
                MQLONG    Flags;           // Flags
                MQCHAR8   LTermOverride;   // Logical terminal override
                MQCHAR8   MFSMapName;      // Message format services map name
                MQCHAR8   ReplyToFormat;   // MQ format name of reply message
                MQCHAR8   Authenticator;   // RACF password or passticket
                MQBYTE16  TranInstanceId;  // Transaction instance identifier
                MQCHAR    TranState;       // Transaction state
                MQCHAR    CommitMode;      // Commit mode
                MQCHAR    SecurityScope;   // Security scope
                MQCHAR    Reserved;        // Reserved
   };

Nested Class Summary

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

Field Summary

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

Constructor and Description
`MQIIH()` Constructs an MQIIH instance with default field values.
`MQIIH(java.io.DataInput message)` Constructs an MQIIH instance populated from an MQMessage.
`MQIIH(java.io.DataInput message,int encoding,int characterSet)` Constructs an MQIIH instance populated from a DataInput source.

Method Summary

Modifier and Type	Method and Description
java.lang.String	`format()`
java.lang.String	`getAuthenticator()` gets the RACF password or passticket
int	`getCodedCharSetId()` Get the Character set identifier of data that follows.
char	`getCommitMode()` gets the Commit mode
int	`getEncoding()` Get the numeric encoding of the data that follows.
int	`getFlags()` gets the Flags
java.lang.String	`getFormat()` gets the MQ format name of data that follows MQIIH
java.lang.String	`getLTermOverride()` gets the Logical terminal override
java.lang.String	`getMFSMapName()` gets the Message format services map name
java.lang.String	`getReplyToFormat()` gets the MQ format name of reply message
char	`getSecurityScope()` gets the Security scope
java.lang.String	`getStrucId()` Get the structure identifier; the value will be MQIIH_STRUC_ID
int	`getStrucLength()` Get the length of the structure.
byte[]	`getTranInstanceId()` gets the Transaction instance identifier
char	`getTranState()` gets the Transaction state
int	`getVersion()` Get the Structure version number
int	`nextCharacterSet()`
void	`nextCharacterSet(int value)`
int	`nextEncoding()`
void	`nextEncoding(int value)`
java.lang.String	`nextFormat()`
void	`nextFormat(java.lang.String value)`
void	`setAuthenticator(java.lang.String value)` sets the RACF password or passticket
void	`setCodedCharSetId(int value)` Set the Character set identifier of data that follows.
void	`setCommitMode(char value)` sets the Commit mode
void	`setEncoding(int value)` Set the numeric encoding of the data that follows.
void	`setFlags(int value)` sets the Flags
void	`setFormat(java.lang.String value)` sets the MQ format name of data that follows MQIIH
void	`setLTermOverride(java.lang.String value)` sets the Logical terminal override
void	`setMFSMapName(java.lang.String value)` sets the Message format services map name
void	`setReplyToFormat(java.lang.String value)` sets the MQ format name of reply message
void	`setSecurityScope(char value)` sets the Security scope
void	`setTranInstanceId(byte[] value)` sets the Transaction instance identifier
void	`setTranState(char value)` sets the Transaction state

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, size, store, store, toString, type, validate, write, write`

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

Constructor Detail

MQIIH

public MQIIH()

Constructs an MQIIH instance with default field values.

MQIIH

public MQIIH(java.io.DataInput message)
throws MQDataException
java.io.IOException

Constructs an MQIIH instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQDataException - if the message content does not yield a valid MQIIH stucture

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

MQIIH

public MQIIH(java.io.DataInput message,
int encoding,
int characterSet)
throws MQDataException
java.io.IOException

Constructs an MQIIH 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:

MQDataException - if the message content does not yield a valid MQIIH stucture

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

Method Detail

getStrucId

public java.lang.String getStrucId( )

Get the structure identifier; the value will be MQIIH_STRUC_ID

Returns:

the structure identifier

getVersion

public int getVersion()

Get the Structure version number

Returns:

the Structure version number

getStrucLength

public int getStrucLength()

Get the length of the structure.

Returns:

the structure length.

getEncoding

public int getEncoding()

Get the numeric encoding of the data that follows.

Returns:

the numeric encoding. A combination of MQENC_* values.

setEncoding

public void setEncoding(int value)

Set the numeric encoding of the data that follows.

Parameters:

value - the numeric encoding. A combination of MQENC_* values.

getCodedCharSetId

public int getCodedCharSetId()

Get the Character set identifier of data that follows.

Returns:

the Character set identifier.

setCodedCharSetId

public void setCodedCharSetId(int value)

Set the Character set identifier of data that follows.

Parameters:

value - the Character set identifier.

getFormat

public java.lang.String getFormat( )

gets the MQ format name of data that follows MQIIH

Returns:

the MQ format name of data that follows MQIIH

setFormat

public void setFormat(java.lang.String value)

sets the MQ format name of data that follows MQIIH

Parameters:

value - the MQ format name of data that follows MQIIH

getFlags

public int getFlags()

gets the Flags

Returns:

the Flags

setFlags

public void setFlags(int value)

sets the Flags

Parameters:

value - the Flags

getLTermOverride

public java.lang.String getLTermOverride( )

gets the Logical terminal override

Returns:

the Logical terminal override

setLTermOverride

public void setLTermOverride(java.lang.String value)

sets the Logical terminal override

Parameters:

value - the Logical terminal override

getMFSMapName

public java.lang.String getMFSMapName( )

gets the Message format services map name

Returns:

the Message format services map name

setMFSMapName

public void setMFSMapName(java.lang.String value)

sets the Message format services map name

Parameters:

value - the Message format services map name

getReplyToFormat

public java.lang.String getReplyToFormat( )

gets the MQ format name of reply message

Returns:

the MQ format name of reply message

setReplyToFormat

public void setReplyToFormat(java.lang.String value)

sets the MQ format name of reply message

Parameters:

value - the MQ format name of reply message

getAuthenticator

public java.lang.String getAuthenticator( )

gets the RACF password or passticket

Returns:

the RACF password or passticket

setAuthenticator

public void setAuthenticator(java.lang.String value)

sets the RACF password or passticket

Parameters:

value - the RACF password or passticket

getTranInstanceId

public byte[] getTranInstanceId( )

gets the Transaction instance identifier

Returns:

the Transaction instance identifier

setTranInstanceId

public void setTranInstanceId(byte[] value)

sets the Transaction instance identifier

Parameters:

value - the Transaction instance identifier

getTranState

public char getTranState()

gets the Transaction state

Returns:

the Transaction state

setTranState

public void setTranState(char value)

sets the Transaction state

Parameters:

value - the Transaction state

getCommitMode

public char getCommitMode()

gets the Commit mode

Returns:

the Commit mode

setCommitMode

public void setCommitMode(char value)

sets the Commit mode

Parameters:

value - the Commit mode

getSecurityScope

public char getSecurityScope()

gets the Security scope

Returns:

the Security scope

setSecurityScope

public void setSecurityScope(char value)

sets the Security scope

Parameters:

value - the Security scope

nextEncoding

public int nextEncoding()

Description copied from interface: MQChainable

Returns the numeric encoding of the next header or message content.

Specified by:

nextEncoding in interface MQChainable

exclude

nextEncoding

public void nextEncoding(int value)

Description copied from interface: MQChainable

Sets the numeric encoding of the next header or message content.

Specified by:

nextEncoding in interface MQChainable

nextCharacterSet

public int nextCharacterSet()

Description copied from interface: MQChainable

Returns the CCSID of the next header or message content.

Specified by:

nextCharacterSet in interface MQChainable

nextCharacterSet

public void nextCharacterSet(int value)

Description copied from interface: MQChainable

Sets the CCSID of the next header or message content.

Specified by:

nextCharacterSet in interface MQChainable

nextFormat

public java.lang.String nextFormat( )

Description copied from interface: MQChainable

Returns the format of the next header or message content.

Specified by:

nextFormat in interface MQChainable

nextFormat

public void nextFormat(java.lang.String value)

Description copied from interface: MQChainable

Sets the format of the next header or message content.

Specified by:

nextFormat in interface MQChainable

format

public java.lang.String format( )

Description copied from interface: MQChainable

Returns the format associated with this header object or message content.

Specified by:

format in interface MQChainable