QueueConnectionインタフェース(JMS)

QueueConnectionインタフェースは,アプリケーションがTP1/Message Queueにアクセスするために使用するアプリケーションレベルのハンドルを提供します。

アプリケーションは,QueueConnectionFactoryオブジェクトのcreateQueueConnectionメソッドを使用してQueueConnectionオブジェクトを取得できます。

QueueConnectionの機能を次に示します。

形式

package:javax.jms

public interface Connection
{
 public void close() throws JMSException;
 public java.lang.String getClientID() throws JMSException;
 public ExceptionListener getExceptionListener() throws JMSException;
 public ConnectionMetaData getMetaData() throws JMSException;
 public void setClientID(java.lang.String clientID) throws JMSException;
 public void setExceptionListener(ExceptionListener listener) throws JMSException;
 public void start() throws JMSException;
 public void stop() throws JMSException;
}

public interface QueueConnection extends javax.jms.Connection
{
 public ConnectionConsumer createConnectionConsumer(Queue queue, java.lang.String messageSelector, ServerSessionPool sessionPool, int maxMessages) throws JMSException;
 public QueueSession createQueueSession(boolean transacted, int acknowledgeMode) throws JMSException;
}

メソッド

● public void close() throws JMSException

QueueConnectionをクローズします。

例外
JMSException:コネクションのクローズに失敗しました。

● public java.lang.String getClientID() throws JMSException

このメソッドは未サポートです。

例外
JMSException:このメソッドは未サポートです。

● public ExceptionListener getExceptionListener() throws JMSException

このメソッドは未サポートです。

例外
JMSException:このメソッドは未サポートです。

● public ConnectionMetaData getMetaData() throws JMSException

ConnectionMetaDataオブジェクトを参照します。

例外
JMSException:QueueConnectionがクローズされている状態で,このメソッドが発行されました。
戻り値:ConnectionMetaDataオブジェクト

● public void setClientID(java.lang.String clientID) throws JMSException

このメソッドは未サポートです。

パラメタ
clientID
クライアントIDを指定します。
例外
JMSException:このメソッドは未サポートです。
InvlidClientIDException:該当しません。
IllegalStateException:該当しません。

● public void setExceptionListener(ExceptionListener listener) throws JMSException

このメソッドは未サポートです。

パラメタ
listener
ExceptionListenerオブジェクトを指定します。
例外
JMSException:このメソッドは未サポートです。

● public void start() throws JMSException

コネクションの受信禁止状態を解除します。

例外
JMSException:コネクションの受信禁止状態の解除に失敗しました。または,QueueConnectionがクローズされている状態で,このメソッドが発行されました。

● public void stop() throws JMSException

コネクションを受信禁止状態にします。

コネクションが受信禁止状態になるとQueueRecieverオブジェクトは停止します。また,すでに受信待ちとなっているQueueRecieverオブジェクトのreceiveメソッドは中断されます。

例外
JMSException:コネクションの受信禁止に失敗しました。または,QueueConnectionがクローズされている状態で,このメソッドが発行されました。

● public ConnectionConsumer createConnectionConsumer(Queue queue, java.lang.String messageSelector, ServerSessionPool sessionPool, int maxMessages) throws JMSException

このメソッドは未サポートです。

パラメタ
queue
受信監視するQueueオブジェクトを指定します。
messageSelector
メッセージセレクタを指定します。ただし,指定値はnull固定です。null以外の文字列を指定しても無視されます。
sessionPool
ServerSessionPoolオブジェクトを指定します。
maxMessages
ServerSessionオブジェクトが一度に割り当てる最大メッセージ数を指定します。
例外
JMSException:このメソッドは未サポートです。
InvalidDestinationException:該当しません。
InvalidSelectorException:該当しません。
戻り値:ConnectionConsumerオブジェクト

● public QueueSession createQueueSession(boolean transacted, int acknowledgeMode) throws JMSException

コネクションを取得し,QueueSessionオブジェクトを生成します。ただし,acknowledgeModeは無視します。

パラメタ
transacted
OpenTP1でローカルなトランザクション管理をするかどうかを次の値で指定します。
true:ローカルトランザクション管理をします。
false:ローカルトランザクション管理をしません。
acknowledgeMode
QueueSessionオブジェクト生成時のモードを次の値で指定します。ただし,指定しても無視されます。
Session.AUTO_ACKNOWLEDGE:AUTO_ACKNOWLEDGEモード
Session.CLIENT_ACKNOWLEDGE:CLIENT_ACKNOWLEDGEモード
Session.DUPS_OK_ACKNOWLEDGE:DUPS_OK_ACKNOWLEDGEモード
例外
JMSException:QueueSessionの生成時にエラーが発生しました。または,QueueConnectionがクローズされている状態で,このメソッドが発行されました。
戻り値:QueueSessionオブジェクト