メッセージキューイングアクセス機能 TP1/Message Queue - Access 使用の手引

[目次][用語][索引][前へ][次へ]

MQQueueクラス(Java)

このクラスは,MQのキューにアクセスします。

コンストラクタ

● public MQQueue(MQQueueManager qMgr,String queueName,int openOptions, String queueManagerName,String dynamicQueueName,String alternateUserId) throws MQException

MQQueueコンストラクタです。

キューをオープンします。MQOPEN命令での,MQOT_Qの指定に相当します。

パラメタ

qMgr
取得済みMQQueueManagerオブジェクトを指定します

queueName
キュー名称を指定します。

openOptions
オープンオプションを指定します。

queueManagerName
キューマネジャ名称を指定します。

dynamicQueueName
ダイナミックキュー名称を指定します。

alternateUserId
代替ユーザ識別子を指定します。

メソッド

● public synchronized void get(MQMessage message, MQGetMessageOptions getMessageOptions, int MaxMsgSize) throws MQException

メッセージを取り出します。

MQGET命令に相当します。

パラメタ

message
MQMessageオブジェクトを指定します。

getMessageOptions
MQGetMessageOptionsオブジェクトを指定します。

MaxMsgSize
最大メッセージ長を指定します。

● public synchronized void get(MQMessage message, MQGetMessageOptions getMessageOptions ) throws MQException

メッセージを取り出します。メッセージサイズを取得するため,内部的にgetを2回実行します。

MQGET命令に相当します。

パラメタ

message
MQMessageオブジェクトを指定します。

getMessageOptions
MQGetMessageOptionsオブジェクトを指定します。

● public synchronized void get(MQMessage message) throws MQException

メッセージを取り出します。メッセージサイズを取得するため,内部的にgetを2回実行します。public synchronized void get(MQMessage message, MQGetMessageOptions getMessageOptions ) throws MQExceptionメソッドを単純化したものです。

MQGET命令に相当します。

パラメタ

message
MQMessageオブジェクトです。

● public synchronized void put(MQMessage message, MQPutMessageOptions putMessageOptions ) throws MQException

メッセージを登録します。

MQPUT命令に相当します。

パラメタ

message
MQMessageオブジェクトです。

putMessageOptions
MQPutMessageOptionsオブジェクトです。

● public synchronized void put(MQMessage message) throws MQException

メッセージを登録します。public synchronized void put(MQMessage message, MQPutMessageOptions putMessageOptions ) throws MQExceptionメソッドを単純化したものです。

MQPUT命令に相当します。

パラメタ

message
MQMessageオブジェクトです。

● public GregorianCalender getCreationDateTime() throws MQException

キュー作成日時を取得します。

● public int getQueueType() throws MQException

次に示す値でキュータイプを取得します。

MQINQ命令の,MQIA_Q_TYPEセレクタに相当します。

● public int getCurrentDepth() throws MQException

カレントキューのメッセージ個数を取得します。

MQINQ命令の,MQIA_CURRENT_Q_DEPTHセレクタに相当します。

● public int getDefinitionType() throws MQException

次に示す値でキュー定義タイプを取得します。

MQINQ命令の,MQIA_DEFINITION_TYPEセレクタに相当します。

● public int getMaximumDepth () throws MQException

キューの最大メッセージ個数を取得します。

MQINQ命令の,MQIA_MAX_Q_DEPTHセレクタに相当します。

● public int getMaximumMessageLength() throws MQException

メッセージの最大長を取得します。

MQINQ命令の,MQIA_MAX_MSG_LENGTHセレクタに相当します。

● public int getOpenInputCount() throws MQException

入力用にキューをオープンしている数を取得します。

MQINQ命令の,MQIA_OPEN_INPUT_COUNTセレクタに相当します。

● public int getOpenOutputCount() throws MQException

出力用にキューをオープンしている数を取得します。

MQINQ命令の,MQIA_OPEN_OUTPUT_COUNTセレクタに相当します。

● public int getShareability() throws MQException

次に示す値でキュー共用性を取得します。

MQINQ命令の,MQIA_SHAREABILITYセレクタに相当します。

● public int getInhibitPut() throws MQException

次に示す値でメッセージ登録許可属性を取得します。

MQINQ命令の,MQIA_INHIBIT_PUTセレクタに相当します。

● public void setInhibitPut(int inhibit) throws MQException

メッセージ登録許可属性を設定します。

MQSET命令の,MQIA_INHIBIT_PUTセレクタに相当します。

パラメタ

inhibit
登録許可属性です。次に示すどちらかの値を設定してください。
  • MQC.MQQA_PUT_INHIBITED:登録を禁止します。
  • MQC.MQQA_PUT_ALLOWED:登録を許可します。

● public int getInhibitGet() throws MQException

次に示す値でメッセージ取り出し許可属性を取得します。

MQINQ命令の,MQIA_INHIBIT_GETセレクタに相当します。

● public void setInhibitGet(int inhibit) throws MQException

メッセージ取り出し許可属性を設定します。

MQSET命令の,MQIA_INHIBIT_GETセレクタに相当します。

パラメタ

inhibit
登録許可属性です。次に示すどちらかの値を設定してください。
  • MQC.MQQA_GET_INHIBITED:取り出しを禁止します。
  • MQC.MQQA_GET_ALLOWED:取り出しを許可します。

● public int getTriggerControl() throws MQException

次に示す値でトリガ制御情報を取得します。

MQINQ命令の,MQIA_TRIGGER_CONTROLセレクタに相当します。

● public void setTriggerControl(int trigger) throws MQException

トリガ制御情報を設定します。

MQSET命令の,MQIA_TRIGGER_CONTROLセレクタに相当します。

パラメタ

trigger
トリガ制御情報です。次に示すどちらかの値を設定してください。
  • MQC.MQTC_OFF:トリガ制御をしません。
  • MQC.MQTC_ON:トリガ制御をします。

● public String getTriggerData() throws MQException

トリガデータを取得します。

MQINQ命令の,MQCA_TRIGGER_DATAセレクタに相当します。

● public void setTriggerData(String data) throws MQException

トリガデータを設定します。

MQSET命令の,MQCA_TRIGGER_DATAセレクタに相当します。

パラメタ

data
トリガデータ(最大長のMQC.MQ_TRIGGER_DATA_LENGTH)を指定します。

● public int getTriggerDepth() throws MQException

トリガのためのメッセージ登録数の下限値を取得します。

トリガタイプがMQC.MQTT_DEPTHの場合に,メッセージがキューにトリガのためのメッセージ登録数の下限値まで登録されたとき,トリガメッセージが発生します。

MQINQ命令の,MQIA_TRIGGER_DEPTHセレクタに相当します。

● public void setTriggerDepth(int depth) throws MQException

トリガのためのメッセージ登録数の下限値を設定します。

トリガタイプがMQC.MQTT_DEPTHの場合に,メッセージがキューにトリガのためのメッセージ登録数の下限値まで登録されたとき,トリガメッセージが発生します。

MQSET命令の,MQIA_TRIGGER_DEPTHセレクタに相当します。

パラメタ

depth
トリガのためのメッセージ登録数の下限値を指定します。

● public int getTriggerMessagePriority() throws MQException

トリガに対するメッセージ優先度しきい値を取得します。

MQINQ命令の,MQIA_TRIGGER_MSG_PRIORITYセレクタに相当します。

● public void setTriggerMessagePriority(int priority) throws MQException

トリガに対するメッセージ優先度しきい値を設定します。

MQSET命令の,MQIA_TRIGGER_MSG_PRIORITYセレクタに相当します。

パラメタ

priority
トリガに対するメッセージ優先度しきい値を指定します。

● public int getTriggerType() throws MQException

次に示す値でトリガタイプを取得します。

MQINQ命令の,MQIA_TRIGGER_TYPEセレクタに相当します。

● public void setTriggerType(int type) throws MQException

トリガタイプを設定します。

MQSET命令の,MQIA_TRIGGER_TYPEセレクタに相当します。

パラメタ

type

トリガタイプです。次に示す値のどれかを設定してください。