com.nec.webotx.jbi.binding.tcpip.handler
インタフェース TCPIPHandlerBase

既知のサブインタフェースの一覧:

ProtocolHandler, TCPIPHandler

public interface TCPIPHandlerBase

TCP/IP BCで使用するハンドラの基底クラスです。

作成者:

NEC Corporation.

メソッドの概要

boolean	check(java.io.InputStream in, java.io.OutputStream out, java.util.logging.Logger logger) TCP/IP BCのエンドポイントの定義でプロバイダかつコネクションチェック機能を有効にした場合、チェック時に実行する処理です。
void	destroy(java.util.logging.Logger logger) このオブジェクトが破棄されるときに実行する処理です。
void	error(java.lang.Exception e, java.io.OutputStream receiverOut, java.util.logging.Logger logger) MessageExchangeがErrorになった場合に実行する処理です。
void	fault(java.io.InputStream nmrIn, java.io.OutputStream receiverOut, java.util.logging.Logger logger) NMRからFaultを受け取った場合に実行する処理です。
void	init(java.util.Map<java.lang.String,java.lang.String> properties, java.util.logging.Logger logger) ハンドラを初期化します。
java.io.InputStream	receive(java.io.InputStream senderIn, java.io.OutputStream senderOut, java.util.logging.Logger logger) コンシューマの場合は、クライアントから受け取ったメッセージを処理します。
void	send(java.io.InputStream nmrIn, java.io.OutputStream receiverOut, java.util.logging.Logger logger) コンシューマの場合は、クライアントへ送信するメッセージを処理します。

メソッドの詳細

init

void init(java.util.Map<java.lang.String,java.lang.String> properties,
          java.util.logging.Logger logger)

ハンドラを初期化します。

パラメータ:

properties - ハンドラの設定が格納されたマップ

logger - ESBのログファイルにログ出力します。

receive

java.io.InputStream receive(java.io.InputStream senderIn,
                            java.io.OutputStream senderOut,
                            java.util.logging.Logger logger)
                            throws java.io.IOException,
                                   FaultException

コンシューマの場合は、クライアントから受け取ったメッセージを処理します。 プロバイダの場合は、サーバから受け取ったメッセージを処理します。

パラメータ:

senderIn - TCP/IP BCのエンドポイントへの入力ストリームです。

senderOut - 外部アプリケーションへの出力ストリームです。

logger - ESBのログファイルにログ出力します。

戻り値:

ESBに送信するメッセージを返却します。nullを返却するとNMRにメッセージを送信せずにコネクションを閉じます 。In-Optional -Outのプロバイダの場合はnullを返却するとMessageExchangeのステータスがDoneになります。

例外:

java.io.IOException - 例外の内容をログに出力してコネクションをクローズします。MessageExchangeのステータスがErrorになり、 つづけてerror()メソッドを実行します。

FaultException - MEPがRobust-In-Only/In-Out/In-Optional-Outでロールがプロバイダの場合に、 この例外が発生すると MessageExchangeにFaultが設定されます。

send

void send(java.io.InputStream nmrIn,
          java.io.OutputStream receiverOut,
          java.util.logging.Logger logger)
          throws java.io.IOException

コンシューマの場合は、クライアントへ送信するメッセージを処理します。 プロバイダの場合は、サーバへ送信するメッセージを処理します。 例外が上がるとESB側からソケットをクローズします。

パラメータ:

nmrIn - NMRからの入力ストリームです。ストリームの内容は、 エンドポイントの設定によりNormalizedMessageのContentかAttachmentかが切り替わります。

receiverOut - 外部アプリケーションへの出力ストリームです。

logger - ESBのログファイルにログ出力します。

例外:

java.io.IOException - 例外の内容をログに出力してコネクションをクローズします。MessageExchangeのステータスがErrorになり、 つづけてerror()メソッドを実行します。

fault

void fault(java.io.InputStream nmrIn,
           java.io.OutputStream receiverOut,
           java.util.logging.Logger logger)
           throws java.io.IOException

NMRからFaultを受け取った場合に実行する処理です。MEPがIn-Onlyの場合は呼び出されません。

パラメータ:

nmrIn - NMRからの入力ストリームです。ストリームの内容はFaultメッセージです。

receiverOut - 外部アプリケーションへの出力ストリームです。

logger - ESBのログファイルにログ出力します。

例外:

java.io.IOException - 例外の内容をログに出力してコネクションをクローズします。MessageExchangeのステータスがErrorになり、 つづけてerror()メソッドを実行します。

error

void error(java.lang.Exception e,
           java.io.OutputStream receiverOut,
           java.util.logging.Logger logger)
           throws java.io.IOException

MessageExchangeがErrorになった場合に実行する処理です。

パラメータ:

e - Errorになる際に発生した例外です。

receiverOut - 外部アプリケーションへの出力ストリームです。

logger - ESBのログファイルにログ出力します。

例外:

java.io.IOException - 例外の内容をログに出力します。

destroy

void destroy(java.util.logging.Logger logger)

このオブジェクトが破棄されるときに実行する処理です。

パラメータ:

logger - ESBのログファイルにログ出力します。

check

boolean check(java.io.InputStream in,
              java.io.OutputStream out,
              java.util.logging.Logger logger)

TCP/IP BCのエンドポイントの定義でプロバイダかつコネクションチェック機能を有効にした場合、チェック時に実行する処理です。 コンシューマまたはコネクションチェック機能が無効の場合は呼び出されません。

パラメータ:

in - 外部アプリケーションからの入力ストリームです。

out - 外部アプリケーションへの出力ストリームです。

logger - ESBのログファイルにログ出力します。

戻り値:

チェックの結果が成功の場合にtrueを返却します。チェックの結果が失敗した場合はfalseを返却します。 falseが返却されるとコネクションを閉じます。