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:
- MQChainable, MQData, MQHeader
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
-
Constructor Summary
Constructors 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
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description java.lang.String
format()
java.lang.String
getAuthenticator()
gets the RACF password or passticketint
getCodedCharSetId()
Get the Character set identifier of data that follows.char
getCommitMode()
gets the Commit modeint
getEncoding()
Get the numeric encoding of the data that follows.int
getFlags()
gets the Flagsjava.lang.String
getFormat()
gets the MQ format name of data that follows MQIIHjava.lang.String
getLTermOverride()
gets the Logical terminal overridejava.lang.String
getMFSMapName()
gets the Message format services map namejava.lang.String
getReplyToFormat()
gets the MQ format name of reply messagechar
getSecurityScope()
gets the Security scopejava.lang.String
getStrucId()
Get the structure identifier; the value will be MQIIH_STRUC_IDint
getStrucLength()
Get the length of the structure.byte[]
getTranInstanceId()
gets the Transaction instance identifierchar
getTranState()
gets the Transaction stateint
getVersion()
Get the Structure version numberint
nextCharacterSet()
void
nextCharacterSet(int value)
Sets the CCSID of the next header or message content.int
nextEncoding()
void
nextEncoding(int value)
Sets the numeric encoding of the next header or message content.java.lang.String
nextFormat()
void
nextFormat(java.lang.String value)
Sets the format of the next header or message content.void
setAuthenticator(java.lang.String value)
sets the RACF password or passticketvoid
setCodedCharSetId(int value)
Set the Character set identifier of data that follows.void
setCommitMode(char value)
sets the Commit modevoid
setEncoding(int value)
Set the numeric encoding of the data that follows.void
setFlags(int value)
sets the Flagsvoid
setFormat(java.lang.String value)
sets the MQ format name of data that follows MQIIHvoid
setLTermOverride(java.lang.String value)
sets the Logical terminal overridevoid
setMFSMapName(java.lang.String value)
sets the Message format services map namevoid
setReplyToFormat(java.lang.String value)
sets the MQ format name of reply messagevoid
setSecurityScope(char value)
sets the Security scopevoid
setTranInstanceId(byte[] value)
sets the Transaction instance identifiervoid
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
-
-
-
-
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 stucturejava.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 readencoding
- the initial numeric encoding of the data in the messagecharacterSet
- the initial CCSID of the data in the message- Throws:
MQDataException
- if the message content does not yield a valid MQIIH stucturejava.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()
- Specified by:
nextEncoding
in interfaceMQChainable
- Returns:
- the numeric encoding of the next header or message content.
- See Also:
MQChainable.nextEncoding()
-
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 interfaceMQChainable
- See Also:
MQChainable.nextEncoding(int)
-
nextCharacterSet
public int nextCharacterSet()
- Specified by:
nextCharacterSet
in interfaceMQChainable
- Returns:
- the CCSID of the next header or message content.
- See Also:
MQChainable.nextCharacterSet()
-
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 interfaceMQChainable
- See Also:
MQChainable.nextCharacterSet(int)
-
nextFormat
public java.lang.String nextFormat()
- Specified by:
nextFormat
in interfaceMQChainable
- Returns:
- the format of the next header or message content.
- See Also:
MQChainable.nextFormat()
-
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 interfaceMQChainable
- See Also:
MQChainable.nextFormat(java.lang.String)
-
format
public java.lang.String format()
- Specified by:
format
in interfaceMQChainable
- Returns:
- the format associated with this header object or message content.
- See Also:
MQChainable.format()
-
-