nablarch.fw.messaging

Class FwHeader

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

nablarch.fw.messaging.FwHeader

All Implemented Interfaces:

java.util.Map

@Published(tag="architect")
public class FwHeader
extends java.util.HashMap

電文中のフレームワーク制御ヘッダ部の内容をMapとして格納するクラス。

フレームワーク制御ヘッダ

本フレームワークが提供する機能の中には、電文中に特定の制御項目が定義されている ことを前提として設計されているものが多く存在する。 そのような制御項目のことを「フレームワーク制御ヘッダ」とよぶ。 フレームワーク制御ヘッダの一覧とそれを使用するハンドラの対応は以下のとおり。

 ========================= ========================================
 フレームワーク制御ヘッダ             関連する主要なハンドラ                     
 ========================= ========================================
 リクエストID                 nablarch.fw.handler.RequestPathJavaPackageMapping
                            nablarch.fw.RequestHandlerEntry
                            nablarch.common.handler.ServiceAvailabilityCheckHandler
                            nablarch.common.handler.PermissionCheckHandler
                             ...他
 ユーザID                    nablarch.common.handler.PermissionCheckHandler
 再送要求フラグ                nablarch.fw.messaging.handler.MessageResendHandler
 ステータスコード              MessageReplyHandler
 ========================= ========================================
 

なお、フレームワーク制御ヘッダは、上記に挙げたハンドラ以外にも、 ログ出力やデータベースの共通項目といった部分においても使用されている。 電文中のフレームワーク制御ヘッダ部を解析して本クラスを生成する責務は FwHeaderDefinitionインタフェースの各実装クラスが持つ。

Author:

Iwauo Tajima

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRequestId() リクエストIDヘッダの値を返す。
java.lang.String	getStatusCode() 要求電文に対する処理結果を表すコード値を返す。
java.lang.String	getUserId() ユーザIDヘッダの値を返す。
boolean	hasUserId() ユーザIDヘッダ項目が電文レイアウトに定義されているかどうか。
boolean	isResendingRequest() この電文が再送電文であるかどうかを返す。 この電文が初回電文、もしくは、そもそも再送要求をサポートしていない場合 falseを返す。
boolean	isResendingSupported() この電文が再送要求をサポートしているかどうかを返す。
FwHeader	setRequestId(java.lang.String requestId) リクエストIDヘッダの値を設定する。
FwHeader	setResendFlag(java.lang.Object flag) 再送電文フラグの値を設定する。
FwHeader	setResendFlagOffValue(java.lang.Object offValue) 初回送信電文に設定される再送フラグの値を設定する。
FwHeader	setStatusCode(java.lang.String flag) 要求電文に対する処理結果を表すコード値を返す。
FwHeader	setUserId(java.lang.String userId) ユーザIDヘッダの値を設定する。

Method Detail

getRequestId

public java.lang.String getRequestId()

リクエストIDヘッダの値を返す。

Returns:

リクエストIDヘッダの値

setRequestId

public FwHeader setRequestId(java.lang.String requestId)

リクエストIDヘッダの値を設定する。

Parameters:

requestId - 設定する値

Returns:

このオブジェクト自体

getUserId

public java.lang.String getUserId()

ユーザIDヘッダの値を返す。

Returns:

ユーザIDヘッダの値

hasUserId

public boolean hasUserId()

ユーザIDヘッダ項目が電文レイアウトに定義されているかどうか。

Returns:

ユーザIDヘッダ項目が電文レイアウトに定義されていればtrue

setUserId

public FwHeader setUserId(java.lang.String userId)

ユーザIDヘッダの値を設定する。

Parameters:

userId - 設定する値

Returns:

このオブジェクト自体

isResendingRequest

public boolean isResendingRequest()

この電文が再送電文であるかどうかを返す。 この電文が初回電文、もしくは、そもそも再送要求をサポートしていない場合 falseを返す。

Returns:

この電文が再送電文であるかどうか。

isResendingSupported

public boolean isResendingSupported()

この電文が再送要求をサポートしているかどうかを返す。

Returns:

この電文が再送要求をサポートしているかどうか。

setResendFlag

public FwHeader setResendFlag(java.lang.Object flag)

再送電文フラグの値を設定する。

Parameters:

flag - 設定する値

Returns:

このオブジェクト自体

getStatusCode

public java.lang.String getStatusCode()

要求電文に対する処理結果を表すコード値を返す。

Returns:

ステータスコード

setStatusCode

public FwHeader setStatusCode(java.lang.String flag)

要求電文に対する処理結果を表すコード値を返す。

Parameters:

flag - 設定する値

Returns:

このオブジェクト自体

setResendFlagOffValue

public FwHeader setResendFlagOffValue(java.lang.Object offValue)

初回送信電文に設定される再送フラグの値を設定する。

Parameters:

offValue - 初回送信電文に設定される再送フラグの値

Returns:

このオブジェクト自体