FwHeader (NablarchApi)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap
  - - nablarch.fw.messaging.FwHeader

すべての実装されたインタフェース:

Map
```
@Published(tag="architect")
public class FwHeader
extends 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インタフェースの各実装クラスが持つ。
作成者:

Iwauo Tajima

関連項目:

直列化された形式

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`String`	`getRequestId()` リクエストIDヘッダの値を返す。
`String`	`getStatusCode()` 要求電文に対する処理結果を表すコード値を返す。
`String`	`getUserId()` ユーザIDヘッダの値を返す。
`boolean`	`hasUserId()` ユーザIDヘッダ項目が電文レイアウトに定義されているかどうか。
`boolean`	`isResendingRequest()` この電文が再送電文であるかどうかを返す。
`boolean`	`isResendingSupported()` この電文が再送要求をサポートしているかどうかを返す。
`FwHeader`	`setRequestId(String requestId)` リクエストIDヘッダの値を設定する。
`FwHeader`	`setResendFlag(Object flag)` 再送電文フラグの値を設定する。
`FwHeader`	`setResendFlagOffValue(Object offValue)` 初回送信電文に設定される再送フラグの値を設定する。
`FwHeader`	`setStatusCode(String flag)` 要求電文に対する処理結果を表すコード値を返す。
`FwHeader`	`setUserId(String userId)` ユーザIDヘッダの値を設定する。

- メソッドの詳細
  - getRequestId
```
public String getRequestId()
```
    リクエストIDヘッダの値を返す。
    
    戻り値:
    
    リクエストIDヘッダの値
  - setRequestId
```
public FwHeader setRequestId(String requestId)
```
    リクエストIDヘッダの値を設定する。
    
    パラメータ:
    
    requestId - 設定する値
    
    戻り値:
    
    このオブジェクト自体
  - getUserId
```
public String getUserId()
```
    ユーザIDヘッダの値を返す。
    
    戻り値:
    
    ユーザIDヘッダの値
  - hasUserId
```
public boolean hasUserId()
```
    ユーザIDヘッダ項目が電文レイアウトに定義されているかどうか。
    
    戻り値:
    
    ユーザIDヘッダ項目が電文レイアウトに定義されていればtrue
  - setUserId
```
public FwHeader setUserId(String userId)
```
    ユーザIDヘッダの値を設定する。
    
    パラメータ:
    
    userId - 設定する値
    
    戻り値:
    
    このオブジェクト自体
  - isResendingRequest
```
public boolean isResendingRequest()
```
    この電文が再送電文であるかどうかを返す。この電文が初回電文、もしくは、そもそも再送要求をサポートしていない場合 falseを返す。
    
    戻り値:
    
    この電文が再送電文であるかどうか。
  - isResendingSupported
```
public boolean isResendingSupported()
```
    この電文が再送要求をサポートしているかどうかを返す。
    
    戻り値:
    
    この電文が再送要求をサポートしているかどうか。
  - setResendFlag
```
public FwHeader setResendFlag(Object flag)
```
    再送電文フラグの値を設定する。
    
    パラメータ:
    
    flag - 設定する値
    
    戻り値:
    
    このオブジェクト自体
  - getStatusCode
```
public String getStatusCode()
```
    要求電文に対する処理結果を表すコード値を返す。
    
    戻り値:
    
    ステータスコード
  - setStatusCode
```
public FwHeader setStatusCode(String flag)
```
    要求電文に対する処理結果を表すコード値を返す。
    
    パラメータ:
    
    flag - 設定する値
    
    戻り値:
    
    このオブジェクト自体
  - setResendFlagOffValue
```
public FwHeader setResendFlagOffValue(Object offValue)
```
    初回送信電文に設定される再送フラグの値を設定する。
    
    パラメータ:
    
    offValue - 初回送信電文に設定される再送フラグの値
    
    戻り値:
    
    このオブジェクト自体

クラス FwHeader

メソッドのサマリー

メソッドの詳細

getRequestId

setRequestId

getUserId

hasUserId

setUserId

isResendingRequest

isResendingSupported

setResendFlag

getStatusCode

setStatusCode

setResendFlagOffValue