All Classes and Interfaces
Class
Description
HTTP通信時に使用するReaderクラス。
HTTP通信時に使用するWritterクラス。
日付を表す文字列を値に変換する抽象クラス。
ExecutorServiceFactory
の実装をサポートする抽象クラス。
ExecutorServiceFactory
の実装クラスで共通となる処理を提供する。リクエスト単体テストをテンプレート化するクラス。
本クラスを使用することで、リクエスト単体テストのテストソース、テストデータを 定型化することができる。
本クラスを使用することで、リクエスト単体テストのテストソース、テストデータを 定型化することができる。
HTTP通信時に使用するReaderクラス。
LettuceRedisClient
の共通処理をまとめた抽象クラス。NablarchItemWriteListener
を実装した抽象クラス。NablarchJobListener
を実装した抽象クラス。NablarchStepListener
を実装した抽象クラス。HttpRequestHandler
をResponseFinisher
として使用するクラス。
このクラスで使用できるHttpRequestHandler
は、自らレスポンスを作成せず、
後続ハンドラが返すレスポンスに変更を加えるハンドラに限定される。リクエスト単体テストのテスト実行前後に起動されるコールバックインタフェース。
リクエスト単体テストで、テスト実行前後に特別な準備処理、結果確認処理が必要な場合は
本クラスのサブクラスにてその処理を定義する。
AES暗号(128bit, CBC, PKCS5Padding)を使用して暗号化と復号を行うクラス。
AES暗号のコンテキスト情報を保持するクラス。
既にプロセスが実行中であることを示す例外クラス。
コンテキストパスの付加とURLリライトに対応するaタグを出力するクラス。
アノテーションが付与されたクラスをコンポーネントとして読み込む
ExternalizedComponentDefinitionLoader
。データベース接続を表すインタフェース。
コンポーネントの廃棄を行うインタフェース。
業務エラーが発生した際のメッセージ通知に使用する例外クラス。
コンポーネントの初期化を行うインタフェース。
アプリケーション設定に関するメッセージをJSON形式でフォーマットするクラス。
業務日付を取得するクラス。
システム設定値を取得するクラス。
アプリケーション設定に関するログフォーマットを行うクラス。
アプリケーション設定ログを出力するために必要な情報を保持するクラス。
業務日付を取得する。
システム設定値を取得する。
アプリケーション設定に関するログ出力をサポートするユーティリティクラス。
各種ログのJSON形式による出力に対応した
JsonSerializationManager
の実装クラス。applog用に拡張したMapをJSONにシリアライズするクラス。
各種ログ出力の実装を助けるユーティリティ。
配列に型変換するクラス。
配列をシリアライズするクラス。
受入れ可能なオブジェクトの型は 配列オブジェクト。
シリアライズによりJsonのarrayとして出力する。
受入れ可能なオブジェクトの型は 配列オブジェクト。
シリアライズによりJsonのarrayとして出力する。
ASCII文字の文字種チェックに使用するユーティリティクラス。
表明クラス。
テスト実行結果が期待通りであることを確認するのに使用する。
テスト実行結果が期待通りであることを確認するのに使用する。
非同期でハンドラリストの起動を行う
HandlerListInvoker
の実装クラス。MQ応答なし受信用アクション。
AsyncMessageReceiveAction
用設定クラス。MQ応答なし送信用の共通アクション。
リクエスト単体テスト用のメッセージ送信(応答なし)アクション。
AsyncMessageSendAction
用設定クラス。メール添付ファイルの情報を保持するデータオブジェクト。
添付ファイルサイズ上限値オーバー時に発生する例外クラス。
最小限のアクセサのみが公開されているkey-value構造体に対して、
Mapインターフェースを提供するラッパーを作成するための基底クラス。
autocomplete属性をOFFにする対象を表す列挙型。
オブジェクトの自動設定項目のフィールドに値を設定するインタフェース。
オブジェクトの事前変換処理が必要な場合には、本インターフェースの実装クラスを追加し、 実処理実行前にexecuteメソッドを呼び出すこと。 オブジェクトに対する
オブジェクトの事前変換処理が必要な場合には、本インターフェースの実装クラスを追加し、 実処理実行前にexecuteメソッドを呼び出すこと。 オブジェクトに対する
Java class for AutowireType.
入力データの内容に問題がある為に処理が継続できないことを示す例外。
CSRFトークンの検証失敗時にBadRequest(400)のレスポンスを返すクラス。
INFOレベルで検証失敗時のログを出力する。
Base64エンコードされた鍵を持つクラス。
Base64エンコーディングを行うユーティリティクラス。
データベースを入力とする
ItemReader
の抽象クラス。リクエスト単体テストコールバックの基本実装クラス。
リクエスト単体テストクラスを実装する際の型指定を簡略化するため、 本クラスは
リクエスト単体テストクラスを実装する際の型指定を簡略化するため、 本クラスは
TestCaseInfo
の型を指定している。Disposable
を実装したコンポーネントを指定した順序で廃棄するクラス。Initializable
を実装したコンポーネントを指定した順序で初期化するクラス。業務日付を提供するクラス。
データベースからコードをロードするクラス。
CodeManagerの基本実装クラス。
コミットログ出力の基本実装クラス。
ConversionManager
の基本実装クラス。Cors
の基本実装クラス。DaoContext
のデフォルト実装クラス。DaoContextFactory
の基本実装クラス。DataTypeMapping
の基本実装クラス。デフォルトの対応表を持っているが、マッピング表を外部から設定することもできる。
DateTimeConfiguration
のデフォルト実装クラス
BasicDateTimeConverterConfiguration
の代替として、デフォルトのコンバータのうち日付関連の処理をDate and Time APIをサポートしたものに差し替えたクラスDateTimeConverterConfiguration
のデフォルト実装クラスDbAccessExceptionFactory
の基本実装クラス。TransactionManagerConnection
の基本実装クラス。DataSource
からデータベース接続を取得し、BasicDbConnectionを生成すクラス。JNDI経由で取得した
DataSource
からデータベース接続(Connection
)を取得し、BasicDbConnectionを生成するクラス。DefaultValuesの基本実装クラス。
明示的にデフォルト値が設定された場合は、その値を返却する。 そうでない場合は以下の値をデフォルト値として返却する。
明示的にデフォルト値が設定された場合は、その値を返却する。 そうでない場合は以下の値をデフォルト値として返却する。
DoubleSubmissionHandler
の基本実装クラス。データベースのテーブルを用いてプロセスの多重起動防止を行う
DuplicateProcessChecker
の実装クラス。ExclusiveControlManager
の基本実装クラス。ExpirationSetting
の基本実装クラス。
IDと有効期限の紐付けをMapで保持する。事前に設定されたハンドラリストを返却する
HandlerListBuilder
実装クラス。HandlerListInvoker
の基本実装クラス。
設定されたHandlerListBuilder
を使用してハンドラリストを組み立てて、
そのハンドラリストを起動する。BasicHttpRequestTestExtension
を適用するための合成アノテーション。BasicHttpRequestTestTemplate
を JUnit 5 で使用するための Extension 実装。リクエスト単体テストテンプレートの基本実装クラス。
リクエスト単体テストクラスを実装する際の型指定を簡略化するため、 本クラスは
リクエスト単体テストクラスを実装する際の型指定を簡略化するため、 本クラスは
TestCaseInfo
の型を指定している。日本語文字種生成クラスの基本実装クラス。
本クラスでは、文字種と文字集合の組み合わせを定義するのみで、
実際の処理はスーパークラス(
CharacterGeneratorBase
)で実施している。
以下の文字種を生成できる。
半角英字
半角数字
半角記号
半角カナ
全角英字
全角数字
全角ひらがな
全角カタカナ
全角漢字
全角記号その他
サロゲートペア
中国語(Unicode上に含まれるがJIS X0213に含まれない漢字)
外字
日本語文字表現を解釈する基本実装クラス。
${文字種,文字数}という表現を解釈して、文字列に変換する。 例えば、{$全角英字, 10}という表現は10文字の全角英字に変換される。 使用可能な文字種については、
${文字種,文字数}という表現を解釈して、文字列に変換する。 例えば、{$全角英字, 10}という表現は10文字の全角英字に変換される。 使用可能な文字種については、
BasicJapaneseCharacterGenerator
を参照。JsonSerializationManager
の基本実装クラス。LogFormatter
の基本実装クラス。BasicLogFormatterクラスの特徴を下記に示す。
ログに最低限必要な情報(日時、リクエストID、ユーザIDなど)を出力できる。 アプリケーションを起動しているプロセスを識別するために、システムプロパティで指定されたプロセス名をログに出力できる。 オブジェクトを指定してフィールド情報を出力できる。 例外オブジェクトを指定してスタックトレースを出力できる。 フォーマットを設定のみで変更することができる。 BasicLogFormatterは、プレースホルダを使用してフォーマットを指定する。 フォーマットに指定可能なプレースホルダの一覧を下記に示す。
起動プロセスを取得するクラス。
出力日時を取得するクラス。
実行時IDを取得するクラス。
オプション情報に指定されたオブジェクトのフィールド情報を取得するクラス。
ロガー名を取得するクラス。
ログレベルを取得するクラス。
メッセージを取得するクラス
処理方式を取得するクラス。
リクエストIDを取得するクラス。
実行時ロガー名を取得するクラス。
エラー情報に指定された例外オブジェクトのスタックトレースを取得するクラス。
ユーザIDを取得するクラス。
Logger
の基本実装クラス。LoggerFactory
の基本実装クラス。フレームワーク実装の設定は、
LoggerManager
が読み込むプロパティファイルに記述する。プロパティファイルの設定は、システムプロパティを使用して同じキー名に値を指定することで上書きすることができる。
プロパティファイルの記述ルールを下記に示す。
writerNames 使用する全ての
LogWriter
の名称。必須。複数指定する場合はカンマ区切り。
「”writer.” + <ここで指定した
LogWriter
の名称>」をキーのプレフィックスにして、LogWriter
毎の設定を行う。
writer.<LogWriter
の名称>.className
LogWriter
のクラス名。必須。LogWriter
を実装したクラスのFQCNを指定する。
writer.<LogWriter
の名称>.<プロパティ名>
LogWriter
毎のプロパティに設定する値。設定内容は、使用する
LogWriter
のJavadocを参照すること。
availableLoggersNamesOrder
使用する全てのLogger
設定の名称。必須。複数指定する場合はカンマ区切り。
「”loggers.” + <ここで指定された
Logger
設定の名称>」をキーのプレフィックスに使用して、Logger
設定毎の設定を行う。
loggers.<Logger
設定の名称>.nameRegex
Logger
名とのマッチングに使用する正規表現。必須。正規表現は、
Logger
設定の対象となるLogger
を絞り込むために使用する。Logger
の取得時に指定されたLogger
名
(つまりLoggerManager#get
メソッドの引数に指定されたLogger
名)に対してマッチングを行う。
logger.<Logger
設定の名称>.level
LogLevel
の名称。必須。LogLevel
の名称を指定する。ここで指定したレベル以上のログを全て出力する。 logger.<
Logger
設定の名称>.writerNames
LogWriter
の名称。必須。複数指定する場合はカンマ区切り。
ここで指定した全ての
LogWriter
に対してログの書き込みを行う。
availableLoggersNamesOrderプロパティは、記述順に意味があるので注意すること。Logger
の取得では、ログ出力を行うクラスが指定したLogger
名に対して、
ここに記述した順番でLogger
のマッチングを行い、最初にマッチしたLogger
を返す。そのため、availableLoggersNamesOrderプロパティは、より限定的な正規表現を指定した
Logger
から順に記述すること。初期処理完了後に、各
LogWriter
に対して、出力されるログレベルの書き込みを行う。初期処理完了後の出力例を下記に示す。
オプション情報によりメッセージのフォーマット方法を切り替えフォーマットを行うクラス。
オプション情報が1つで
Map
のサブタイプの場合は、BasicMessageFormatter.NamedMessageFormat
を使用してメッセージをフォーマットする。
それ以外の場合は、MessageFormat
を使用してメッセージをフォーマットする。MessagingExceptionFactory
の基本実装クラス。ObjectMapperFactory
の基本実装クラス。認可制御グループをベースにした
このクラスでは、データベース上にユーザ及びユーザが属するグループ毎に使用できる認可単位を保持したテーブル構造から、 ユーザに紐付く認可情報を取得する。
Permission
を生成するクラス。このクラスでは、データベース上にユーザ及びユーザが属するグループ毎に使用できる認可単位を保持したテーブル構造から、 ユーザに紐付く認可情報を取得する。
事前に設定されたハンドラリストを返却する
PipelineListBuilder
実装クラス。処理中のプロセスを停止するためのハンドラ。
進捗を管理するステップスコープの
ProgressManager
実装クラス。RequestIdExtractor
の基本実装クラス。リクエストパスから"?"や"#"以降を取り除いた文字列をリクエストIDとして扱う。
RoleEvaluator
の基本的な実装を提供するクラス。ServletContextCreator
の基本実装クラス。セッションおよびリポジトリ経由でサーブレットコンテキストを取得する。
サーブレットコンテキストを取得できない場合は
IllegalStateException
を送出する。CallableStatement
のラッパークラス。SQL文をクラスパス上のリソース(SQLファイル)からロードするクラス。
名前付きバインド変数を持つSQL文を解析するクラス。
SQLの解析は、下記ルールにしたがい行う。
名前付き変数は「:」で開始される。 名前付き変数は、英字(大文字、小文字)、数字、アンダースコア(_)、パーセント(%)で構成されている。 リテラルは、シングルクォートで囲われている。 シングルクォートのエスケープは、シングルクォートである。 リテラル内に名前付き変数のルールに一致する文字列があっても、名前付き変数として扱わない。 コメントは存在しない。(コメント内に名前付き変数のルールに一致する文字列があった場合、名前付き変数として扱うためSQL実行時エラーが発生する。) SQL文の妥当性チェックは行わない。(構文エラーがあった場合は、SQLの実行時エラーとなる。) 本クラスは、解析したSQLの情報を保持するためスレッドアンセーフである。
SQLの解析は、下記ルールにしたがい行う。
名前付き変数は「:」で開始される。 名前付き変数は、英字(大文字、小文字)、数字、アンダースコア(_)、パーセント(%)で構成されている。 リテラルは、シングルクォートで囲われている。 シングルクォートのエスケープは、シングルクォートである。 リテラル内に名前付き変数のルールに一致する文字列があっても、名前付き変数として扱わない。 コメントは存在しない。(コメント内に名前付き変数のルールに一致する文字列があった場合、名前付き変数として扱うためSQL実行時エラーが発生する。) SQL文の妥当性チェックは行わない。(構文エラーがあった場合は、SQLの実行時エラーとなる。) 本クラスは、解析したSQLの情報を保持するためスレッドアンセーフである。
BasicSqlParameterParser
を生成するSqlParameterParser
の基本実装クラス。PreparedStatement
のをラップしたクラス。本クラスは、JDK5で実装済みのインタフェースのみを提供する。
SqlStatementExceptionFactory
のBasic実装クラス。SQLException
が一意制約違反の場合には、DuplicateStatementException
を生成する。一意制約違反以外の場合には、
SqlStatementException
を生成する。一意制約違反の判定には、
SQLException.getSQLState()
または、SQLException.getErrorCode()
を使用する。StatementFactory
の基本実装クラス。本クラスでは、下記の
SqlStatement
実装クラスを生成する。BasicSqlPStatement
nablarch.core.db.statement.BasicSqlCStatement
StaticDataCacheインタフェースの基本実装クラス。
静的データをHashMapに保持する。
静的データをHashMapに保持する。
StringResourceの基本実装クラス。
StringResourceHolderが使うキャッシュに必要な文字列リソースをデータベースから取得するクラス。
StringResourceの実装にはBasicStringResourceを用いる。
StringResourceの実装にはBasicStringResourceを用いる。
Date()
を現在日時とするSystemTimeProvider
。テストデータを読み込み、各オブジェクトにparseするクラス。
典型的なバリデーション処理を提供する、
ValidatingStrategy
の基本実装クラス。IBM MQを使用したメッセージング機能向けの
MessagingExceptionFactory
の基本実装クラス。WmqMqmdFieldsOperator
の基本実装クラス。標準的なバッチ処理における業務処理の基本実装クラス。
バッチ処理方式において、業務処理が継承する抽象基底クラス。
バッチのリクエストパスからアクションクラスの情報をタグとして取り出すためのユーティリティ。
バッチ実行時のパラメータを組み立てるクラス。
ParameterHolder
を複数集約し、
それらを整形する機能を持つ。バッチの処理件数をメトリクスとして収集する
CommitLogger
の実装クラス。BatchRequestTestExtension
を適用するための合成アノテーション。BatchRequestTestSupport
を JUnit 5 で使用するための Extension 実装。バッチリクエスト単体テストサポートクラス。
一括実行用(execute batch用)のSQL文とバインド変数に応じたカラムリストを保持するクラス。
バッチのトランザクションごとの処理時間をメトリクスとして計測するロガー。
JavaBeans型のコンポーネントを生成するクラス。
Java BeansオブジェクトをCSVにマッピングするクラス。
Beanを固定長にマッピングする
ObjectMapper
Java Beansの操作中に発生した例外を非検査例外でthrowするためのExceptionラッパー。
JavaBeansおよびレコードに関する操作をまとめたユーティリティクラス。
BeanValidation実行時に、Formクラスのインスタンスを生成するファクトリインタフェース。
ValidationResultMessage
同士の比較をメッセージ本文とプロパティ名で実行するためのクラス。BeanValidationを使用する場合のリクエスト内容のバリデーション、オブジェクト(Bean)生成ロジック.
Bean Validationを使用するときの
ValidationTestStrategy
実装クラス。BigDecimal
型への変換を行う Converter
。値をBigDecimalに変換するクラス。
本クラスで変換するプロパティには、必ずDigitsアノテーションを付与しておく必要がある。 本クラスでは、Digitsアノテーションの属性を下記の通り使用する。 Digitsアノテーションの属性名説明 integer整数部桁数上限値。指定値に上限はない。 fraction小数部桁数上限値。指定値に上限はない。 commatrueの場合、入力値が3桁区切り文字で編集されていてもよい。(区切り文字は省略可。) falseの場合、入力値が3桁区切り文字で編集されていてはいけない。 messageId変換失敗時のメッセージID。
本クラスで変換するプロパティには、必ずDigitsアノテーションを付与しておく必要がある。 本クラスでは、Digitsアノテーションの属性を下記の通り使用する。 Digitsアノテーションの属性名説明 integer整数部桁数上限値。指定値に上限はない。 fraction小数部桁数上限値。指定値に上限はない。 commatrueの場合、入力値が3桁区切り文字で編集されていてもよい。(区切り文字は省略可。) falseの場合、入力値が3桁区切り文字で編集されていてはいけない。 messageId変換失敗時のメッセージID。
バイナリであることを示す。
バイナリのため変換を行わずそのまま移送する。
ファイルデータを解釈するクラス。
バイナリ操作用ユーティリティクラス
リクエスト/レスポンスの変換を行うインタフェース。
BodyConverter
の実装クラスをサポートするクラス。ContentTypeを表すクラス。
BodyConverter
によるリクエスト/レスポンスの変換を行うハンドラ。Boolean
型への変換を行う Converter
。値をBooleanに変換するクラス。
Booleanの値をシリアライズするクラス。
ステートメント発行時にバインドされたパラメータを表すクラス。
ResultSetCacheKey
の等価性判定に使用される。List・Map・String 等の基本型からなるオブジェクトグラフの生成を簡略化する
ユーティリティメソッドを提供する。
一括バリデーション結果を保持するクラス。
エラーメッセージ一覧を、行数の昇順で保持するクラス。
アップロードファイルを一括バリデーションするためのクラス。
エラー発生時にメッセージIDを設定する一括バリデーションクラス。
業務日付を提供するクラスのインタフェース。
業務日付を取得するユーティリティクラス。
サブミット制御(ボタンとアクションの紐付け、二重サブミット防止)を行うbuttonタグを出力するクラス。
サブミット制御を行うbuttonタグを出力するクラスの実装をサポートするクラス。
バイト配列を認識する
Map
実装クラス。バイト配列のデータタイプ。
バイナリ(
byte
配列)への変換を行うConverter
.バイトストリームで入出力する文字列のデータタイプ。
バイトストリームで入出力するデータタイプが継承すべき抽象基底クラス。
キャッシュ機構を備えた
SqlPStatement
実装クラス。キャッシュ機能を備えた
StatementFactory
実装クラス。Cache-Controlレスポンスヘッダを設定するクラス。
デフォルトは"no-store"。
Cache-Controlレスポンスヘッダを個別に指定したいケースに対応するため、
Cache-Controlレスポンスヘッダが設定されてない場合のみ設定を行う。
上書きは行わない。
Calendarの値をシリアライズするクラス。
受入れ可能なオブジェクトの型は java.util.Calendar。
シリアライズによりJsonのstringとして出力する。
受入れ可能なオブジェクトの型は java.util.Calendar。
シリアライズによりJsonのstringとして出力する。
キー文字列の大文字・小文字を同一視する
Map
。ポップアップ用のサブミット時にパラメータ名を変更するクラス。
パラメータ名の変更情報を保持するクラス。
文字種チェック時に使用するユーティリティクラス。
文字生成インタフェース。
テスト用に、指定された文字種の文字を生成する。
テスト用に、指定された文字種の文字を生成する。
文字列生成基底クラス。
単純に、文字種と文字集合をカスタマイズしたい場合は本クラスを継承し、
コンストラクタで文字種と文字集合のペアを本クラスに渡せばよい。
(実装例は、
BasicJapaneseCharacterGenerator
を参照)Stringを元にした文字列生成クラス。
元になる文字集合からランダムに文字を選択して文字列を生成する。
有効な文字以外が含まれないかをチェックするバリデータの作成を助けるサポートクラス。
寄せ字変換処理の設定を保持するクラス。
寄せ字変換処理を行うクラス。
文字列の変換結果を格納するクラス。
文字列置換結果を取得・設定するユーティリティクラス。
入力時および出力時に寄せ字処理を行うコンバータ。
文字ストリームで入出力する文字列のデータタイプ。
文字ストリームで入出力するデータタイプが継承すべき抽象規定クラス。
HTTP通信時に使用するReaderクラス。
HTTP通信時に使用するReaderクラス。
許容する文字の集合の定義する為のインタフェース。
与えられたUnicodeコードポイントが許容文字であるか判定する責務を持つ。 自身の文字集合に含まれている場合は真を返却する。 どのようなデータ構造で集合を定義するかは規定しない。
与えられたUnicodeコードポイントが許容文字であるか判定する責務を持つ。 自身の文字集合に含まれている場合は真を返却する。 どのようなデータ構造で集合を定義するかは規定しない。
CharsetDef
実装クラスをサポートするクラス。許容文字集合定義を用いたバリデーション用のユーティリティクラス。
文字種のバリデーションテストの種類。
入力データ復元とHTMLエスケープを行うinputタグ(type="checkbox")を出力するクラス。
n:checkboxesタグで表示できないレイアウト時に使用する。
n:checkboxesタグで表示できないレイアウト時に使用する。
チェックなしに対する値をリクエストパラメータに設定するチェックボックスの実装をサポートするクラス。
checked属性を持つinputタグを出力するクラスの実装をサポートするクラス。
アクションのメソッドを実行するために必要なロールを、
アクセスしてきたユーザが持つかチェックする
Interceptor
。CheckRole
アノテーションのインターセプタ。アクションメソッドに設定された
CheckRole
アノテーションの情報をログに出力するロガー。RoleEvaluator
を用いたロール管理をプログラムから利用するためのユーティリティ。Deprecated.
クラスに対して処理を行うためのユーティリティクラス。
クラスを横断して処理するためのハンドラインタフェース。
CloudWatchAsyncClient
のインスタンスを提供するインターフェース。CloudWatchMeterRegistry
のファクトリ。単一のコードデータ(コードIDに紐づくデータ)にアクセスするインタフェース。
入力データ復元とHTMLエスケープを行うコード値の選択項目(inputタグ(type="checkbox"))を出力するクラス。
入力データ復元とHTMLエスケープを行うコード値の単一入力項目(inputタグ(type="checkbox"))を出力するクラス。
コード値の複数のchecked属性を持つinputタグを出力するクラスの実装をサポートするクラス。
コードの値と名称を取り扱うインタフェース。
コード名称テーブルのスキーマ情報を保持するクラス。
コード名称テーブルのスキーマ情報を保持するクラス。
入力データ復元とHTMLエスケープを行うコード値の選択項目(inputタグ(type="radio"))を出力するクラス。
入力データ復元とHTMLエスケープを行うコード値の選択項目(selectタグ)を出力するクラス。
コード値を出力するクラス。
コード値の選択項目を出力するタグの実装をサポートするクラス。
コードの値、及び名称の取り扱いのために使用するユーティリティ。
コード値を表わすアノテーション。
指定したコードIDの値と、プロパティの値が合致するかチェックするアノテーション。
検証対象の値が、指定したコードに適合することを検証する
ConstraintValidator
実装クラス(抽象クラス)。検証対象の値の配列が、指定したコードに全て適合することを検証する
CodeValue.AbstractCodeValueValidator
の継承クラス。
* @author Naoki Yamamoto検証対象の値が、指定したコードに適合することを検証する
CodeValue.AbstractCodeValueValidator
の継承クラス。
* @author Naoki YamamotoCodeValue
アノテーションを複数指定するためのアノテーション。コード値をチェックするクラス。
Collection
への型変換をサポートするクラス。入力データ復元とHTMLエスケープを行うinputタグ(type="color")を出力するクラス。
カラムの定義情報を保持するクラス。
コマンドラインオプション、コマンドライン引数をパースして格納するクラス。
コマンドライン引数のパーサクラス。
コマンドラインオプション
パース結果
コミットログ出力インタフェース。
コンポーネント定義を行う型。
Java class for anonymous complex type.
コンポーネントを生成するインタフェース。
DIコンテナがコンポーネントの生成に使用する定義を保持するクラス。
コンポーネント設定ファイルをパースするクラス。
コンポーネントの定義を読み込むインタフェース。
コンポーネントのインスタンスを生成するインタフェース。
このインタフェースを登録したクラスをDIコンテナにコンポーネントとして登録した場合、
このオブジェクトそのものではなくメソッドcreateComponentで返されるオブジェクトが
コンポーネントとして使用される。
DIコンテナ内でコンポーネントとコンポーネントの状態を保持するクラス。
コンポーネントを生成後はこのクラスがコンポーネントを保持する。
コンポーネントを生成後はこのクラスがコンポーネントを保持する。
インジェクションに相当する特殊な初期化処理を行うインタフェース。
このインタフェースは、ListやMapといったプロパティを持たないクラス でもインジェクションと同様に他のコンポーネントの参照を解決できる ように初期化する目的で使用する。
このインタフェースは、ListやMapといったプロパティを持たないクラス でもインジェクションと同様に他のコンポーネントの参照を解決できる ように初期化する目的で使用する。
コンストラクタ引数がコンポーネント参照によるインジェクト対象であることを表すアノテーション。
Java class for ComponentRef complex type.
コンポーネント定義の参照に関する情報を保持するクラス。
コンポーネントの状態を表す列挙型。
複数の
本クラスでは、他の許容文字集合定義の組み合わせにより文字集合を定義できる。
CharsetDef
の組み合わせによる許容文字集合定義クラス。本クラスでは、他の許容文字集合定義の組み合わせにより文字集合を定義できる。
複数の
CommitLogger
を組み合わせたロガークラス。複数の
ExternalizedComponentDefinitionLoader
を組み合わせたローダー。複数のテストデータ表記を解釈するクラス。
解釈対象の値が、複数のテストデータ表記から構成される場合、各要素を解釈した結果を返却する。 例えば、${半角数字,4}-${半角数字,4}という記述は、1033-1222のような値に変換される。
解釈対象の値が、複数のテストデータ表記から構成される場合、各要素を解釈した結果を返却する。 例えば、${半角数字,4}-${半角数字,4}という記述は、1033-1222のような値に変換される。
画面から送信された複合キーを格納するクラス。
値を
CompositeKey
の配列に変換するクラス。複数キーのデータに対して、入力データ復元とHTMLエスケープを行うinputタグ(type="checkbox")を出力するクラス。。
複数キーのデータに対してradio、checkboxといった選択型の入力を実現する特殊なタグの作成を助けるクラス。
値を
CompositeKey
に変換するクラス。複数キーのデータに対して、入力データ復元とHTMLエスケープを行うinputタグ(type="radio")を出力するクラス。。
特定文字で区切った複合キーの集合、またはその配列から構成されるパラメータを格納する、
CompositeKey
型のプロパティに付与するアノテーション。プロパティファイルの読み込みを設定する際に使用する型。
設定ファイルから文字列の設定値を読み込むクラス。
このクラスで使用する特殊文字は '=' '#' '\' の3文字(下記参照)。
デリミタ文字('=')
デリミタ文字は'='のみで、空白(タブを含む)や":"も文字列の一部とみなす。
(いわゆるpropertiesファイルとは異なる。)
但し、キー及び値はそれぞれ前後の空白(タブを含む)をトリミングする。
(" A B "(スペースAスペースBスペース)という文字列は
"A B"(AスペースB)となる。キーの'A'と'a'は区別される。)
デリミタ文字'='で区切られた3つめ以降のトークンは無視する。
'='をキーまたは値に含めたい場合は前に'\'を付加する。 コメント文字('#') コメント文字'#'を使用するとその行の以降の文字列はコメントとみなす。 '#'によるコメントを除去する処理は行連結の前に行われるので、 継続行中でも使用可能(下記「使用例」参照)。
'#'をキーまたは値に含めたい場合は前に'\'を付加する。 改行文字('\') キーと値のセットは行末に'\'を指定することによって行をまたがることが可能。 その場合'\'を除いた文字列と次の行の先頭の空白(タブを含む)を除いた 文字列を連結する。('\'を除いた文字列の後方の空白は維持する。)
キーまたは値の行末に'\'を含めたい場合は前に'\'を付加する。 エスケープ文字('\') '\'を記述すると次の1文字を特殊文字ではなく一般文字として扱う。
'\'をキーまたは値に含めたい場合は前に'\'を付加する。 読み込むファイルの記述例:
'='をキーまたは値に含めたい場合は前に'\'を付加する。 コメント文字('#') コメント文字'#'を使用するとその行の以降の文字列はコメントとみなす。 '#'によるコメントを除去する処理は行連結の前に行われるので、 継続行中でも使用可能(下記「使用例」参照)。
'#'をキーまたは値に含めたい場合は前に'\'を付加する。 改行文字('\') キーと値のセットは行末に'\'を指定することによって行をまたがることが可能。 その場合'\'を除いた文字列と次の行の先頭の空白(タブを含む)を除いた 文字列を連結する。('\'を除いた文字列の後方の空白は維持する。)
キーまたは値の行末に'\'を含めたい場合は前に'\'を付加する。 エスケープ文字('\') '\'を記述すると次の1文字を特殊文字ではなく一般文字として扱う。
'\'をキーまたは値に含めたい場合は前に'\'を付加する。 読み込むファイルの記述例:
Domaに必要な設定を保持するクラス。
初期値設定を読み取るクラス。
テスト側からテスト対象のコンポーネント設定ファイルを読む場合に使用する。 DIコンテンおよびコンポーネントの参照はキャッシュされる。
テスト側からテスト対象のコンポーネント設定ファイルを読む場合に使用する。 DIコンテンおよびコンポーネントの参照はキャッシュされる。
設定のロードに失敗した際に発生する例外。
コンストラクタ引数が設定値のインジェクト対象であることを表すアノテーション。
JSPが確認画面であることを示すクラス。
このタグが指定されると、入力項目のカスタムタグは確認画面用の出力を行う。
このタグに入力画面へのパスを指定することで、入力画面と確認画面を共通化する。
このタグが指定されると、入力項目のカスタムタグは確認画面用の出力を行う。
このタグに入力画面へのパスを指定することで、入力画面と確認画面を共通化する。
要求された処理が既に行われた(もしくは並行して実行されている)
処理の結果と競合しているため、処理を継続することができないことを示す例外。
データベース接続(
TransactionManagerConnection
)を生成するインタフェース。Domaで生成したデータベース接続をNablarch用の
TransactionManagerConnection
に変換するクラス。ConnectionFactory
の実装をサポートするクラス。Bean Validationのバリデーション結果を
Message
に変換するクラス。ConstraintViolationConverter
を生成するファクトリクラス。コンストラクタインジェクションできるよう拡張した
BeanComponentCreator
。DIコンテナ内の処理に失敗した際に発生する例外。
HTTPレスポンスオブジェクト中のコンテンツパス文字列の置換ルール。
Content-Security-Policyレスポンスヘッダを設定するクラス。
X-Content-Type-Optionsレスポンスヘッダを設定するクラス。
BeanUtilsが提供するJavaBeansの処理において何らかの問題が
発生した場合に送出される実行時例外。
コンバータに使用するアノテーションを表すアノテーション。
型変換機能を管理するインタフェース。
JavaBeansのプロパティ転送時に必要となる型変換を行うユーティリティクラス。
コンバータのユーティリティクラス。
JavaBeans間のプロパティ転送の際、型の変換を行うモジュールが実装する
インターフェース。
入力値から対応するプロパティの型に変換するインタフェース。
コンバータの生成を行う抽象基底ファクトリクラス。
コンバータ名とコンバータ実装クラスの対応表をもとに、コンバータを生成する。
コンバータの設定情報を保持するクラスが実装するインタフェース。
クッキーに対するアクセスをサポートするクラス。
クッキーのhttpOnly属性はアプリケーションで使用しているServlet APIがサポートしている場合のみ設定する。
スレッド毎のスナップショットを作成することで、並行アクセスに対する一貫読み取りおよび、
楽観ロック方式による書き込みを行うラッパークラス。
マップ内にserialize不可能なオブジェクトが存在するなどの理由により、
スナップショットの作成に失敗したことを表す実行じ例外。
プロパティ単位のコピーの設定をするアノテーション。
Beanのコピー
で使用される設定をまとめたクラス。CopyOptions
のビルダー。日付パターン・数値パターンをもとに
Converter
を提供するインターフェース。CopyOptions.ConvertersProvider
のデフォルト実装。CORSの処理を行うインタフェース。
CORSのプリフライトリクエストを処理するハンドラ。
実際のリクエストに対するレスポンスにCORSのレスポンスヘッダを設定するクラス。
リトライ回数によりリトライ処理を制御するクラス。
CountingRetryContext
を生成するクラス。メール作成時の失敗を表す例外。
MessagingExceptionをラップする際に、入力情報を含めることでより詳細なメッセージを作成できる。
MessagingExceptionをラップする際に、入力情報を含めることでより詳細なメッセージを作成できる。
セキュアハンドラがCSP向けのnonceを生成した場合にnonceを出力するクラス
CSRFトークンの生成を行うインターフェース。
CSRFトークンに関するユーティリティ。
CSRFトークンの検証を行うハンドラ。
CSVにバインドするBeanであることを表すアノテーション。
CsvDataBindConfig
のフォーマットを表す列挙型CSVフォーマットとJava Beanをマッピングするクラス。
CSVのフォーマットを表すクラス。
出力時にフィールド囲み文字で囲むフィールドを指定するモードの定義。
Csv
アノテーションをCsvDataBindConfig
に変換するクラス。CSVの解析を行うクラス。
CSVを出力するクラス。
Beanに紐づくCSVのフォーマットを個別に定義するアノテーション。
CSVフォーマットと
Map
をマッピングするクラス。CSVをオブジェクトにマッピングするのをサポートするクラス。
データベース更新時にフィールドの値にシステム日時を設定する事を表すアノテーション。
詳細は、
詳細は、
CurrentDateTimeAnnotationHandler
を参照。CurrentDateTimeが設定されているフィールドにシステム日時を設定するクラス。
HTTPレスポンスの書き込みを行うインタフェース。
レスポンスの種類に応じて、処理を行うか否かを判定する。
処理対象と判定した場合、レスポンス出力が実行される。
JSP以外で、任意のテンプレートエンジン等を使用して
レスポンスを出力する用途を想定している。
カスタムタグのデフォルト値を保持するクラス。
カスタムタグのベースクラス。
UniversalDao
の実行コンテキスト。DaoContext
を生成するファクトリクラス。JDBCの
DatabaseMetaData
からメタ情報を取得するクラス。DatabaseRecordReader
で処理対象レコードをキャッシュするためのデータベースアクセス前に
コールバックされるメソッドを定義するインタフェース。データベースの参照結果を1レコードづつ読み込むデータリーダ。
データベースのテーブルを擬似的にキューのように扱うデータリーダ。
リクエストを識別するオブジェクト。
データベースに関するユーティリティクラス。
データバインドの設定を表すマーカーインタフェース。
アノテーションに定義された変換対象のレイアウト情報を
DataBindConfig
に変換するインタフェース。データバインドに関するユーティリティクラス。
DatadogMeterRegistry
のファクトリ。ファイルを表すクラス。
ファイルの断片を表すクラス。
1つのレコード種別とそのレコード種別に適合する複数のレコードにより構成される。
1つのレコード種別とそのレコード種別に適合する複数のレコードにより構成される。
固定長ファイルのテストデータを解析するクラス。
処理状態
汎用データフォーマット機能の設定クラス。
データをリードするためのインタフェース。
Handler
が処理する入力データを外部から読み込むインタフェース。これ以上読み取るデータが無いことを示す例外。
データリーダのファクトリクラスが実装するインスタンス。
業務コンポーネントで処理するデータを
DataReader
から読み込む
Handler
実装クラス。データレコード1件分の内容を格納するクラス。
データファイルとJavaオブジェクトのシリアライズ/デシリアライズを行うクラスが実装するインタフェース。
フォーマット定義ファイルの内容に従い、ファイルデータの読み書きを行うクラスの抽象基底クラス。
ファイルフォーマッタが共通的に使用するディレクティブの名前と値の型。(タイプセーフEnum)
以下に一覧を示す。
file-type:String text-encoding:String record-separator:String
file-type:String text-encoding:String record-separator:String
データレコードに対する真偽条件を表すクラス。
データレコード中の特定のフィールドの内容が、
指定された値と一致することを表すPredicate。
Map型のデータレコードのリストを一定のフォーマットに従って直列化し、
その内容をレスポンスボディとするHTTPレスポンスオブジェクト。
ファイルや電文のストリームを読み書きし、
フィールドへの変換を行うデータタイプが継承すべき抽象基底クラス。
データタイプ定義クラス。
外部インタフェース設計書のデータ型とフレームワークのデータ型を
対応付けするクラス。
データを書き込むインタフェース。
java.util.Date
型への変換を行う Converter
。入力値が日付書式に一致することを検証するアノテーション。
日付書式をバリデーションする
ConstraintValidator
クラス。複数指定用のアノテーション
日時を取得する出力項目の実装をサポートするクラス。
日時でログのローテーションを行うクラス。
ログ書き込み時の現在日時 >= 保持している次回ローテーション日時の場合、ローテーションを行う。
ログ書き込み時の現在日時 >= 保持している次回ローテーション日時の場合、ローテーションを行う。
Deprecated.
YYYYMMDDFormatter
に置き換わりました。入力データ復元とHTMLエスケープを行うinputタグ(type="date")を出力するクラス。
Date and Time APIに関する共通的なフォーマッタ、タイムゾーンを扱うためのインターフェース。
DateTimeConverterConfiguration
と同様のクラスDate and Time APIに関する共通的なフォーマッタ、タイムゾーンを扱うためのインターフェース。
Date and Time API向けのユーティリティ。
日時のフォーマットを行うクラス。
日付をフォーマットするクラス
日時に関する記法を解釈するクラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="datetime-local")を出力するクラス。
日付文字列をフォーマットするクラス
Date and Time API向けのユーティリティ。
Dateの値をシリアライズするクラス。
受入れ可能なオブジェクトの型は java.util.Date。
java.sql.Date, java.sql.Time, java.sql.Timestamp などの Dateのサブクラスは対象にならない。 シリアライズによりJsonのstringとして出力する。
受入れ可能なオブジェクトの型は java.util.Date。
java.sql.Date, java.sql.Time, java.sql.Timestamp などの Dateのサブクラスは対象にならない。 シリアライズによりJsonのstringとして出力する。
Deprecated.
バージョン5以降では、新しいパッケージの
DateUtil
を使用すること。日付ユーティリティ。
DB2用の方言クラス。
データベースアクセス時に発生する例外。
SQL文実行時例外の内容に応じて、
DbAccessException
を生成するインタフェース。クラスパス上のSQLが記述されたリソースファイル(SQLリソース)から、
実行可能なSQLステートメントを取得するサポートクラス。
DbAccessTestExtension
を適用するための合成アノテーション。DbAccessTestSupport
を JUnit 5 で使用するための Extension 実装。データベースアクセス自動テスト用基底クラス。
データベースアクセスクラスの自動テストを行う場合には、本クラスを継承しテストクラスを作成する。
本クラス以外の基底クラスを継承しなければならない場合は、
本クラスのインスタンスを生成し処理を委譲することで代替可能である。
データベースアクセスクラスの自動テストを行う場合には、本クラスを継承しテストクラスを作成する。
本クラス以外の基底クラスを継承しなければならない場合は、
本クラスのインスタンスを生成し処理を委譲することで代替可能である。
データベース接続(
AppDbConnection
)をスレッド単位に管理するクラス。データベース接続に関する問題が発生した場合に送出される例外。
後続ハンドラの処理で必要となる、データベース接続オブジェクトを
スレッドローカル変数上で管理するハンドラ。
バッチ処理で必要となるデータベース接続をスレッドローカル上で管理する
StepListener
実装クラス。DBアクセス時のインスタンスへの参照を保持するコンテキストクラス。
DBのヘルスチェックを行うクラス。
SQLを発行し、例外が発生しなければヘルシと判断する。
Dialect.getPingSql()
から取得したSQLを発行する。DBシステム情報取得インタフェース。
トランザクション制御をせず処理するループ制御ハンドラークラス。
DBデータ以外のテストデータを読み込み、各オブジェクトにparseするクラス。
DBを使用した
Expiration
実装クラス。セッションの内容をDBに格納/読み込みする
DbStore
。DBを使用した
TokenManager
実装クラストークンテーブルのスキーマ情報を保持するクラス。
データベースアクセス機能で利用するユーティリティクラス。
10進数のフォーマットを行うクラス。
PackedDecimal
およびZonedDecimal
のヘルパクラス。入力値が指定された値の範囲内であるかチェックする。
入力値が整数の場合は、
NumberRange
を用いること。数値型のプロパティが指定した数値の範囲内であるかをチェックするアノテーション。
指定された実数の範囲の数値であることを検証するバリデータ。
複数指定用のアノテーション
小数部を含む数値の範囲バリデーションを行う。
デフォルトのコンバータ。
デリゲートファクトリ(
DelegateFactory
)のデフォルト実装クラス。
本実装では、与えられた委譲対象クラスのインスタンスをClass.newInstance()
により生成する。
DispatchHandler.setDelegateFactory(DelegateFactory)
に本クラスを設定することで、
5u14までのDispatchHandler
と全く同じ動作となる。デフォルトの
Dialect
実装クラス。デフォルトの
MeterBinder
リストを提供するクラス。出力データが未設定の場合に、デフォルト値を設定するコンバータ。
入力時にはデフォルト値は使用せず、入力データをそのまま返却する。
データベースデフォルト値を表すインタフェース。
TableData
にてカラムが省略された場合、
本インタフェースの実装クラスからデフォルト値が取得される。遅延Entityリストを表すクラス。
委譲先クラスのインスタンスを生成するファクトリインタフェース。
本インタフェースにて生成されたインタフェースは、
DispatchHandler
からディスパッチされる用途に使用される。データベースの実装依存の方言を吸収するためのインタフェース。
DIコンテナの機能を実現するクラス。
数値フォーマット指定を表わすアノテーション。
数値の整数部、小数部が指定された桁数以内であることを表すアノテーション。
桁数をバリデーションする
ConstraintValidator
クラス。複数指定用のアノテーション
Validator
をメソッド内の直接呼び出しに対応させる場合に実装する
インターフェース。ディレクティブを表すクラス。
コンテキストルート直下のディレクトリを言語の切り替えに使用するクラス。
ハンドラキューの委譲チェインとは独立したルールに従って、
ハンドラのディスパッチを行うハンドラ(ディスパッチャ)
サブミットを行うタグの表示制御が必要か否かを判定するインタフェース。
フォームのサブミットを行うタグを表示制御する場合の表示方法を表す列挙型
廃棄処理を行うインタフェース。
廃棄処理を必要とするクラスは本インタフェースを実装すること。
廃棄処理を必要とするクラスは本インタフェースを実装すること。
Closeable
オブジェクトをDisposable
として扱うためのアダプタ。Domaを使用してデータベースアクセスを行うための設定を保持するクラス。
Domaで使用するDaoの実装クラスを生成・保持するクラス。
指定されたドメイン定義に合致することを表わすアノテーション。
複数指定用のアノテーション
ドメイン定義を表すインタフェース。
1つのコンバータ定義と複数のバリデーション定義を持つことができる。
ドメインバリデーションに使用するドメイン定義を管理するクラス。
ドメイン定義によるバリデーションをサポートするヘルパークラス。
ドメイン定義にしたがってバリデーションを行うバリデータ。
ドメインバリデーションを行う
ConstraintValidator
実装クラス。Domaの設定
の中でStatement
に関するものをまとめたクラス。
バッチサイズはStatementに設定する項目ではないが、Statementを実行する単位を決定するための値なので当クラスに含んでいる。
ItemWriteListener
レベルでDomaのトランザクション制御を行うNablarchItemWriteListener
の実装クラス。Domaを使用してトランザクションを使用せずデータベースアクセスを行うための設定を保持するクラス。
ステップレベルで、Domaのトランザクション制御を行う
NablarchStepListener
の実装クラス。ダブルバイト文字列のデータタイプ。
OnDoubleSubmissionアノテーションに対する処理を行うインタフェース。
ダウンロードを行うbuttonタグを出力するクラス。
ダウンロードファイル名をエンコードするインタフェース。
User-Agentヘッダとエンコーダの関連を保持するエントリ。
User-Agentに対応するエンコーダを取得するインタフェース。
ダウンロードを行うaタグを出力するクラス。
ダウンロードを行うinputタグ(type="submit","button","image")を出力するクラス。
設定値に重複する設定が存在した場合の動作ポリシーを表す列挙型。
同一ジョブが同時に複数実行されないことを保証するための
NablarchJobListener
実装クラス。プロセスの多重起動を防止するためのチェック処理を行うインタフェース。
プロセスの2重起動をチェックするハンドラ。
プロセスが2重に起動された場合に送出される例外クラス。
一意制約違反時に発生する例外クラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="email")を出力するクラス。
JVM内蔵式メッセージングサーバによる簡易メッセージングプロバイダ実装。
この実装では、サブスレッド上で動作するJMSプロバイダ実装を内蔵しており、
そこに接続して動作する。
これにより、外部のMOMを用意すること無くメッセージング処理を含んだ業務機能の
単体テストを実施することが可能である。
現時点の実装では、自動テストでの利用のみを想定しているため、
リモートキューへの転送はサポートしていない。
また、内部的にActiveMQのメッセージブローカーとvm:// プロトコルを使用しているため、
本機能を利用する場合は、ActiveMQのライブラリをクラスパスに含める必要がある。
セッションの内容をエンコードする際に発生する例外。
暗号化と復号を行うインタフェース。
jp.co.tis.gsp.tools.db.EntityDependencyParser
から移植。UniversalDao
から返される結果リストの保持クラス。Entityクラスのメタデータを保持するクラス。
Entityを持つレスポンス。
Produces
を使用した場合に
レスポンスヘッダとステータスコードを指定したい場合に使用する。EntityTestExtension
を適用するための合成アノテーション。エンティティテスト用設定クラス。
EntityTestSupport
を JUnit 5 で使用するための Extension 実装。エンティティ自動テスト用基底クラス。
エンティティクラスの自動テストを行う場合には、本クラスを継承しテストクラスを作成する。 本クラス以外の基底クラスを継承しなければならない場合は、 本クラスのインスタンスを生成し処理を委譲することで代替可能である。
エンティティクラスの自動テストを行う場合には、本クラスを継承しテストクラスを作成する。 本クラス以外の基底クラスを継承しなければならない場合は、 本クラスのインスタンスを生成し処理を委譲することで代替可能である。
エンティティに関するユーティリティクラス。
Mapのエントリを設定する型。
許容する値を列挙型で指定するためのアノテーション。
許容値を列挙型でバリデーションする
ConstraintValidator
クラス。複数指定用のアノテーション
EnumElement
で許容する列挙型の値を実装するためのインタフェース。Iterator
に対するEnumeration
へのラッパーエラーメッセージを保持するクラス。
Deprecated.
標準のハンドラ構成では、本アノテーションを使用しても、DBトランザクションをロールバックすることができないため、
本アノテーションを使用しないこと。
ErrorOnSessionWriteConflict
インターセプタの処理内容を実装するリクエストハンドラ。JAX-RS用のエラーレスポンスを生成するクラス。
例外の種類に応じて以下のレスポンスを生成する。
エラー応答として送信する電文情報を含んだ実行時例外。
本クラスを送出することで、業務トランザクションはロールバックしつつ、
任意の内容の応答電文を送信することができる。
複数件のエラーメッセージを出力するクラス。
画面上部に一覧でエラーメッセージを表示する場合に使用する。
画面上部に一覧でエラーメッセージを表示する場合に使用する。
エラーメッセージを出力するクラス。
エラーの原因となった入力項目の近くにエラーメッセージを個別に表示する場合に使用する。
エラーの原因となった入力項目の近くにエラーメッセージを個別に表示する場合に使用する。
推定終了時間を求めるクラス。
エラー処理用のハンドラ。
与えられたMapに対する自動排他制御を実装するラッパークラス。
アクセサを使用した時点で排他ロックを自動的に取得する。
排他制御の実行に必要な情報を保持するクラス。
排他制御(悲観的ロック、楽観的ロック)を管理するインタフェース。
排他制御用テーブルのスキーマ情報とSQL文を保持するクラス。
排他制御機能のユーティリティクラス。
一連のハンドラ実行において、共通して読み書きするデータを保持するクラス。
実行制御ハンドラ内の処理状況に応じて呼び出される各種コールバックを定義する
インターフェース。
スレッドコンテキストに保持する実行時ID。
ExecutorService
を生成するためのファクトリインタフェース。期待するログメッセージを表すクラス。
ログが想定通り出力されることを確認する為に使用する。
ログが想定通り出力されることを確認する為に使用する。
有効期限付きのキャッシュ値を表すクラス。
有効期限付きキャッシュ。
有効期限付きキャッシュのリスナーインタフェース。
本インタフェースの各メソッドは、
ExpirableCache
実装クラスからコールバックされる。何の処理も行わないリスナー実装クラス。
特にコールバック処理が必要ない場合、本クラスを使用する。
有効期限付きキャッシュ(
ExpirableCache
)を実装するためのテンプレートクラス。
有効期限付きキャッシュの基本的な枠組みを提供する。
サブクラスにて、具体的な格納先(Map、KVS等)へのアクセス処理を実装する。セッションストアの有効期限を管理するインターフェース。
有効期限設定。
IDと有効期限の紐付けを行う。
符号なしおよび指数付き数値コンバータ。
符号付きおよび指数付き数値コンバータ。
EL式を表すクラス。
StringConvertor
にてString変換後、さらに追加で変換を行うコンバータが実装するインタフェース。拡張の型変換インタフェース。
外部化されたコンポーネント定義をロードするインタフェース。
障害通知ログと障害解析ログのメッセージをJSON形式でフォーマットするクラス。
連絡先を処理するクラス。
処理対象データを処理するクラス。
障害コードを処理するクラス。
メッセージを処理するクラス。
障害通知ログと障害解析ログのメッセージをフォーマットするクラス。
連絡先を取得するクラス。
処理対象データを取得するクラス。
障害コードを取得するクラス。
障害通知ログと障害解析ログの出力項目を保持するクラス。
メッセージを取得するクラス。
障害ログを出力するユーティリティクラス。
採番用のテーブルを使用して高速に採番を行うクラス。
採番用テーブルを使用して採番処理を行い、トランザクションのコミット処理を行う。
採番用テーブルを使用して採番処理を行い、トランザクションのコミット処理を行う。
レコードのフィールドであることを示すアノテーション。
フィールド情報とフィールドに設定されたアノテーション情報をロードするクラス。
本クラスは、初期化時の一括ロード、インデックスによるデータロードをサポートしない。 フィールドのアノテーション情報を都度取得する(キャッシュしなくなった)ため、データベース機能では本クラスは利用していない。
本クラスは、初期化時の一括ロード、インデックスによるデータロードをサポートしない。 フィールドのアノテーション情報を都度取得する(キャッシュしなくなった)ため、データベース機能では本クラスは利用していない。
フィールドのアノテーション情報を元に値を設定するクラスをサポートするクラス。
フィールド情報を保持するクラス。
このクラスでは、フィールドとフィールドに設定されたアノテーションの情報を保持する。
フィールドの定義をあらわすクラス。
値を変換することを示すアノテーション。
値を変換するインタフェース。
フォーマット定義ファイル内の、レコード内の各フィールドの定義情報を保持するクラス。
フォーマット定義ファイルのパース結果として生成される。
各フィールド定義に関連するコンバータは、パース後に
DataRecordFormatter
が本クラスに設定する。フィールド定義ユーティリティクラス。
フィールド定義に関する汎用的な処理を提供する。
フィールド定義に関する汎用的な処理を提供する。
ファイル入力バッチにおける業務処理のサポートクラス。
ファイル入力を行う業務処理が継承すべき抽象基底クラス。
ファイルデータを1レコードづつ読み込み、
読み込んだフィールドの内容を
DataRecord
にマッピングして返却するデータリーダ。ファイルにログを書き込むクラス。
FileLogWriterクラスの特徴を下記に示す。
ログフォーマッタを設定で指定できる。 設定されたクラスに従いログファイルのローテーションを行うことができる。 初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。 本クラスでは、ファイルへのログ書き込みに
出力バッファのサイズは設定で変更できる。
書き込み処理では、書き込み後にすぐにフラッシュし、書き込んだ内容をファイルに反映する。
プロパティファイルの記述ルールを下記に示す。
filePath 書き込み先のファイルパス。必須。 encoding 書き込み時に使用する文字エンコーディング。オプション。
指定しなければシステムプロパティ(file.encoding)から取得した文字エンコーディング。 outputBufferSize 出力バッファのサイズ。オプション。
単位はキロバイト。1000バイトを1キロバイトと換算する。1以上を指定する。指定しなければ8KB。 rotatePolicy ファイルローテーション実行クラスのFQCNを指定する。オプション。
デフォルトでは
利用するローテーション実行クラス毎に、追加でプロパティの設定が必要となる。 本クラスでは、初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。
FileLogWriterクラスの特徴を下記に示す。
ログフォーマッタを設定で指定できる。 設定されたクラスに従いログファイルのローテーションを行うことができる。 初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。 本クラスでは、ファイルへのログ書き込みに
BufferedOutputStream
を使用する。出力バッファのサイズは設定で変更できる。
書き込み処理では、書き込み後にすぐにフラッシュし、書き込んだ内容をファイルに反映する。
プロパティファイルの記述ルールを下記に示す。
filePath 書き込み先のファイルパス。必須。 encoding 書き込み時に使用する文字エンコーディング。オプション。
指定しなければシステムプロパティ(file.encoding)から取得した文字エンコーディング。 outputBufferSize 出力バッファのサイズ。オプション。
単位はキロバイト。1000バイトを1キロバイトと換算する。1以上を指定する。指定しなければ8KB。 rotatePolicy ファイルローテーション実行クラスのFQCNを指定する。オプション。
RotatePolicy
が実装されたクラスのFQCNを指定する。デフォルトでは
FileSizeRotatePolicy
が使用される。利用するローテーション実行クラス毎に、追加でプロパティの設定が必要となる。 本クラスでは、初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。
ファイル名を言語の切り替えに使用するクラス。
ベースパスの論理名と物理パスとの対応を管理するクラス。
ファイルからの読み込みを行うリーダ。
データレコードをファイルに出力するクラス。
Deprecated.
バージョン5以降では、新しいパッケージの
FileRecordWriterDisposeHandler
を使用すること。後続のハンドラの実行が終了した後に、
カレントスレッド上で管理されているファイルレコードライタ(
FileRecordWriter
)が保持するストリームのクローズ
およびDataRecordWriterのインスタンスを削除するクラス。
本ハンドラが自動的にストリームのクローズを行うので、
通常、業務アプリケーションでファイルレコードライタを扱う際に、ストリームをクローズする必要はない。FileRecordWriter
のインスタンスをスレッド毎に管理するクラス。File
オブジェクトからHTTPレスポンスを生成するHttpResponse
継承クラス。ファイルサイズによるログのローテーションを行うクラス。
設定したファイルの最大サイズを超える場合にローテーションを行う。 ファイルの最大サイズが指定されていない場合は、ローテーションしない。
設定したファイルの最大サイズを超える場合にローテーションを行う。 ファイルの最大サイズが指定されていない場合は、ローテーションしない。
テストで必要なファイル操作をサポートするクラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="file")を出力するクラス。
ファイルの取り扱いに関するユーティリティクラス。
ファイル関連ユーティリティクラス。
ファイル関連ユーティリティクラス。
ファイルユーティリティ。
未定義領域の文字埋めを行うコンバータ。
固定業務日付を提供するクラス。
固定業務日付は、
デフォルト区分は、
固定業務日付は、
FixedBusinessDateProvider.setFixedDate(java.util.Map)
で設定する。デフォルト区分は、
FixedBusinessDateProvider.setDefaultSegment(String)
で設定する。スレッドコンテキスト(
ThreadContext
)に固定の実行時IDを保持する。固定数のスレッドプールを使用する
ExecutorService
を生成するクラス。
デフォルトでは、利用可能なCPU数(Runtime.availableProcessors()
)を2倍した数のスレッドを使用する。固定長データにバインドするBeanであることを示すアノテーション。
固定長をBeanにマッピングする
ObjectMapper
固定長ファイルの読み書きを行う際に使用するコンバータのファクトリクラス。
固定長ファイルの読み書きを行う際に使用するコンバータの設定情報を保持するクラス。
データタイプのグローバル設定や、システム共通で使用するゾーン数値の符号ビットなどを、DIコンテナから設定できる。
固定長のフォーマットをあらわすクラス。
固定長のフォーマットを現す
FixedLengthDataBindConfig
を構築するクラス。FixedLength
アノテーションをFixedLengthDataBindConfig
に変換するクラス。フォーマット定義ファイルの内容に従い、固定長ファイルデータの読み書きを行うクラス。
固定長ファイルフォーマッタが使用するディレクティブの名前と値の型。
以下に一覧を示す。
positive-zone-sign-nibble:String negative-zone-sign-nibble:String positive-pack-sign-nibble:String negative-pack-sign-nibble:String fixed-sign-position:Boolean required-plus-sign:Boolean
positive-zone-sign-nibble:String negative-zone-sign-nibble:String positive-pack-sign-nibble:String negative-pack-sign-nibble:String fixed-sign-position:Boolean required-plus-sign:Boolean
固定長ファイルを表すクラス。
固定長ファイルの断片を表すクラス。
固定長ファイルのテストデータを解析するクラス。
固定長をMapにマッピングする
ObjectMapper
固定長データを読み取るクラス。
固定長データを出力するクラス。
固定文字列を取得するクラス。
固定日時を提供するクラス。
固定日時は
固定日時は
FixedSystemTimeProvider.setFixedDate(String)
で指定する。フォーカスを取得可能なタグの属性を出力するクラスの実装をサポートするクラス。
必要な権限が無いため、処理を継続することができない
ことを示す例外。
確認画面向けの表示内容を出力するクラス。
入力画面向けの表示内容を出力するクラス。
ログのフォーマットエラー出力を処理するインターフェース。
"データタイプ{パターン}"形式のフォーマット仕様を保持するクラス。
値をフォーマットするインターフェース
フォーマッタを保持するクラス。
データレコードフォーマッタ(
DataRecordFormatter
)を生成するファクトリクラス。オブジェクトのフォーマットに使用するユーティリティクラス。
フォームのコンテキスト情報を保持するクラス。
このコンテキスト情報はページコンテキストに格納する。
このコンテキスト情報はページコンテキストに格納する。
フォームを生成するインタフェース。
サブミット制御(ボタンとアクションの紐付け、二重サブミット防止)と不正画面遷移チェックを行うformタグを出力するクラス。
"application/x-www-form-urlencoded"に対するリクエスト/レスポンスの変換を行うクラス。
フォームに紐付けられたバリデーションの設定を保持するクラス。
フォームに紐付けられたバリデーションの設定をロードするクラス。
オンデマンドロードのみに対応する。
オンデマンドロードのみに対応する。
内部フォーワード処理を行うHTTPリクエストハンドラクラス。
X-Frame-Optionsレスポンスヘッダを設定するクラス。
FreeMarkerを使用する
TemplateEngineMailProcessor
の実装クラス。非定形メール送信要求を表すクラス。
電文中のフレームワーク制御ヘッダ部の内容をMapとして格納するクラス。
フレームワーク制御ヘッダ
本フレームワークが提供する機能の中には、電文中に特定の制御項目が定義されている
ことを前提として設計されているものが多く存在する。
そのような制御項目のことを「フレームワーク制御ヘッダ」とよぶ。
フレームワーク制御ヘッダの一覧とそれを使用するハンドラの対応は以下のとおり。
送受信電文中のフレームワーク制御ヘッダ項目に対する読み書きを行うモジュールが
実装するインターフェース。
具体的に電文中のどの部分をフレームワーク制御ヘッダの各項目に対応させるかについては、
各具象クラスごとに異なる。
受信電文のフレームワーク制御ヘッダの解析を行うデータリーダ。
XHTMLの共通属性を出力するクラスの実装をサポートするクラス。
汎用の
DbInfo
実装クラス。汎用のプログラム起動クラス。
本クラスはプログラム起動の共通的な枠組みのみを提供し、
個別の処理については
ProcessLifecycle
実装クラスに委譲される。Glob書式を
Pattern
オブジェクトに変換するユーティリティクラス。異例処理用例外ハンドラ。
Micrometerのグローバルレジストリ(
io.micrometer.core.instrument.Metrics.globalRegistry
)を
コンポーネントとして生成するファクトリクラス。グループ権限テーブルのスキーマ情報を保持するクラス。
メッセージ(同期送信)を解析するクラス。
BeanValidationのバリデーション順序を定義するインタフェース。
グループシステムアカウントテーブルのスキーマ情報を保持するクラス。
グループテーブルのスキーマ情報を保持するクラス。
H2用のSQL方言クラス。
データプロセッサが実装するパイプライン処理において、
各ステージで行われる処理が実装するインターフェース。
ハンドラリストの組み立てを行うインタフェース。
ハンドラリストの起動を行うインタフェース。
ハンドラリストを保護するクラス。
ハンドラリストの保護モード。
ハンドラで収集するメトリクスに設定するメタ情報を生成するビルダー。
ハンドラキューとその上の各ハンドラを管理する機能を実装した抽象クラス。
Handler
インターフェースを実装していない
一般のオブジェクトに対するラッパー。ヘルスチェックを行うエンドポイントとなるハンドラ。
DBやRedisなどの対象ごとのヘルスチェックは
HealthChecker
が行う。
ヘルスチェック結果からレスポンスの作成はHealthCheckResponseBuilder
が行う。ヘルスチェックを行うクラス。
ヘルスチェック結果からレスポンスを作成するビルダ。
ヘルスチェック結果を保持するクラス。
対象ごとのヘルスチェック結果
hiddenタグの暗号化機能で使用するユーティリティ。
HTMLのinputタグ(type="hidden")を格納先とする
SessionStore
拡張クラス。
5u13以前のHiddenStoreクラスに以下の追加変更を行っている。HiddenStoreのロードに失敗した場合に送出する例外。
HiddenStore
に設定された内容を保持する
inputタグ(type="hidden")を出力するクラス。入力データ復元とHTMLエスケープを行うinputタグ(type="hidden")を出力するクラス。
HotDeploy用のクラスローダ。
NablarchアプリケーションをHotDeployするためのハンドラ。
HTML4相当のチェックを行う HTMLチェックツール
HTMLの属性を表す列挙型。
カスタムタグで使用する属性のみ定義している。
カスタムタグで使用する属性のみ定義している。
HTMLの属性を保持するクラス。
HtmlAttribute
をキーにして属性の値を保持する。HTML チェックを行うクラスのインタフェース。
HTMLコメントを表すクラス。
HTMLチェックツール解析結果XMLをHTMLに変換する。
規約上許可されていないタグ/属性が、HTML内で使われていないかをチェックする。
規約上許可されていないタグ/属性情報を保存するクラス。
リクエスト単体テスト用HTML置換クラス
HTML構文チェックを行うユーティリティを呼び出す。
HTMLのタグを出力するクラスの実装をサポートするクラス。
HTMLタグの作成、編集に必要となる共通機能を提供するユーティリティ。
HTTPアクセスログのメッセージをフォーマットするクラス。
クライアント端末ホストを処理するクラス。
クライアント端末IPアドレスを処理するクラス。
HTTPヘッダのUser-Agentを処理するクラス。
コンテンツパスを処理するクラス。
ディスパッチ先クラスを処理するクラス。
終了日時を処理するクラス。
実行時間を処理するクラス。
空きメモリ量(開始時)を処理するクラス。
ラベルを処理するクラス。
最大メモリ量を処理するクラス。
HTTPメソッドを処理するクラス。
リクエストパラメータを処理するクラス。
ポート番号を処理するクラス。
クエリ文字列を処理するクラス。
リクエストIDを処理するクラス。
クライアントへのレスポンスに使用するステータスコードを処理するクラス。
セッションIDを処理するクラス。
セッションスコープ情報を処理するクラス。
セッションストアIDを処理するクラス。
開始日時を処理するクラス。
ステータスコードを処理するクラス。
URLを処理するクラス。
ユーザIDを処理するクラス。
HTTPアクセスログのメッセージをフォーマットするクラス。
クライアント端末ホストを取得するクラス。
クライアント端末IPアドレスを取得するクラス。
HTTPヘッダの User-Agent を取得する。
コンテンツパスを取得するクラス。
ディスパッチ先クラスを取得するクラス。
終了日時を取得するクラス。
実行時間を取得するクラス。
空きメモリ量(開始時)を取得するクラス。
HTTPアクセスログの出力項目を保持するクラス。
最大メモリ量を取得するクラス。
HTTPメソッドを取得するクラス。
リクエストパラメータを取得するクラス。
ポート番号を取得するクラス。
クエリ文字列を取得するクラス。
クエリ文字列があれば"?"を含めクエリ文字列を取得する。
リクエストIDを取得するクラス。
クライアントへのレスポンスに使用するステータスコードを取得するクラス。
セッションIDを取得するクラス。
セッションスコープ情報を取得するクラス。
セッションストアIDを取得するクラス。
開始日時を取得するクラス。
ステータスコードを取得するクラス。
URLを取得するクラス。
ユーザIDを取得する。
HTTPアクセスログを出力するクラス。
HTTPアクセスログを出力するクラス。
ロガー名は"HTTP_ACCESS"を使用し、INFOレベルで出力する。
ロガー名は"HTTP_ACCESS"を使用し、INFOレベルで出力する。
HTTP エンコーディング制御ハンドラ。
Httpクッキーのパーサー及びその内容を保持するデータオブジェクト。
共通エラーハンドラー。
エラーレスポンスを行う際に送出する例外。
エラー時遷移先画面のパス・ステータスコードなど、HttpResponseと同等の情報を指定することができる。 リクエストプロセッサがこのクラスを捕捉した場合、保持しているHttpResponseオブジェクトの内容にしたがって レスポンス処理が行われる。 注意: 透過的トランザクションハンドラ:nablarch.common.handler.TransactionManagementHandlerを適用している場合、 ユーザエラーをHttpResponseオブジェクトで返却してしまうとロールバックされない。 HttpErrorResponseを送出することで、ユーザエラーを返しつつ、 トランザクションをロールバックすることが可能となる。
エラー時遷移先画面のパス・ステータスコードなど、HttpResponseと同等の情報を指定することができる。 リクエストプロセッサがこのクラスを捕捉した場合、保持しているHttpResponseオブジェクトの内容にしたがって レスポンス処理が行われる。 注意: 透過的トランザクションハンドラ:nablarch.common.handler.TransactionManagementHandlerを適用している場合、 ユーザエラーをHttpResponseオブジェクトで返却してしまうとロールバックされない。 HttpErrorResponseを送出することで、ユーザエラーを返しつつ、 トランザクションをロールバックすることが可能となる。
画面処理における排他制御機能(楽観的ロック)のユーティリティクラス。
Streamを読み取り結果を返却させるためのIF
スレッドコンテキストに保持する言語属性をHTTPヘッダ(Accept-Language)から取得するクラス。
HTTP通信時に使用するメッセージID生成。
HTTPを利用したメッセージング機能の実装。
HTTPメッセージングサービスにおけるエラー制御を透過的に実装するハンドラー。
このハンドラーでは、後続の各ハンドラーで発生した実行時例外およびおよびエラーを捕捉し、
その内容に基づいてログ出力を行ったのち、HttpErrorResponseオブジェクトとしてリターンする。
HTTP通信に関する例外クラス。
HTTP通信時、送受信したデータのフォーマット変換に失敗した際に送出される例外クラス。
HTTPメッセージングデータ解析ハンドラ
HTTPメッセージングレスポンス電文構築ハンドラ
メッセージング機能で、コネクションの接続及びデータの読み込み要求がタイムアウトした場合に送出される例外。
HTTPメソッドベースディスパッチャ。
HttpMethodBindingのファクトリクラス
HTTPメソッドをもとにしてHTTPリクエストがCSRFトークンの検証対象となるか判定を行うクラス。
Streamに書き出しを行わせるためのIF
Http接続用クライアント。
Http接続用クライアントが実装すべきインターフェース。
HTTP通信において使用可能なHTTPメソッド。
HTTP/1.1(RFC2616)におけるリクエストメッセージのパーサ及び
その結果を格納するデータオブジェクト。
HTTPリクエストに対して何らかの処理を行うモジュールが実装するインターフェース。
このハンドラは、画面オンライン処理におけるリクエストパス中の部分文字列(ベースURI)を
Javaパッケージ階層にマッピングすることで、動的に委譲先ハンドラを決定するディスパッチ処理を行う。
本ハンドラの実装は基本的に
RequestPathJavaPackageMapping
のラッパーであり
その機能は以下の2点を除けば全く同じものである。ディスパッチャの実体。
note:
共通ハンドラを直接継承すると、HttpRequestHandlerを実装することが
できないので、内部クラスに委譲する形にしている。
HttpRequest
中のリクエストパスの書き換え処理を行うクラス。HttpRequestTestExtension
を適用するための合成アノテーション。HttpRequestTestSupport
を JUnit 5 で使用するための Extension 実装。HTTPリクエストテスト用の基底クラス。
HTTPリクエストのテスト時に先頭の設定するリクエストハンドラ。
本クラスでは、以下の処理を行う。 テストクラスから指定されたExecutionContextを、 handleメソッドの引数のExecutionContextへ移送する。 ExecutionContext#handleNext呼び出し後のExecutionContextの情報を テストクラスから指定されたExecutionContextへ移送する。 ハンドラキューの処理結果となるHttpResponseオブジェクトのステータスコードを アサートできるようにスタティック変数として保持しておく。
本クラスでは、以下の処理を行う。 テストクラスから指定されたExecutionContextを、 handleメソッドの引数のExecutionContextへ移送する。 ExecutionContext#handleNext呼び出し後のExecutionContextの情報を テストクラスから指定されたExecutionContextへ移送する。 ハンドラキューの処理結果となるHttpResponseオブジェクトのステータスコードを アサートできるようにスタティック変数として保持しておく。
HttpRequestTestSupport.execute(Class, String, HttpRequest, ExecutionContext)
から
nablarch.fw.web.HttpServer#handle(HttpRequest, ExecutionContext)が呼ばれるが、
ここで引数にExecutionContext
を渡しても使用されない。
(nablarch.fw.Handler#handle(Object, nablarch.fw.ExecutionContext)を実装する為、
引数として用意されているだけで、実際には使用しない)
実際には内蔵サーバ内で新たに生成されたExecutionContext
が使用される。
テストクラス側で生成したExecutionContext
の情報を使用してテストを行う為に、
本ハンドラにて移送を行う。HTTPリクエストの処理時間のメトリクスに設定するメタ情報を構築するビルダー。
サーブレットのHTTPリクエスト処理に関連するオブジェクト
(HttpServletRequest/HttpServletResponse/ServletContext)への参照を
集約するクラス。
HTTPレスポンスメッセージを生成する際に必要な情報を格納したクラス。
HTTPレスポンスステータス。
ServletAPIを通じてHTTPレスポンス処理を行うハンドラ。
HTTPレスポンスの設定情報を格納するクラス。
本クラスのプロパティを設定する場合はコンポーネント設定ファイルに本クラスの定義を行い、 個別のプロパティ設定を行うこと。
本クラスのプロパティを設定する場合はコンポーネント設定ファイルに本クラスの定義を行い、 個別のプロパティ設定を行うこと。
HTTP の応答時に使用するユーティリティ。
HTTPレスポンスコードの変換方法。
HTTP通信の結果を格納するためのクラス。
HTTPリクエスト中のリクエストパス、および、
HTTPレスポンス中のコンテンツパスに対する書き換え処理を行うハンドラ。
このハンドラでは、往路処理で
HttpRequest
中のリクエストパスの置換を行う。
もし、リクエストパスの置換が行われた場合は、
復路処理でHttpResponse
中のコンテンツパスの置換を行う。エンベディドHTTPサーバー&\u30b5\u30fc\u30d6\u30ec\u30c3\u30c8\u30b3\u30f3\u30c6\u30ca。
HttpServer
のファクトリインタフェース。
HttpServer
はJettyに依存しているが、Jettyバージョンによって対応するJavaが異なる。
Jettyのバージョン(6系、9系)を切り替えられるようにするためには、
nablarch-testingが直接Jettyに依存しないようにする必要がある。
このため本インタフェースを導入し、HttpServer
を抽象クラスとしている。
Jettyに直接依存するモジュールは、nablarch-testing-jetty6とnablarch-testing-jetty9となる。Jetty12対応の
HttpServer
を生成するファクトリ実装クラス。Jetty12対応の
HttpServer
サブクラス。HttpSessionを使用した
Expiration
実装クラス。セッションの内容をHttpSessionに格納/読み込みする
SessionStore
。HttpSessionを使った
TokenManager
実装クラス。SSL情報取得用クラス
HTTPリクエストテスト用の設定定義クラス。
国際化に使用するユーティリティクラス。
採番したIDをフォーマットするインタフェース。
IDを採番するインタフェース。
JSPの画面状態が確認画面である場合に、部分的に確認画面の画面状態を無効化するクラス。
プロパティに対する値の設定を無視することを示すアノテーション。
改行コードの種類を無視するorg.hamcrest.Matcher実装クラス。
改行コードの種類を無視して、実際の値が期待値を含むことを
表明するMatcherクラス。
改行の種類以外が等しいことを表明するMatcherクラス。
設定不備を表す例外クラス。
Entityの定義が誤っている場合に発生させる例外クラス。
間違った呼び出しに対する例外クラス。
コンテキストパスの付加とURLリライトに対応するimgタグを出力するクラス。
コンポーネントのインポート設定に使用する型。
前処理実行可能なハンドラであるマーカインタフェース。
インクルードのコンテキスト情報を保持するクラス。
このコンテキスト情報はページコンテキストに格納する。
このコンテキスト情報はページコンテキストに格納する。
インクルード時に追加するパラメータを指定するクラス。
インクルード先のパスを言語対応のパスに変換してからインクルードを行うクラス。
初期化処理を行うインタフェース。
初期化処理を必要とするクラスは本インタフェースを実装すること。
初期化処理を必要とするクラスは本インタフェースを実装すること。
フォームをリクエストスコープに設定する
Interceptor
。InjectForm
アノテーションのインターセプタ。インジェクションの種類を表す列挙型。
キャッシュをメモリ上に保持する
ExpirableCache
実装クラス。メモリ上にキャッシュを保持する結果セットキャッシュ実装クラス。
inputタグの共通属性を出力するクラスの実装をサポートするクラス。
個別の登録ロジックを記述するためのインタフェース。
Integer
型への変換を行う Converter
。値をIntegerに変換するクラス。
本クラスで変換するプロパティには、必ずDigitsアノテーションを付与しておく必要がある。
本クラスでは、Digitsアノテーションの属性を下記の通り使用する。
Digitsアノテーションの属性名説明
integer整数部桁数上限値。10以上の数値を指定できない。
fraction小数部桁数上限値。0のみ指定可能。
commaSeparatedtrueの場合、入力値が3桁区切り文字で編集されていてもよい。(区切り文字は省略可。)
falseの場合、入力値が3桁区切り文字で編集されていてはいけない。
messageId変換失敗時のメッセージID。
IntegrationTestExtension
を適用するための合成アノテーション。IntegrationTestSupport
を JUnit 5 で使用するための Extension 実装。結合テストサポートクラス。
Handler.handle(Object, ExecutionContext)
メソッドに対するインターセプタに付与する
メタアノテーション。Interceptor
アノテーションによるHandler.handle(Object, ExecutionContext)
へのインターセプトを実現するスタティックメソッドを保持するクラス。Interceptor
の処理内容を実装するクラスの抽象基底クラスとなるリクエストハンドラ。ハンドラの内部処理で発生した問題により、処理が継続できないことを
示す例外。
内部リクエストIDを保持するスレッドコンテキスト属性。
内部利用のためのセッションユーティリティ。
解釈コンテキストクラス。
以下の要素を保持する。 解釈対象となる値 解釈クラス(
以下の要素を保持する。 解釈対象となる値 解釈クラス(
TestDataInterpreter
)を格納したキュー
具体的な使用方法は、TestDataInterpreter
を参照。外部システムに対する送受信電文の内容を格納するデータオブジェクト。
このオブジェクトは以下のデータを保持する。
プロトコルヘッダー
メッセージボディ
フレームワークで使用する既定ヘッダーのフィールド名
不正な文字が含まれていた場合に発生する例外。
データのフォーマット不正により解析に失敗した場合に送出される例外クラス。
入力データおよび出力データの不正により処理が継続できないことを示す例外クラス。
HTMLファイルチェック中に何らかの例外が生じたことを示す例外.
項目名付きのメッセージ変換を行うクラスを生成するファクトリクラス。
ItemWriteListener
レベルでトランザクション制御を行うNablarchItemWriteListener
の実装クラス。Jackson2.xを使用してリクエスト/レスポンスの変換を行う
BodyConverter
実装クラス。Jacksonを使用してbodyを変換するための
RestTestBodyConverter
実装クラス。ObjectMapper
のfactoryインターフェイスJackson用の
BodyConverter
の実装をサポートするクラス。Deprecated.
設定ファイルベースの
CharsetDef
を使用すること。Deprecated.
JapaneseCharacterSet
とともに非推奨。MessageFormat
を使用してメッセージのフォーマットを行うクラス。リクエストパスのパターン文字列とマッピング先Javaパッケージの関連を保持するクラス。
Java標準のSerialize機構、暗号化を使用した
StateEncoder
実装クラス。Java標準のSerialize機構を使用した
StateEncoder
実装クラス。Date and Time APIの日時を扱うクラスをシリアライズするための抽象クラス。
JAXBを使用してリクエスト/レスポンスの変換を行う
BodyConverter
実装クラス。JAXBを使用した
StateEncoder
実装クラス。RESTfulウェブサービスのアクセスログのメッセージをフォーマットするクラス。
クライアント端末ホストを処理するクラス。
クライアント端末IPアドレスを処理するクラス。
HTTPヘッダのUser-Agentを処理するクラス。
終了日時を処理するクラス。
実行時間を処理するクラス。
空きメモリ量(開始時)を処理するクラス。
ラベルを処理するクラス。
最大メモリ量を処理するクラス。
HTTPメソッドを処理するクラス。
リクエストパラメータを処理するクラス。
ポート番号を処理するクラス。
クエリ文字列を処理するクラス。
リクエストのボディを処理する。
リクエストIDを処理するクラス。
レスポンスのボディを処理する。
セッションIDを処理するクラス。
セッションスコープ情報を処理するクラス。
セッションストアIDを処理するクラス。
開始日時を処理するクラス。
ステータスコードを処理するクラス。
URLを処理するクラス。
ユーザIDを処理するクラス。
RESTfulウェブサービスのアクセスログのメッセージをフォーマットするクラス。
クライアント端末ホストを取得するクラス。
クライアント端末IPアドレスを取得するクラス。
HTTPヘッダの User-Agent を取得する。
終了日時を取得するクラス。
実行時間を取得するクラス。
空きメモリ量(開始時)を取得するクラス。
最大メモリ量を取得するクラス。
HTTPメソッドを取得するクラス。
リクエストパラメータを取得するクラス。
ポート番号を取得するクラス。
クエリ文字列を取得するクラス。
リクエストのボディを取得する。
リクエストIDを取得するクラス。
レスポンスのボディを取得する。
セッションIDを取得するクラス。
セッションスコープ情報を取得するクラス。
セッションストアIDを取得するクラス。
開始日時を取得するクラス。
ステータスコードを取得するクラス。
URLを取得するクラス。
ユーザIDを取得する。
RESTfulウェブサービスのアクセスログを出力するハンドラ。
RESTfulウェブサービスのアクセスログのJSON形式による出力に対応した
JsonSerializationManager
の実装クラス。リソースメソッドが受け取るBeanオブジェクトに対してバリデーションを実行するハンドラ実装クラス。
JAX-RSのメッセージボディがログ出力対象であるか判定するクラス。
ログ出力するJAX-RSのボディ文字列をマスク処理するフィルタ。
JAX-RSのリソースクラスとしてActionハンドラを呼び出すのに必要な情報を保持するクラス。
JAX-RSのエラー情報をログに出力するクラス。
JAX-RSで実行される
Handler
のリストを生成するインタフェース。JAX-RS用の
HttpRequest
クラス。JAX-RS用の
MethodBinder
実装クラス。リソースメソッドを表すクラス。
JAX-RS用の
MethodBinder
を生成する。Path
アノテーションが設定されたクラスを探索してルーティング定義を収集するクラス。Path
に設定されたパス文字列を解析して、 PathRequirements
に変換するクラス。探索結果の JAX-RS のリソースクラスと、HTTPをマッピングしたメソッドの情報を格納したクラス。
JAX-RS のリソースクラスと、そこに定義されたHTTPメソッドをマッピングしたメソッド定義を検索するクラス。
JAX-RS用のレスポンスを返却するハンドラ。
JAX-RSのリソースクラスの情報を解析し、ルーティング定義に変換するクラス。
バッチ処理を識別する名前を持つクラス。
jboss-loggingを使用してログ出力を行うクラス。
JbossLogger
を生成するクラス。データベースに対してJDBCレベルでトランザクション制御を行うクラス。
JdbcTransaction
を生成するクラス。JDBC経由でデータベースアクセスをした際にトランザクションタイムアウトを実現するクラス。
Jerseyを使用する
JaxRsHandlerListFactory
の実装クラス。JMSプロバイダを利用したメッセージング機能の実装。
各JMSプロバイダが実装するConnectionFactoryおよびQueueオブジェクトを設定
することにより、メッセージング機能が利用可能となる。
メッセージングコンテキストのJMSベース実装
JMSヘッダー名称
指定したMBeanから定期的に値を取得し
Gauge
として記録するMeterBinder
の実装クラス。JNDIルックアップを行う際のヘルパークラス。
ConnectionFactory
およびQueue
をJNDIから取得する
MessagingProvider
実装クラス。リソースの取得をJNDIから行う以外は、
JmsMessagingProvider
と同様。
設定例をいかに示す。JOB の実行をするクラス
JOBの進捗ログを出力するリスナークラス。
JOB開始時と終了時にログを出力し、終了時にはステータスも併せて出力する。
JOB開始時と終了時にログを出力し、終了時にはステータスも併せて出力する。
JSONにおける真偽値を表現するマーカークラス。
コミットログ出力のJson版実装クラス。
JSONビルダー。
この実装では独自実装によりJSONデータの解析を行います。
この実装では独自実装によりJSONデータの解析を行います。
JSONデータコンバータのファクトリクラス。
JSONデータの読み書きを行う際に使用するコンバータの設定情報を保持するクラス。
コンバータ名とコンバータ実装クラスの対応表 や、タイトルのレコードタイプ名などを、DIコンテナから設定できる。
JSONパーサー。
この実装では
この実装では
JsonParser
を使用してJSONデータの解析を行います。フォーマット定義ファイルの内容に従い、JSONデータの読み書きを行うクラス。
起動プロセスを処理するクラス。
出力日時を処理するクラス。
実行時IDを処理するクラス。
ロガー名を処理するクラス。
ログレベルを処理するクラス。
メッセージを処理するクラス。
オプション情報に指定されたオブジェクトを処理するクラス。
処理方式を処理するクラス。
リクエストIDを処理するクラス。
実行時ロガー名を処理するクラス。
エラー情報に指定された例外オブジェクトのスタックトレースを処理するクラス。
ユーザIDを処理するクラス。
各種ログのJSONフォーマットを支援するクラスです。
構造化ログのオブジェクトを構築するインターフェース。
JSONにおける数値型を表現するマーカークラス。
JSONにおけるオブジェクト型を表現するマーカークラス。
JSON解析用ユーティリティ
トークン種別
JsonSerializer
を管理、提供するインターフェース。シリアライザの初期化に使用する設定クラス。
オブジェクトをJsonにシリアライズするインターフェース。
受入れ可能なオブジェクトを特定したクラスを実装する。
受入れ可能なオブジェクトを特定したクラスを実装する。
JSONにおける文字列型を表現するマーカークラス。
JSON文字列をシリアライズするクラス。
JSON文字列を表現するクラス。
JSPのコアタグを表すクラス。
コアタグの種類を表す列挙型。
JSPファイルを解析する。
BasicConversionManager
と同様のクラス携帯端末からのアクセスに対して、以下の処理を行うハンドラ。
hiddenタグの暗号化機能で、キーコンテキストが取得できなかった場合に発生する例外。
この例外が発生するのは、改竄以外にセッション有効期限切れのケースが考えられる。
この例外が発生するのは、改竄以外にセッション有効期限切れのケースが考えられる。
スレッドコンテキストに保持する言語属性。
クッキーを使用して言語の保持を行うクラス。
クッキーのhttpOnly属性はアプリケーションで使用しているServlet APIがサポートしている場合のみ設定する。
HTTPセッションを使用して言語の保持を行うクラス。
HTTP上で言語の保持を行うクラスの実装をサポートするクラス。
HTTP上で選択された言語の保持を行う際に使用するユーティリティクラス。
起動ログのメッセージをJSON形式でフォーマットするクラス。
出力項目(コマンドライン引数)を処理するクラス。
出力項目(コマンドラインオプション)を処理するクラス。
出力項目(処理時間)を処理するクラス。
出力項目(終了コード)を処理するクラス。
出力項目(ラベル)を処理するクラス。
Main
で出力するログメッセージをフォーマットするクラス。コマンドライン引数を取得する。
コマンドラインオプションを取得する。
実行時間を取得する。
終了コードを取得する。
バッチ実行ログコンテキスト
Main
でのログ出力をサポートするユーティリティクラス。シングルレイアウトやマルチレイアウト用の設定を構築するクラスのサポートクラス。
フィールドのオフセットを基準に比較を行うクラス。
フォーマット定義ファイル全体の定義情報を保持するクラス。
フォーマット定義ファイルのパース結果が本クラスとなる。
フォーマット定義ファイルのLL(1)パーサ。
フォーマット定義ファイルの構文定義上の終端要素(トークン)。
フォーマット定義ファイルの字句要素解析器
フォーマット定義ファイルの終端要素(トークン)の種別
HttpSession.invalidate()
の呼び出しを遅延させるFilter
実装クラス。
HttpRequestTestSupportHandler
では、
テストクラスとJetty上で実行されるテスト対象間でのExecutionContext
のコピーを行っている。
テスト実行中にセッションがinvalidateされた場合、Jetty 12ではExecutionContext
の
書き戻し時にIllegalStateException
がスローされてしまう。
これを回避するためには、HttpSession.invalidate()
が実行されるタイミングを遅らせる必要がある。
サーブレットフィルタ(本クラス)を差し込んで、ここでHttpServletRequest
をラップする。
ラップしたHttpServletRequest
は、セッションを要求されると、やはりラップしたHttpSession
を返却する。
このラップしたHttpSession
ではHttpSession.invalidate()
が呼び出されても、実際にはinvalidateをせず、
invalidateが要求されたことを記録しておく。
後続のすべての処理が終わった後、invalidateが要求された場合、実際にinvalidateを実行する。
Jetty 9 ではラップに標準APIの Proxy を用いていたが、 Jetty 12 では単純なラップクラスを使用している。
これは、 Jetty 12 が内部で instanceof
を使ってServletRequestWrapper
かどうか
判定している部分があり、 Proxy を用いているとその判定条件に入れないという理由があるためである。指定された範囲内の文字列長であることを表すアノテーション。
入力値がnull又は空文字の場合は、validと判定する。 エラー時のメッセージは、以下のルールにより決定される。
入力値がnull又は空文字の場合は、validと判定する。 エラー時のメッセージは、以下のルールにより決定される。
Length.message()
が指定されている場合は、その値を使用する。
Length.message()
が未指定でLength.min()
のみ指定の場合は、{nablarch.core.validation.ee.Length.min.message}
Length.message()
が未指定でLength.max()
のみ指定の場合は、{nablarch.core.validation.ee.Length.max.message}
Length.message()
が未指定でLength.max()
とLength.min()
に指定した値が同じ場合は、{nablarch.core.validation.ee.Length.fixed.message}
Length.message()
が未指定でLength.min()
とLength.max()
に指定した値が異なる場合は、{nablarch.core.validation.ee.Length.min.max.message}
文字列長の計算はサロゲートペアを考慮して行われる。指定された範囲内の文字列長であることを表すアノテーション。
入力値がnull又は空文字の場合は、validと判定する。 文字列長の計算はサロゲートペアを考慮して行われる。
入力値がnull又は空文字の場合は、validと判定する。 文字列長の計算はサロゲートペアを考慮して行われる。
文字列長のバリデーションを行う
ConstraintValidator
実装クラス。複数指定用のアノテーション
文字列長をチェックするクラス。
文字列長の計算はサロゲートペアを考慮して行われる。
文字列長の計算はサロゲートペアを考慮して行われる。
Cluster 構成の Redis に接続するための
LettuceRedisClient
実装クラス。Master/Replica 構成の Redis に接続するための
LettuceRedisClient
実装。セッションストアの実装に必要となる Redis コマンドを定義したインターフェース。
LettuceRedisClient
のインスタンスを提供するクラス。Redis にセッションの有効期限を保存するためのクラス。
Lettuce を使って Redis のセッションストアを実装したクラス。
単一の Redis インスタンスに直接接続するためのシンプルな
LettuceRedisClient
実装クラス。ファイル行数取得対象であることを示すアノテーション。
改行コードを列挙するクラス。
改行コードを解釈するクラス。
本クラスは、Excelのセル内に改行コードCRを記入できない問題に対処する。
Excelセル内の改行コードはLF(0x0A)である。
そのため、テストデータでCR(0x0D)やCRLF(0x0D0A)を表すことができない。
この問題に対処するため、任意の文字列を改行コードに置き換える処理を行う。
例えば、以下の様に記述した場合、
例えば、以下の様に記述した場合、
コンテキストパスの付加とURLリライトに対応するlinkタグを出力するクラス。
Listをコンポーネントとして設定する際に使用する型。
入力データ復元とHTMLエスケープを行う選択項目(inputタグ(type="checkbox"))を出力するクラス。
複数のchecked属性を持つinputタグを出力するクラスの実装をサポートするクラス。
Listの定義からコンポーネントを生成するクラス。
Listは初期化時にならないと対象のオブジェクトを発見できないため、 ComponentCreatorとComponentInjectorの2つのインタフェースを実装する。
Listは初期化時にならないと対象のオブジェクトを発見できないため、 ComponentCreatorとComponentInjectorの2つのインタフェースを実装する。
Listが保持するエントリーの定義を保持するクラス。
List
及びその具象サブクラスに型変換するクラス。リスト表示に使用するフォーマットを表す列挙型。
入力データ復元とHTMLエスケープを行う選択項目(inputタグ(type="radio"))を出力するクラス。
一覧検索用の情報を保持する基底クラス。
入力データ復元とHTMLエスケープを行う選択項目(selectタグ)を出力するクラス。
リストの選択項目を出力するタグの実装をサポートするクラス。
Listオブジェクトをシリアライズするクラス。
受入れ可能なオブジェクトの型は java.util.List。
シリアライズによりJsonのarrayとして出力する。
受入れ可能なオブジェクトの型は java.util.List。
シリアライズによりJsonのarrayとして出力する。
各種操作の条件を表すクラス。
リテラル文字列による許容文字集合定義クラス。
定義したい文字集合の要素が、Unicodeコードポイント上に散在する場合、 範囲指定による集合定義は煩雑になるおそれがある。 そのような場合には、本クラスを利用することで簡便に文字集合を定義できる。
定義したい文字集合の要素が、Unicodeコードポイント上に散在する場合、 範囲指定による集合定義は煩雑になるおそれがある。 そのような場合には、本クラスを利用することで簡便に文字集合を定義できる。
リテラル表現からオブジェクトを作成するクラス。
リテラル表現を解決するユーティリティクラス。
java.time.LocalDate
型への変換を行う Converter
。java.time.LocalDateTime
型への変換を行う Converter
。Java8以降のjava.time.LocalDateTimeをシリアライズするクラス。
受入れ可能なオブジェクトの型は java.time.LocalDateTime。
シリアライズによりJsonのstringとして出力する。
受入れ可能なオブジェクトの型は java.time.LocalDateTime。
シリアライズによりJsonのstringとして出力する。
排他ロックを内蔵したMapのラッパークラス。
ログに出力する文字列をマスク処理するためのフィルタ。
ログ出力に必要な情報を保持するクラス。
スレッド名、ユーザID、リクエストIDは、スレッドに紐付く値をクラスの内部で設定する。
スレッド名、ユーザID、リクエストIDは、スレッドに紐付く値をクラスの内部で設定する。
ログレベルごとのログ出力回数をメトリクスとして収集する
MeterBinder
。ログのフォーマットを行うインタフェース。
ログのフォーマットの種類毎に本インタフェースの実装クラスを作成する。
ログのフォーマットの種類毎に本インタフェースの実装クラスを作成する。
ログを出力するインタフェース。
ログ出力機能の実装毎に本インタフェースの実装クラスを作成する。
ログ出力機能の実装毎に本インタフェースの実装クラスを作成する。
Logger
を生成するインタフェース。ログ出力機能の実装毎に本インタフェースの実装クラスを作成する。
LoggerFactoryは、
LoggerManager
により生成、管理される。LoggerManager
は、初期処理においてLoggerFactoryの生成後にLoggerFactory.initialize(LogSettings)
メソッド、
終了処理においてLoggerFactoryを破棄する際にLoggerFactory.terminate()
メソッドをそれぞれ1度だけ呼び出すので、
LoggerFactoryの初期処理と終了処理は複数スレッドから呼ばれることはない。ログ出力機能の全体を取りまとめるクラス。
クラスローダ毎に設定で指定された
ログ出力機能の実装に依存する初期処理、終了処理、
クラスローダ毎に
クラスローダ毎に設定で指定された
LoggerFactory
の生成、保持を行う。ログ出力機能の実装に依存する初期処理、終了処理、
Logger
の生成はLoggerFactory
に委譲する。クラスローダ毎に
LoggerFactory
を保持するのは、クラスローダ階層により生じる問題に対応するためである。LoggingMeterRegistry
のファクトリ。ログ初期化処理を助けるクラス。
依存関係にないために静的に初期化処理を呼び出せない
ログユーティリティクラスに対して初期化処理を起動する。
ログの初期化を行うクラス。
ログの出力項目を取得するインタフェース。
ログレベルを表す列挙型。
本フレームワークにおけるログレベルは、FATAL>ERROR>WARN>INFO>DEBUG>TRACEの6段階とし、FATALからTRACEに向かって順にレベルが低くなる。
レベルに応じた出力制御では、指定されたレベル以上のログを全て出力する。
例えば、WARNレベルが指定された場合は、FATALレベル,ERRORレベル,WARNレベルで出力を指示しているログのみ出力する。
ログレベルの定義を下記に示す。
下記を参考にプロジェクト毎にログレベルの使用方法を決定すること。 FATAL アプリケーションの継続が不可能になる深刻な問題が発生したことを示す。
監視が必須で即通報および即対応が必要となる。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 ERROR アプリケーションの継続に支障をきたす問題が発生したことを示す。
監視が必須であるが、通報および対応にFATALレベルほどの緊急性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 WARN すぐには影響を与えないが、放置しておくとアプリケーションの継続に支障をきたす問題になる恐れがある事象が発生したことを示す。
できれば監視した方がよいが、ERRORレベルほどの重要性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 INFO 本番運用時にアプリケーションの情報を出力するログレベル。
アクセスログや統計ログが該当する。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。
ログファイルのサイズが肥大化しないよう出力内容を設計する。 DEBUG 開発時にデバッグ情報を出力するログレベル。
SQLログや性能ログが該当する。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 TRACE 開発時にデバッグ情報より、さらに細かい情報を出力したい場合に使用するログレベル。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。
本フレームワークにおけるログレベルは、FATAL>ERROR>WARN>INFO>DEBUG>TRACEの6段階とし、FATALからTRACEに向かって順にレベルが低くなる。
レベルに応じた出力制御では、指定されたレベル以上のログを全て出力する。
例えば、WARNレベルが指定された場合は、FATALレベル,ERRORレベル,WARNレベルで出力を指示しているログのみ出力する。
ログレベルの定義を下記に示す。
下記を参考にプロジェクト毎にログレベルの使用方法を決定すること。 FATAL アプリケーションの継続が不可能になる深刻な問題が発生したことを示す。
監視が必須で即通報および即対応が必要となる。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 ERROR アプリケーションの継続に支障をきたす問題が発生したことを示す。
監視が必須であるが、通報および対応にFATALレベルほどの緊急性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 WARN すぐには影響を与えないが、放置しておくとアプリケーションの継続に支障をきたす問題になる恐れがある事象が発生したことを示す。
できれば監視した方がよいが、ERRORレベルほどの重要性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 INFO 本番運用時にアプリケーションの情報を出力するログレベル。
アクセスログや統計ログが該当する。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。
ログファイルのサイズが肥大化しないよう出力内容を設計する。 DEBUG 開発時にデバッグ情報を出力するログレベル。
SQLログや性能ログが該当する。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 TRACE 開発時にデバッグ情報より、さらに細かい情報を出力したい場合に使用するログレベル。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。
LogPublisher
によって公開されたLogContext
を受け取るインタフェース。書き出されたログを、登録された
LogListener
に公開するLogWriter
の実装クラス。ログ出力機能の設定をロードして保持するクラス。
ログ出力の実装を助けるユーティリティ。
マップの値を編集するインタフェースの基本実装クラス。
マップの値を編集するインタフェース。
マップをダンプする処理(
マップをダンプする処理(
LogUtil.dumpMap(Map, String, MapValueEditor)
)で使用する。マップの値をマスキングするクラス。
クラスローダに紐付くオブジェクトを生成するインタフェース。
ログ出力結果を検証するためのログ出力クラス。
ログを出力先に書き込むインタフェース。
出力先の媒体毎に本インタフェースの実装クラスを作成する。
出力先の媒体毎に本インタフェースの実装クラスを作成する。
LogWriter
の実装をサポートするクラス。このクラスでは、下記の機能を提供する。
LogLevel
に応じた出力制御
LogFormatter
を使用したログのフォーマット
上記の機能は、プロパティファイルに設定を記述して使用する。プロパティファイルの記述ルールを下記に示す。 writer.<
LogWriter
の名称>.level
LogLevel
の名称。オプション。LogLevel
の名称を指定する。ここで指定したレベル以上のログを全て出力する。 指定がない場合はレベルに応じた出力制御を行わず、全てのレベルのログを出力する。 writer.<
LogWriter
の名称>.formatter.className
LogWriter
で使用するLogFormatter
のクラス名。LogFormatter
を実装したクラスのFQCNを指定する。
指定がない場合はBasicLogFormatter
を使用する。
writer.<LogWriter
の名称>.formatter.<プロパティ名>
LogFormatter
毎のプロパティに設定する値。設定内容は、使用する
LogFormatter
のJavadocを参照すること。
Long
型への変換を行う Converter
。値をLongに変換するクラス。
本クラスで変換するプロパティには、必ずDigitsアノテーションを付与しておく必要がある。 本クラスでは、Digitsアノテーションの属性を下記の通り使用する。 Digitsアノテーションの属性名説明 integer整数部桁数上限値。18以上の数値を指定できない。 fraction小数部桁数上限値。0のみ指定可能。 commaSeparatedtrueの場合、入力値が3桁区切り文字で編集されていてもよい。(区切り文字は省略可。) falseの場合、入力値が3桁区切り文字で編集されていてはいけない。 messageId変換失敗時のメッセージID。 本クラスが行うバリデーションの仕様は
本クラスで変換するプロパティには、必ずDigitsアノテーションを付与しておく必要がある。 本クラスでは、Digitsアノテーションの属性を下記の通り使用する。 Digitsアノテーションの属性名説明 integer整数部桁数上限値。18以上の数値を指定できない。 fraction小数部桁数上限値。0のみ指定可能。 commaSeparatedtrueの場合、入力値が3桁区切り文字で編集されていてもよい。(区切り文字は省略可。) falseの場合、入力値が3桁区切り文字で編集されていてはいけない。 messageId変換失敗時のメッセージID。 本クラスが行うバリデーションの仕様は
IntegerConvertor
と同様である。ループ制御ハンドラークラス。
値の先頭に指定の文字を付加(読み込み時は除去)することを示す。
値の変換を行う。
桁数をフォーマットするクラス。
コンストラクタで指定された桁数になるように、指定された文字を先頭に付加する。
コンストラクタで指定された桁数になるように、指定された文字を先頭に付加する。
LRUアルゴリズムを持つ
Map
実装クラス。
指定された最大容量を超過する場合、
最も参照されない期間が長いエントリが削除される。LRUアルゴリズムにより、エントリが削除された場合に呼び出されるコールバックインタフェース。
何も実行しないリスナー実装クラス。
添付ファイル管理テーブルのスキーマ情報を保持するデータオブジェクト。
添付ファイル管理の1レコード分の情報を保持するクラス。
出力ライブラリ(メール送信)のコード値を保持するデータオブジェクト。
メール送信要求を表す抽象クラス。
メール送信先管理テーブルのスキーマ情報を保持するデータオブジェクト。
メール送信先の1レコード分の情報を保持するクラス。
メールのデフォルト設定を保持するデータオブジェクト。
メール送信要求を行うクラス。
メール送信要求管理テーブルのスキーマを保持するデータオブジェクト。
メール送信要求の1レコード分の情報を保持するクラス。
メール送信要求管理テーブル上の各レコードごとにメール送信を行うバッチアクション。
メール送信用設定値を保持するデータオブジェクト。
メールテンプレート管理テーブルのスキーマ情報を保持するデータオブジェクト。
メールテンプレートの1レコード分の情報を保持するクラス。
メール送信ライブラリ関連のユーティリティ。
バッチアプリケーションのメインクラス
本フレームワークの起動シーケンスの起点となるクラス。
リクエスト単体テスト用のメインクラス。
Mapをコンポーネントとして設定する際に使用する型。
マップの置き換えを簡易的に行うクラス。
Mapの定義からコンポーネントを生成するクラス。
Mapは初期化時にならないと参照するオブジェクトを発見できないため、
ComponentCreatorとComponentInjector2つのインタフェースを実装する。
Mapを引数に取るコンストラクタを使用してフォームを生成するクラス。
このストラテジを選択することで、リフクレクションを用いる場合と比較して高速なフォームの生成が行える。
このストラテジを選択することで、リフクレクションを用いる場合と比較して高速なフォームの生成が行える。
MapをCSVにマッピングするのをサポートするクラス。
Mapが保持するエントリーの定義を保持するクラス。
Entryのkeyおよびvalueのデータ定義を表す列挙型。
Mapを固定長にマッピングする
ObjectMapper
Mapオブジェクトをシリアライズするクラス。
マップユーティリティ
Map
を実装するクラスの、ラッパークラスを作成するための抽象クラス。マスキング済みのマップを取得する
LogItem
の実装をサポートするクラス。マスタデータ復旧クラス。
発行されたSQL文を監視するSqlLogFormatterサブクラス
マスタデータ投入クラス。
JMXで取得するMBeanのAttributeを特定するための、オブジェクト名と属性名を保持したデータクラス。
異なる2つの
Converter
}インスタンスをマージ可能であることを表すインターフェース。メッセージに必要な情報を保持し、メッセージのフォーマットを行うクラス。
メッセージボディがログ出力対象であるか判定するためのインタフェース。
Message
同士の比較をメッセージ本文で実行するためのクラス。Message
同士の比較をメッセージIDで実行するためのクラス。メッセージをフォーマットするインタフェース。
メッセージの通知レベルを表す列挙型。
メッセージが存在しなかった場合に発生する例外。
メッセージを解析するクラス。
テストショット毎のメッセージを保持するクラス。
指定されたメッセージキューを監視し、受信した電文オブジェクトを返すデータリーダ。
メッセージデータリーダによる受信電文の読み込み処理の最中にエラーが発生した場合に
送出される例外。
受信電文に設定された宛先に対して応答電文を送信するハンドラ。
本ハンドラは、後続ハンドラの処理結果であるResponseMessageオブジェクトの内容を
もとに応答電文を構築し送信する。
送信した応答電文オブジェクトをこのハンドラの戻り値として返す。
他のハンドラとの前後関係
応答電文の再送処理制御を行うハンドラ。
対外システムに対するメッセージの同期送信を行うユーティリティクラス。
MessageSender
から呼び出される通信機能の基本APIの実装系を提供するモジュールが実装するインターフェース。MessageSender
の設定情報を保持するクラス。設定値のタイプを表す列挙型。
送信した電文に対する応答電文をタイムアウト時間内に受信することができなかった場合に
送出される例外。
メッセージを出力するクラス。
アプリケーションがメッセージを取得する際に使用するユーティリティクラス。
Deprecated.
バージョン5以降では、新しいパッケージの
MessagingAction
を使用すること。被仕向同期応答処理を行う業務処理で使用するテンプレートクラス。
メッセージングサーバとの間に開かれるセッションに対するラッパー。
このクラスのインスタンスはスレッドローカル変数上で管理されており、
MessagingContext.getInstance()
を用いてインスタンスを獲得する。
本クラスでは、以下の機能を提供する。
メッセージ送信
メッセージ同期送信
メッセージ受信
メッセージコンテキストの初期化、スレッドコンテキストへの登録、および終端処理の実行
行うハンドラクラス。
メッセージ処理において問題が発生した場合に送出される実行時例外。
発生した例外の内容に応じた
MessagingException
を生成するインタフェース。メッセージ送受信処理の中で出力するためのログをJSON形式でフォーマットするクラス。
出力項目(関連メッセージID)を処理するクラス。
出力項目(宛先キュー名)を処理するクラス。
ラベルを処理するクラス。
出力項目(メッセージボディ内容)を処理するクラス。
出力項目(メッセージボディ内容)を処理するクラス。
出力項目(メッセージボディバイト長)を処理するクラス。
出力項目(メッセージヘッダ)を処理するクラス。
出力項目(メッセージID)を処理するクラス。
出力項目(応答宛先キュー名)を処理するクラス。
出力項目(スレッド名)を処理するクラス。
出力項目(メッセージ有効期間)を処理するクラス。
メッセージ送受信処理の中でログ出力を行うクラス。
ログファイルはキュー毎に個別に設定できる。
ログが出力されるタイミングは以下のとおり
出力項目(関連メッセージID)
出力項目(宛先キュー名)
出力項目(メッセージボディ内容)
出力文字列はフォーマッターの文字エンコーディングで出力される。
このため、データタイプ P/B のフィールド部分は文字化けする。
また、マスク対象パターンが設定されている場合、該当箇所がマスクされて出力される。
出力項目(メッセージボディ内容)
メッセージボディのヘキサダンプを出力する。
また、マスク対象パターンが設定されている場合、該当箇所がマスクされた後のヘキサダンプが出力される。
出力項目(メッセージボディバイト長)
出力項目(メッセージヘッダ)
メッセージヘッダの内容を出力する。
出力項目(メッセージID)
ログの出力内容を保持するクラス。
出力項目(応答宛先キュー名)
出力項目(スレッド名)
出力項目(メッセージ有効期間)
メッセージング処理中のログの出力内容に関連した処理を行うユーティリティクラス。
クラスローダから生成した
MessagingLogFormatter
に処理を委譲する。メッセージング機能の基本API(
MessagingContext
)の実装系を提供する
モジュールが実装するインターフェース。MessagingReceiveTestExtension
を適用するための合成アノテーション。MessagingReceiveTestSupport
を JUnit 5 で使用するための Extension 実装。メッセージ応答なし受信処理用のテストサポートクラス。
MessagingRequestTestExtension
を適用するための合成アノテーション。MessagingRequestTestSupport
を JUnit 5 で使用するための Extension 実装。メッセージ同期応答用のテストサポートクラス。
MeterBinder
のリストを提供するインターフェース。MeterRegistryFactory<T extends io.micrometer.core.instrument.MeterRegistry>
MeterRegistry
のコンポーネント生成に共通する処理をまとめた抽象クラス。任意のオブジェクトに対して、メソッドレベルのディスパッチを行う
ハンドラを作成するインターフェース。
MethodBinder
のファクトリクラス。メソッドレベルのディスパッチ機能を実装する際に継承する抽象基底クラス。
メトリクスに設定する情報(名前、説明、タグ)を保持するデータクラス。
Micrometerの設定を読み込むためのクラス。
DownloadFileNameEncoder
の実装クラス。
ダウンロードファイル名をRFC2047の仕様に従い、MIME-Bエンコード方式でエンコードするクラス。
HttpCookie
のテストFW用モック実装クラス。testing framework用の
HttpRequest
実装クラス。Bean Validationの補完用属性を保持する
MessageInterpolator.Context
の実装クラス。テストデータから擬似的に作成されるメッセージを複数保持するクラス。
パディングの除去処理(MockMessage#removePadding(String, Object, nablarch.core.dataformat.FixedLengthDataRecordFormatter) が継承元と異なる。 固定長ファイルとメッセージはis-a関係ではないが、 固定長ファイルの機能がほぼそのまま流用できるので継承をしている。 (固定長ファイルにおける1レコードが、メッセージングにおける1件のメッセージに相当する。)
パディングの除去処理(MockMessage#removePadding(String, Object, nablarch.core.dataformat.FixedLengthDataRecordFormatter) が継承元と異なる。 固定長ファイルとメッセージはis-a関係ではないが、 固定長ファイルの機能がほぼそのまま流用できるので継承をしている。 (固定長ファイルにおける1レコードが、メッセージングにおける1件のメッセージに相当する。)
テストデータの内容にもとづき、任意の応答電文を返却するMessageSenderClient。
テストデータの内容にもとづき、要求電文のログ出力および、任意の応答電文を返却するMessagingContext。
モックのMessagingContextを返却するMessagingProvider。
単体テスト用の
ServletExecutionContext
のモッククラス。例外がMOM接続に関する問題である場合に送出される例外。
入力データ復元とHTMLエスケープを行うinputタグ(type="month")を出力するクラス。
テストで必要なメッセージング操作をサポートするクラス。
BeanValidationによるバリデーションエラー時のメッセージを
Locale
に応じて切り替えるためのMessageInterpolator.マルチレイアウトな固定長データを表すクラス。
マルチレイアウト用の設定構築クラス。
マルチレイアウトの定義を表すクラス
マルチレイアウトな固定長データのレコードを識別するインタフェース。
レコード名を扱うインタフェース
マルチパートを解析するハンドラ。
キーの大文字と小文字、アンダースコア(_)の有無を区別しないマップの実装クラス。
後続ハンドラの処理を子スレッドを用いて実行するハンドラ。
多値の入力項目の実装をサポートするクラス。
JavaEEコンテナの初期化時に、
JavaBatchの仕様に準拠したバッチアプリケーション実行に必要な初期処理を行う
Extension
実装クラス。NablarchMeterRegistryConfig
を用いてCloudWatchConfig
を実装したクラス。NablarchMeterRegistryConfig
を用いてDatadogConfig
を実装したクラス。GCの発生回数をカウントする
MeterBinder
。Nablarchのスコープオブジェクトを使用できるサーブレットリクエストのラッパー。
サーブレットセッションのラッパー
ポストパラメータの読み込みに失敗したことを表す実行時例外。
ItemWriter.writeItems(List)
の前後に任意の処理を行うインタフェース。ItemWriteListener
を実装したクラスで、NablarchItemWriteListener
を順次実行するクラス。Nablarchの
Logger
へログを出力するJdbcLogger
の実装クラス。JOBの開始と終了時に任意の処理を行うためのインタフェース。
JobListener
を実装したクラスで、NablarchJobListener
を順次実行するクラス。リスナー実行時のコンテキスト情報を保持するクラス。
各レベルのリスナー実行クラスにて共通で必要となる処理をまとめたクラス。
リスナーを実行するランナー
SLF4Jのロガーを実装したクラス。
ログ出力をNablarchのロガーに委譲する。
SLF4Jのロガーファクトリを実装したクラス。
NablarchMeterRegistryConfig
を用いてLoggingRegistryConfig
を実装したクラス。Nablarchのメッセージ管理機能を使用してメッセージを構築するクラス。
DiContainer
がロードした情報で設定値を解決するMeterRegistryConfig
の実装クラス。NablarchMeterRegistryConfig
を用いてOtlpConfig
を実装したクラス。コンテキストの初期化を行う。
本クラスにおけるロガーの取得処理は、アプリケーションの起動時にログの初期処理を確実に行う意図があるため、削除しないこと。
本クラスにおけるロガーの取得処理は、アプリケーションの起動時にログの初期処理を確実に行う意図があるため、削除しないこと。
セッションストアを引き継ぐためのプロセッサ。
セッションIDをレスポンスの"Set-Cookie"ヘッダーから抽出し
リクエストのCookieとして付加する。
NablarchMeterRegistryConfig
を用いてSimpleConfig
を実装したクラス。SLF4JServiceProvider
の実装クラス。NablarchMeterRegistryConfig
を用いてStatsdConfig
を実装したクラス。ステップの開始と終了時に任意の処理を行うためのインタフェース。
StepListener
を実装したクラスで、NablarchStepListener
を順次実行するクラス。Nablarchのカスタムタグ機能に必要なリクエスト処理を行うハンドラ。
このハンドラは、1リクエストにつき一度だけ下記の処理を行う。 内部フォワードにより1リクエストにつき複数回呼ばれても初回のみ処理を行う。 ボタン又はリンク毎のパラメータ変更機能を実現するために、リクエストに変更パラメータを設定する。 リクエストにcheckboxタグのチェックなしに対応する値を設定する。 hiddenタグの暗号化機能に対応する改竄チェックと復号を行う。 HTTPアクセスログのリクエストパラメータを出力する。 カスタムタグのデフォルト値をJSPで参照できるように、
このハンドラを使用する場合は、改竄を検知した場合に遷移する画面とステータスを必ずプロパティで指定する必要がある。
HTTPアクセスログの出力は、
このハンドラは、1リクエストにつき一度だけ下記の処理を行う。 内部フォワードにより1リクエストにつき複数回呼ばれても初回のみ処理を行う。 ボタン又はリンク毎のパラメータ変更機能を実現するために、リクエストに変更パラメータを設定する。 リクエストにcheckboxタグのチェックなしに対応する値を設定する。 hiddenタグの暗号化機能に対応する改竄チェックと復号を行う。 HTTPアクセスログのリクエストパラメータを出力する。 カスタムタグのデフォルト値をJSPで参照できるように、
CustomTagConfig
をリクエストスコープに設定する。
改竄チェックと復号は、カスタムタグのデフォルト値設定において、hiddenタグの暗号化機能を「使用する」に設定している場合のみ処理を行う。
hiddenタグの暗号化機能を「使用しない」に設定している場合は、何もせずに次のハンドラに処理を委譲する。
さらに、カスタムタグのデフォルト値設定の暗号化を行わないリクエストIDに現在のリクエストIDが含まれる場合は、
改竄チェックと復号を行わずに次のハンドラに処理を委譲する。
このハンドラを使用する場合は、改竄を検知した場合に遷移する画面とステータスを必ずプロパティで指定する必要がある。
HTTPアクセスログの出力は、
HttpAccessLogUtil
に委譲する。TestSupportExtension
を適用するための合成アノテーション。ユーティリティクラス。
リフレクションAPIを使用する際の簡易的なテンプレートクラス。
例外が発生した場合の典型的な対処を提供する。
例外が発生した場合の典型的な対処を提供する。
NablarchのFormを使用する場合のリクエスト内容のバリデーション、オブジェクト(Form)生成ロジック.
Nablarch Validationを使用するときの
ValidationTestStrategy
実装クラス。変数名やクラス名を相互に変換するユーティリティクラス。
ブラウザのキャッシュを防ぐクラス。
データが存在しないことを表す例外クラス。
入力データを必要としないバッチ処理用の基本実装クラス。
ハンドラーキュー上に処理を委譲するためのハンドラが存在しない場合に
送出される例外。
何もしないハンドラ実装クラス。
本番で動作するハンドラを、テスト実行時のみ無効化する用途に使用する。 コンポーネント設定ファイルにて、無効にしたいハンドラの実体を本クラスにすることで、 そのハンドラの動作を無効化できる。
本番で動作するハンドラを、テスト実行時のみ無効化する用途に使用する。 コンポーネント設定ファイルにて、無効にしたいハンドラの実体を本クラスにすることで、 そのハンドラの動作を無効化できる。
SSLContextを使用しない旨を表すクラス。
メッセージ送信定義ファイルの設定を「SSLContextなし」に上書きする際に使用する。
メッセージ送信定義ファイルの設定を「SSLContextなし」に上書きする際に使用する。
何も出力しない
LogWriter
実装クラス。リクエストパラメータの値をノーマライズするハンドラ。
ノーマライズを行うインタフェース。
文字ストリームでNULLデータを許容するデータタイプ。
null値を解釈する解釈クラス。
要素の値が、半角「null」(大文字、小文字は区別しない)の場合は、null値に置き換える。
要素の値が、半角「null」(大文字、小文字は区別しない)の場合は、null値に置き換える。
NullにマッチするMatcherクラス。
nullをシリアライズするクラス。
nullを変換するための特殊なシリアライザとなり、
シリアライズによりJsonのnullとして出力する。
nullを変換するための特殊なシリアライザとなり、
NullToJsonSerializer.isTarget(Class)
による判定は常にtrueを返す。シリアライズによりJsonのnullとして出力する。
数値のコンバータの作成を助けるサポートクラス。
数値のコンバータは変換前にバリデーションを行うが、各コンバータが行う共通バリデーションは当クラスにて行う。
数値をフォーマットするクラス。
入力値が指定の範囲内であるかチェックする。
入力値が実数の場合は、
DecimalRange
を用いること。数値型のプロパティが指定した数値の範囲内であるかをチェックするアノテーション。
複数指定用のアノテーション
指定された整数の範囲の数値であることを検証するバリデータ。
数値の範囲をチェックするクラス。
数値文字列をフォーマットするクラス
符号なし数値コンバータ。
符号なし数値のデータタイプ。
入力データ復元とHTMLエスケープを行うinputタグ(type="number")を出力するクラス。
Numberの値をシリアライズするクラス。
数値に関するユーティリティクラス。
数値関連のバリデーションを行う抽象クラス。
Object
の配列型への変換を行う Converter
。オブジェクトをCSVにマッピングするのをサポートするクラス。
This object contains factory methods for each
Java content interface and Java element interface
generated in the nablarch.core.repository.di.config.xml.schema package.
SystemRepository
に保持するオブジェクトを読み込むインタフェース。Javaオブジェクトと任意のフォーマットをバインディングするインタフェース。
ObjectMapper
を生成するクラス。
ObjectMapper生成に利用するファクトリクラス(ObjectMapperFactory
)の実装クラスは、以下の通り決定される。
SystemRepository
にコンポーネント名"objectMapperFactory"でオブジェクトが登録されている場合、
そのオブジェクトを利用する。
SystemRepositoryに登録されていない場合、本クラスをファクトリクラスとして利用する。
ログ出力機能の設定からオブジェクトに対する設定を抜き出して保持するクラス。
任意のオブジェクトを文字列としてシリアライズするクラス。
本クラスは全てのObjectを受け入れてシリアライズする。
toString()メソッドの戻り値をシリアライズ対象の文字列とする。
シリアライズによりJsonのstringとして出力する。
本クラスは全てのObjectを受け入れてシリアライズする。
toString()メソッドの戻り値をシリアライズ対象の文字列とする。
シリアライズによりJsonのstringとして出力する。
フレームワークで使用する、オブジェクトの取り扱いを助けるユーティリティクラス。
二重サブミットを防止する
Interceptor
。リクエストハンドラが例外を送出した場合のレスポンスを指定する
Interceptor
。OnError
インターセプタの実装。リクエストハンドラが例外を送出した場合のレスポンスを指定する
Interceptor
。OnErrors
インターセプタの実装。データリーダで初回に取得したデータを処理するハンドラ実装クラス。
運用担当者向けの通知ログを出力するロガー
楽観的ロックでバージョン番号が更新されている場合に発生する例外。
Oracle用の方言を吸収するためのクラスです。
OS環境変数をコンポーネント定義として読み込む
ExternalizedComponentDefinitionLoader
。OtlpMeterRegistry
のファクトリ。後処理実行可能なハンドラであるマーカインタフェース。
パック10進数のデータタイプ。
パディング/トリム処理で使用する値を設定する。
このコンバーターはフィールド設定を行うのみで、実際のパディング/トリム処理はデータタイプのコンバータに委譲する。
ページネーションのための値をもつクラス。
ステートメントにバインドするパラメータ名とその値を保持するクラス。
本クラスで保持された値は、ログ出力、クエリ結果のキャッシュに使用される。
バインドされるパラメータ値を表すインタフェース。
本インタフェースはメソッドを定義しない。
実装クラスを型安全に扱うためのインタフェースである。
(Mapのvalueの型として使用する)
本クラスのインスタンスは、以下の機能を実装する。
格納したオブジェクトが等価であるかどうかの判定(equals, hashCode)
格納したオブジェクトの文字列表現(toString)
名前付きバインド変数をもつSQL文を実行するインタフェース。
パラメータマップとパラメータ文字列の変換を行うクラス。
パラメータ文字列の作成時は、コンストラクタで指定されたセパレータを使用し、 パラメータに含まれるセパレータはエスケープ処理する。
パラメータ文字列の作成時は、コンストラクタで指定されたセパレータを使用し、 パラメータに含まれるセパレータはエスケープ処理する。
サブミット時に追加するパラメータを指定するクラス。
パラメータを指定するクラスの実装をサポートするクラス。
This exception is thrown when parse errors are encountered.
Token literal values and constants.
Token Manager.
マルチパートの情報を保持するクラス。
パート情報
同名のキーに複数のパートを保持することができる。
PartInfo
を一時的に集約し保持するMapクラス。同名のキーに複数のパートを保持することができる。
入力データ復元とHTMLエスケープを行うinputタグ(type="password")を出力するクラス。
パスと、それに割り当てられている
Options
のセット。ログに出力するために
PathOptions
をフォーマットする機能を提供するインターフェース。ルーティング定義を収集する機能を提供するインターフェース。
PathOptionsProvider
から取得したルーティング定義をベースにActionメソッドを特定するハンドラ。パス定義と、パスパラメータの書式定義(requirements)のセット。
パフォーマンスログのメッセージをJSON形式でフォーマットするクラス。
終了時の空きメモリ量を処理するクラス。
終了日時を処理するクラス。
終了時の使用メモリ量を処理するクラス。
実行時間を処理するクラス。
最大メモリ量を処理するクラス。
ポイントを処理するクラス。
処理結果を処理するクラス。
開始時の空きメモリ量を処理するクラス。
開始日時を処理するクラス。
開始時の使用メモリ量を処理するクラス。
パフォーマンスログのメッセージをフォーマットするクラス。
終了時の空きメモリ量を取得するクラス。
終了日時を取得するクラス。
終了時の使用メモリ量を取得するクラス。
実行時間を取得するクラス。
最大メモリ量を取得するクラス。
パフォーマンスログのコンテキスト情報を保持するクラス。
ポイントを取得するクラス。
処理結果を取得するクラス。
開始時の空きメモリ量を取得するクラス。
開始日時を取得するクラス。
開始時の使用メモリ量を取得するクラス。
パフォーマンスログを出力するクラス。
認可を行うインタフェース。
認可判定の実現方法毎に本インタフェースの実装クラスを作成する。
認可判定の実現方法毎に本インタフェースの実装クラスを作成する。
Deprecated.
バージョン5以降では、新しいパッケージの
PermissionCheckHandler
を使用すること。認可判定を行うハンドラ。
このクラスを使用する場合は、下記プロパティを設定する。
複数指定する場合はカンマ区切り。
このクラスを使用する場合は、下記プロパティを設定する。
PermissionCheckHandler.permissionFactory
Permission
を生成するPermissionFactory
。必須。
PermissionCheckHandler.ignoreRequestIds
認可判定を行わないリクエストID。オプション。複数指定する場合はカンマ区切り。
認可情報に基づき、サブミットを行うタグの表示制御を行う必要があるか否かを判定するクラス。
Permission
を生成するインタフェース。
認可情報の取得先毎に本インタフェースの実装クラスを作成する。
認可単位リクエストテーブルのスキーマ情報を保持するクラス。
認可単位テーブルのスキーマ情報を保持するクラス。
権限管理に使用するユーティリティクラス。
事前処理、事後処理を行うInvoker.
ハンドラリストの組み立てを行うインタフェース。
入力データ復元とHTMLエスケープを行うinputタグ(type="hidden")を出力するクラス。
POIを使用してEXCELからテストデータを読み込むクラス。
EXCELに記述されたテストデータは、すべて文字列書式となっている必要がある。 文字列書式以外のデータ書式が存在した場合の動作は保証しない。
EXCELに記述されたテストデータは、すべて文字列書式となっている必要がある。 文字列書式以外のデータ書式が存在した場合の動作は保証しない。
ポップアップを行うbuttonタグを出力するクラス。
ポップアップを行うaタグを出力するクラス。
ポップアップを行うinputタグ(type="submit","button","image")を出力するクラス。
PostgreSQL用のSQL方言クラス。
POST時のリクエスト情報を保持するクラス。
Deprecated.
アプリケーションで実装したほうが分かりやすく簡単に実装できるため、POST再送信を防止するには業務アクションにてリダイレクトのレスポンスを返すことで実現すること。
事前に登録されたHTMLタグをそのまま出力する。
HttpSession
を生成できないようにした HttpServletRequest
のラッパークラス。アプリケーションを異常終了させる際に送出する例外クラス。
処理対象件数及び処理済みの件数を元に進捗を求めるクラス。
アプリケーション起動を実装するためのインタフェース。
プロセス名を表すクラス
プロセスを常駐化するためのハンドラ。
処理中のプロセスを停止するためのハンドラ。
プロセス停止を示す例外。
進捗状況を保持するクラス。
バッチの進捗状況を求めるインタフェース。
進捗状況をログに出力するロガー。
Chunk実行時の進捗ログを出力する
ItemWriteListener
実装クラス進捗状況をログに出力するクラス。
進捗を管理するインタフェース。
進捗状況を出力するインタフェース。
設定ファイルから文字列の設定値を読み込むクラス。
propertiesファイルを
Properties
を使ってloadするクラス。文字列リソースをプロパティファイルから取得するクラス。
コンポーネントにプロパティを設定する際に使用する型。
バリデーション対象プロパティの論理名を表わすアノテーション。
バリデーションに必要なプロパティの情報を保持するクラス。
Nablarchが後方互換性を維持するAPIであることを表すアノテーション。
引用符を取り除く解釈クラス。
要素の値が、ダブルクォート(半角、全角問わず)で囲われている場合は、前後のダブルクォートを削除する。
要素の値が、ダブルクォート(半角、全角問わず)で囲われている場合は、前後のダブルクォートを削除する。
CsvFormat.quoteMode()
でCsvDataBindConfig.QuoteMode.CUSTOM
を選択した場合に
対象のフィールドを示すアノテーション。入力データ復元とHTMLエスケープを行うinputタグ(type="radio")を出力するクラス。
n:radioButtonsタグで表示できないレイアウト時に使用する。
n:radioButtonsタグで表示できないレイアウト時に使用する。
ランダムなトークンを生成するクラス。
Unicodeコードポイントの範囲による許容文字集合定義クラス。
コードポイントの開始位置と終了位置の範囲内が許容文字の集合となる。 コードポイントは、Unicode標準の U+n 表記で指定する。
コードポイントの開始位置と終了位置の範囲内が許容文字の集合となる。 コードポイントは、Unicode標準の U+n 表記で指定する。
入力データ復元とHTMLエスケープを行うinputタグ(type="range")を出力するクラス。
数値が範囲内であるかのバリデーションを行う抽象クラス。
バリデーション範囲を指定し、バリデーションを行うクラス。
Jsonのobjectへの埋め込み用クラス。
HTMLエスケープ処理を行わないWriteTag
対外システムから受信した電文を表すクラス。
宛先数が不正な場合に発生する例外クラス。
マルチレイアウトのレコードであることを表すアノテーション。
レコードの定義をあらわすクラス。
フォーマット定義ファイル内の、レコードタイプの定義情報を保持するクラス。
フォーマット定義ファイルのパース結果として生成される。
データレコードのレコードタイプ名に応じて委譲先のメソッドを決定するディスパッチハンドラ。
このディスパッチャでは、次のシグニチャに一致するメソッドに対して後続処理を委譲する。
HttpMethodBindingのファクトリクラス
Redisのヘルスチェックを行うクラス。
キーの存在チェックを行い、例外が発生しなければヘルシと判断する。
キーのデフォルトは"healthcheck"。
キーは存在しなくてよい。
Referrer-Policyレスポンスヘッダを設定するクラス。
リポジトリ機能を使用して構築した
controllerNameのパラメータ値にコントローラ名を設定することで、設定した名前を元に移譲するWebFrontControllerを取得することができる。 デフォルトではwebFrontControllerという名前で移譲するWebFrontControllerを取得する。
WebFrontController
を保持し、
そこに対してリクエスト処理を委譲するリクエストコントローラー.controllerNameのパラメータ値にコントローラ名を設定することで、設定した名前を元に移譲するWebFrontControllerを取得することができる。 デフォルトではwebFrontControllerという名前で移譲するWebFrontControllerを取得する。
コンポーネントの初期化を行うクラス。
リポジトリの初期化クラス。
リクエストを表すインタフェース。
HttpServletRequest
オブジェクトに対してMapインターフェースを与えるラッパー。HTTPリクエストダンプ用サーバクラス。
HTTPリクエストダンプ用サーバをシャットダウンする為のサーブレットフィルタクラス。
特定のURL(例えば、/shutdown)に本フィルタをマッピングすることで、 ブラウザからサーバのシャットダウン指示が可能となる。
特定のURL(例えば、/shutdown)に本フィルタをマッピングすることで、 ブラウザからサーバのシャットダウン指示が可能となる。
HTTPダンプ用サーブレットクラス。
要求されたリクエストが大きすぎるため、処理を継続できないことを示す例外。
各リクエストのリクエストパスの内容に応じ、内部に保持するハンドラに
処理を委譲するかどうかを判断するハンドラ。
データベース更新時にフィールド情報にリクエストIDを設定する事を表すアノテーション。
RequestIdアノテーションが設定されているフィールドにリクエストIDを設定するクラス。
リクエストIDは、
リクエストIDは、
ThreadContext
から取得した値を設定する。スレッドコンテキストに保持するリクエストID属性。
リクエストIDの抽出を行うインターフェース。
外部システムから受信した処理要求電文の内容を格納し、対応する応答電文を作成するクラス。
リクエストパスをJavaパッケージへマッピングすることで動的に委譲先ハンドラを決定するディスパッチハンドラ。
リクエストパスとリクエストパスのパターンの照合を行うクラス。
Cookieを引き継ぐためのプロセッサ。
レスポンス内の
HttpCookie
より指定されたCookieの値を取得し、
リクエストのCookieとして付加する。HttpRequest
とHttpResponse
に追加処理を実行するインターフェースリクエスト単体テストの際に、テストショット毎のメッセージを保持するクラス。
リクエスト単体テストの際に、テストデータの内容にもとづき、要求電文のアサートおよび応答電文の返却を行うMessageSenderClient。
リクエスト単体テストの際に、テストデータの内容にもとづき、要求電文のアサートおよび応答電文の返却を行うMessagingProvider。
テストを行う際に、要求電文のアサートおよび応答電文を返却するMessagingContext。
リクエスト単体テストで必要なメッセージング操作をサポートするクラス。
各サブスレッド上のループ毎にリクエスト処理を実行するハンドラ。
リクエスト処理に使用するユーティリティ。
必須項目を表すアノテーション。
必須入力を表わすアノテーション。
複数指定用のアノテーション
必須項目が設定されていることを検証するバリデータ。
必須入力をチェックするクラス。
各種リソースを識別する為の文字列(リソースロケータ)をパースして格納するクラス。
nablarch-fw-web内でのみ使用する
ResourceLocator
の補助クラス。リクエストURIに応じて、リソースファイルに対するマッピングを行うリクエストハンドラ。
言語対応リソースパスのルールを表すクラス。
ファイルシステム上やJarファイル中に展開されているリソースの集まりを扱うユーティリティクラス。
ファイルシステム上のリソース扱うクラス。
Jarファイル中のリソースの集まりを扱うクラス。
リソースの集まりを表すインタフェース。
ResourcesUtil.Resources
のインスタンスを作成するファクトリインタフェース。HTTPレスポンスのボディ内容を格納するオブジェクト。
レスポンスを仕上げるインタフェース。
JaxRsResponseHandler
が作成したレスポンス(エラーレスポンス含む)に共通する処理を行う。
共通処理としてはセキュリティやCORSに対応したレスポンスヘッダの設定などを想定している。
レスポンスの作成処理の後に実行する処理のため、このインタフェースの実装クラスでは例外を発生させてはならない。本システムに対する要求電文への応答電文を表すクラス。
本クラスでは、RequestMessageと同様、応答電文の内容をフレームワークヘッダ部と
業務データ部に分離して管理しており、業務ロジックからは業務データ部しか操作できない
ようになっている。
メッセージボディを直列化する際には、フレームワークヘッダ部と業務データ部をそれぞれ
直列化して連結したものを返す。
Resteasyを使用する
JaxRsHandlerListFactory
の実装クラス。RESTfulウェブサービステスト用の
HttpRequest
モッククラス。RestMockHttpRequest
のビルダークラス。RestTestExtension
を適用するための合成アノテーション。RestMockHttpRequest
のbodyを文字列に変換するためのインターフェイス。MIMEタイプを表すクラス
RESTfulウェブサービステスト向けの
HttpTestConfiguration
拡張クラスRestTestSupport
を JUnit 5 で使用するための Extension 実装。RESTfulウェブサービス用のテストサポートクラス
DBアクセスを追加した
SimpleRestTestSupport
拡張クラスハンドラでの処理結果を表すインターフェース。
サービス呼出側に起因すると思われる問題により、処理が継続できないことを示す例外。
ハンドラの処理が異常終了したことを示す実行時例外。
処理結果が複数のステータスを含んでいることを表す。
要求されたリソースが存在しないため、
処理を継続することができないことを示す例外。
ハンドラの処理が正常終了したことを表す。
結果セットを格納対象とするキャッシュインタフェース。
結果セットをキャッシュに格納する際のキーとなるクラス。
以下の項目が等しい場合に等価と判定する。
SQL ID
バインドパラメータ
開始位置
最大件数
ResultSetCacheKey
を生成する際に使用するヘルパークラス。
ExpirableCache.remove(Object)
を呼ぶ際のキー作成に使用する。ResultSet
から1カラムのデータを取得するインタフェース。ResultSet.getObject(int)
以外を使用して、値を取得する必要がある場合には、
本クラスのサブクラスを作成しgetObject(int)以外を使用してデータの取得を行うこと。主に、getObject(int)を使用した場合にアプリケーションで処理する際に不都合なデータ型が返却される場合に、 本インタフェースの実装クラスが必要となる。
例えば、getObject(int)ではdoubleが返却されるため、
ResultSet.getBigDecimal(int)
を使用して、明示的にBigDecimal
を取得したい場合が該当する。ファイルを読み込むデータリーダをラップして、レジューム機能を追加するデータリーダ。
実行管理テーブルに格納されている、正常に処理できたポイントの参照・更新を行うクラス。
リトライ可能な例外であることを示すインタフェース。
RetryHandler によるリトライが可能な実行時例外。
RetryHandler.RetryContextFactory
の実装をサポートするクラス。RetryHandler.RetryContext
の実装をサポートするクラス。リトライ可能な例外を捕捉した場合に後続ハンドラの処理をリトライするハンドラ。
リトライ処理を制御するインタフェース。
リトライコンテキストを生成するインタフェース。
リトライ処理に使用するユーティリティクラス。
置換ルール。
ユーザにロールがあるか判定を行うインタフェース。
ログのローテーションを行うインタフェース。
ログのローテーションの種類毎に本インタフェースの実装クラスを作成する。
ログのローテーションの種類毎に本インタフェースの実装クラスを作成する。
Routes定義ファイルをベースにActionメソッドを特定するハンドラ。
本ハンドラを使用することで、自由なURLを使用することができる。
ルーティング用の
MethodBinder
の実装クラス。RoutesMethodBinder
を生成するファクトリクラス。ルーティングハンドラをサポートする抽象クラス。
値の末尾に指定の文字を付加(読み込み時は除去)することを示す。
値の変換処理を行う。
サニタイジングチェックツール
サニタイジングチェック結果をXMLに出力する。
JSP検査ツール
サニタイジングツール設定情報を保有するクラス
スキーマのプレースホルダーを置き換えるクラス。
SQL文中に#SCHEMA#というプレースホルダーがあれば、それを指定されたスキーマ名で置換する。
コンテキストパスの付加とURLリライトに対応するscriptタグを出力するクラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="search")を出力するクラス。
Webアプリケーションのセキュリティに関する処理やヘッダ設定を行うハンドラ。
セキュリティに関連したレスポンスヘッダを返すインタフェース
単純な
SecureResponseHeader
の実装を提供するサポートクラス。検索処理のオプションを保持するクラス。
selectタグの属性を出力するクラスの実装をサポートするクラス。
対外システムに対する仕向け要求電文を表すクラス。
メール送信時にリトライ可能である状態を示す例外
メール送信時の送信ステータス更新に失敗した状態を示す例外
本例外が発生した際は、送信ステータスが未送信から送信済みまたは送信失敗へ失敗したことを表す。
メッセージ(同期送信)を解析するクラス。
エラー処理モードのEnum
テストで必要なメッセージング操作をサポートするクラス。
再送電文管理テーブルスキーマ定義クラス。
データベースのシーケンスオブジェクトを用いて一意の値を採番するクラス。
シーケンス採番に失敗したことを示す例外クラス。
Deprecated.
本実装は、
Dialect
を使用してシーケンス採番を行うSequenceIdGenerator
に置き換わりました。サービス提供可否状態を判定するインタフェース。
WEBサービス提供可否状態判定処理実施ハンドラ。
ThreadContext
から取得したリクエストIDがサービス提供可能かどうか判定する。Deprecated.
開閉局情報に基づき、サブミットを行うタグの表示制御を行う必要があるか否かを判定するクラス。
サービス提供可否状態を判定するユーティリティ。
サービス側で生じた問題により処理が継続できないことを示す例外。
一時的に処理の受付を停止していることを表す例外。
サーブレットコンテキストの生成を行うインタフェース。
サーブレットコンテナ上でのリクエスト処理における実行コンテキスト
セッション全体を表すクラス。
HttpSession
オブジェクトに対してMapインターフェースを与えるラッパー。Deprecated.
Deprecated.
本ハンドラは、
SessionStore
を用いてセッション管理を行う
SessionStoreHandler
に置き換わりました。セッションスコープ変数に対する並行アクセス同期ポリシー。
補足:並行アクセス同期ポリシーについて、version 1.4.3まではMANUALとSERIALIZEDが存在していたが、MANUALとSERIALIZEについてはversion 1.5.0以降で廃止された。
補足:並行アクセス同期ポリシーについて、version 1.4.3まではMANUALとSERIALIZEDが存在していたが、MANUALとSERIALIZEについてはversion 1.5.0以降で廃止された。
セッション書き込みに競合が発生したことを表す例外。
セッションに登録するオブジェクト。
JSPなどから値オブジェクトのプロパティを参照するために、Mapのインタフェースを実装している。
Mapインターフェースで操作する場合は、unmodifiableなMapとして振る舞う。
また、getter実行時に例外が発生する場合は、空のMapとして振る舞う。
セッションに指定したキーが存在しないことを示す例外クラス。
セッションストアの管理および、セッションオブジェクトの生成を行うクラス。
セッションの内容をストアに格納/読み込みするクラスが継承する共通実装。
ストアを選択できるセッション保存機能のためのハンドラ。
ユーザに紐づくロールをセッションストアから解決する
UserRoleResolver
実装。ユーザに紐づくロールをセッションストアに保存するAPIを提供するクラス。
セッションに関するユーティリティ。
Set
及びその具象サブクラスに型変換するクラス。変数に値を設定するクラス。
Short
型への変換を行う Converter
。RequestIdExtractor
の実装クラス。リクエストパスの最後の"/"以降を抜き出し、抜き出した文字列から拡張子を取り除いたものをリクエストIDとして扱う。
符号付き数値コンバータ。
符号付き数値のデータタイプ。
符号付きパック10進数のデータタイプ。
符号付きゾーン10進数のデータタイプ。
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (without unicode processing).
各種データとMapの相互変換結果を格納するクラス。
各種データとMapの相互変換を行うユーティリティクラス。
SimpleDbTransactionManager
を使用して簡易的にSQL文を実行するクラス。
本クラスを継承したクラスは、
SimpleDbTransactionExecutor.execute(nablarch.core.db.connection.AppDbConnection)
を実装し、
SQL文の実行を行う。これにより、
SimpleDbTransactionManager
を直接使用するときと比べて、
トランザクション管理などを実装する必要がなく、簡易的にSQL文を実行出来るようになる。
データベースへのトランザクション制御を行うクラス。
SimpleMeterRegistry
のファクトリ。PathOptions
を単純な形式でフォーマットする機能を提供するクラス。リフレクションAPIを用いてFormのインスタンスを生成する
BeanValidationFormFactory
実装クラス。
本クラスはBeanValidationFormFactory
のデフォルト実装である。
本クラスを利用することで、5u15までと同じ動作となる。単純な置換を実行するクラス。
以下の3種類の入出力をサポートする。 File -> File InputStream -> OutputStream Reader -> Writer 入力した各行について、指定された置換対象パターンに合致するかどうか判定し、 合致した場合は、指定された置換文字列に置き換えて出力する。 置換対象パターンに合致しなかった場合は、入力した行をそのまま出力する。
以下の3種類の入出力をサポートする。 File -> File InputStream -> OutputStream Reader -> Writer 入力した各行について、指定された置換対象パターンに合致するかどうか判定し、 合致した場合は、指定された置換文字列に置き換えて出力する。 置換対象パターンに合致しなかった場合は、入力した行をそのまま出力する。
SimpleRestTestExtension
を適用するための合成アノテーション。SimpleRestTestSupport
を JUnit 5 で使用するための Extension 実装。RESTfulウェブサービス用のテストサポートクラス
シングルバイト文字列のデータタイプ。
シングルレイアウト用の設定構築クラス。
単項目のバリデーションテストを行うクラス。
単一値の入力項目の実装をサポートするクラス。
設定対象の値がString[]の場合に、配列先頭の値を取得するクラス。
任意の型のConverterを渡すことで、戻り値をその型に変換して取得することができる。
要素数が指定した値の範囲内であるかチェックするアノテーション。
要素数をバリデーションする
ConstraintValidator
実装クラス(抽象クラス)。配列の要素数をバリデーションする
ConstraintValidator
実装クラス。コレクションの要素数をバリデーションする
ConstraintValidator
実装クラス。複数指定用のアノテーション
SLF4Jを使用してログ出力を行うクラス。
Slf4JLogger
を生成するクラス。SQL文の変換を行うインタフェース。
SQL文の変換を行うクラスをサポートするクラス。
ストアドプロシージャを実行するインタフェース。
java.sql.Date
型への変換を行う Converter
。SQLログを出力するクラス。
付加情報を処理するクラス。
バッチ件数を処理するクラス。
検索件数を処理するクラス。
実行時間を処理するクラス。
フェッチ件数を処理するクラス。
メソッド名を処理するクラス。
タイムアウト時間を処理するクラス。
データ取得時間を処理するクラス。
最大取得件数を処理するクラス。
SQL文を処理するクラス。
取得開始位置を処理するクラス。
更新件数を処理するクラス。
SQL文ロード時のコールバック処理を行うインタフェース。
SQLログを出力するクラス。
付加情報を取得するクラス。
バッチ件数を取得するクラス。
検索件数を取得するクラス。
実行時間を取得するクラス。
フェッチ件数を取得するクラス。
メソッド名を取得するクラス。
タイムアウト時間を取得するクラス。
データ取得時間を取得するクラス。
最大取得件数を取得するクラス。
SQL文を取得するクラス。
SQLログのコンテキスト情報を保持するクラス。
取得開始位置を取得するクラス。
更新件数を取得するクラス。
SQLログの出力を助けるユーティリティ。
名前付きバインド変数を持つSQL文を解析するインタフェース。
名前付きバインド変数を持つSQL文を解析し、JDBC標準のSQL文(バインド変数を「?」に置き換えたSQL)と名前付きバインド変数のListを生成する。
例:
名前付きバインド変数を持つSQL文を解析し、JDBC標準のSQL文(バインド変数を「?」に置き換えたSQL)と名前付きバインド変数のListを生成する。
例:
SqlParameterParser
を生成するインタフェース。SQL文中のプレースホルダーに対して置換を行うクラス。
プレースホルダーと、それに対応する置き換え後の値を設定することで、
SQL文中の任意のプレースホルダーに対して置換を行うことができる。
例えば、SQL文中でスキーマの置き換えをしたい場合、以下のようにコンポーネント設定をする。
バインド変数をもつSQL文を実行するインタフェース。
簡易検索結果を保持するクラス。
簡易取得結果1行分のデータを保持するクラス。
SqlServer用のSQL方言クラス。
SQLServer用のResultSet変換クラス。
SQL文を実行するインタフェース。
SQL文実行時に発生する例外クラス。
SqlStatementException
を生成するインタフェース。SQLのエラー内容(
SQLException.getSQLState()
やSQLException.getErrorCode()
の結果)に応じて、
生成するSqlStatementException
を切り替える場合には、具象クラスで生成するExceptionの切り替えを行う。SQLの処理実行時間をメトリクスとして計測する
DaoContext
のラッパークラス。java.sql.Timestamp
型への変換を行う Converter
。パラメータとSQLを格納する内部クラス。
standaloneで使用する
制約 セッションスコープがスレッドセーフである セッションスコープにnullを指定できない セッションストアが使用できない
ExecutionContext
の継承クラス。制約 セッションスコープがスレッドセーフである セッションスコープにnullを指定できない セッションストアが使用できない
独立型の処理方式のテスト実行をサポートするテンプレートクラス。
独立型処理方式のテストに共通の処理を提供する。 処理方式固有の処理はサブクラスにて実装する。
独立型処理方式のテストに共通の処理を提供する。 処理方式固有の処理はサブクラスにて実装する。
フォーマットエラーを標準エラーに出力するクラス。
Nablarch標準のフレームワーク制御ヘッダ定義。
本実装では、各電文のメッセージボディの先頭レコード上に
全てのフレームワーク制御ヘッダが定義されていることを前提としており、
JMSヘッダー等のメッセージングプロバイダ実装に依存する項目は使用しない。
標準出力にログを書き込むクラス。
開発時にコンソール上で出力されたログを確認する場合などに使用できる。
開発時にコンソール上で出力されたログを確認する場合などに使用できる。
ユニバーサルDAOで使用するSQL文を構築するクラス。
セッションからバイト列へ直列化、
およびバイト列からセッション内容の復元を行う際に用いられる
モジュールが実装するインターフェース。
SQL実行用オブジェクトを生成するインタフェース。
静的データキャッシュを保持するインタフェース。
静的データはIDを使った取得と、インデックスを使った取得の2種類の方法で取得できる。
インデックスを使った取得方法とは、静的データを一定のルールでまとめた集合をまとめて 取得する方法である。このまとまった集合にはそれぞれインデックスキーと呼ばれるキーが付け られており、本インタフェースではこのインデックスキーを指定して静的データの集合が取得できる。 なお、静的データを集合にまとめるルールは複数指定することができ、このルールにはインデックス名 と呼ばれる名称が付けられる。
静的データはIDを使った取得と、インデックスを使った取得の2種類の方法で取得できる。
インデックスを使った取得方法とは、静的データを一定のルールでまとめた集合をまとめて 取得する方法である。このまとまった集合にはそれぞれインデックスキーと呼ばれるキーが付け られており、本インタフェースではこのインデックスキーを指定して静的データの集合が取得できる。 なお、静的データを集合にまとめるルールは複数指定することができ、このルールにはインデックス名 と呼ばれる名称が付けられる。
静的データをロードするインタフェース。
StatsdMeterRegistry
のファクトリ。ステータスコードをプロセスの終了コードに変換するハンドラ。
ステップの進捗ログを出力するクラス。
ステップ開始時と終了時にログを出力する。
ステップ開始時と終了時にログを出力する。
ステップ単位での値の共有を表すアノテーション。
ステップ単位で値を共有するための
Context
実装クラスステップ単位で共有する値を保持するクラス。
Stepレベルのトランザクション制御を行う
NablarchStepListener
実装クラス。作成済みのオブジェクトをコンポーネントとして生成するクラス。
ストリームからHTTPレスポンスメッセージを生成するクラス。
String
の配列型への変換を行う Converter
。値をString配列に変換するクラス。
String
型のbodyを返すためのRestTestBodyConverter
実装クラス。String
型への変換を行う Converter
。値をStringに変換するクラス。
文字列とバイト列の相互変換を行うテスト用データタイプ。
半角カンマ () 区切りの文字列を
List<String>
のコンポーネントとして
生成する ComponentFactory
の実装。ユーザに通知するメッセージの元となる文字列リソースを保持するインタフェース。
複数言語に対応するアプリケーションでは、文字列リソースから言語ごとに異なる文字列を取得できる。
複数言語に対応するアプリケーションでは、文字列リソースから言語ごとに異なる文字列を取得できる。
ユーザに通知するメッセージの元となる文字列リソースを保持するクラス。
文字列リソースは静的データキャッシュに保持する。
文字列リソースは静的データキャッシュに保持する。
文字列をシリアライズするクラス。
受入れ可能なオブジェクトの型は java.lang.String。 シリアライズによりJsonのstringとして出力する。
受入れ可能なオブジェクトの型は java.lang.String。 シリアライズによりJsonのstringとして出力する。
文字列ユーティリティクラス。
文字列に関する汎用的な処理を提供する。
文字列に関する汎用的な処理を提供する。
文字列のValidatorの作成を助けるサポートクラス。
構造化データの構築を行うクラスが実装するインタフェース。
構造化データを解析/構築する際に使用するクラス郡の抽象基底クラス。
構造化データの解析を行うクラスが実装するインタフェース。
フォーマット定義ファイルの内容に従い、構造化データの読み書きを行うクラス。
XMLデータフォーマッタが使用するディレクティブの名前と値の型。
以下に一覧を示す。
root-element:String
root-element:String
構造化データのフレームワーク制御ヘッダの解析を行うデータリーダ。
構造化されたデータを取り扱うために、返信用オブジェクトとして
StructuredResponseMessage
を返却する要求メッセージ。構造化されたデータを取り扱うために、addRecord時にデータをすぐに書き込まず、メモリ上にキャッシュする応答メッセージ。
サブミット情報を保持するクラス。
サブミット時の動作を表す列挙型。
サブミット制御(リンクとアクションの紐付け、二重サブミット防止)を行うaタグを出力するクラス。
サブミット制御を行うaタグを出力するクラスの実装をサポートするクラス。
サブミット制御(リンクとアクションの紐付け、二重サブミット防止)を行うinputタグ(type="submit","button","image")を出力するクラス。
サブミット制御を行うinputタグ(type="submit","button","image")を出力するクラスの実装をサポートするクラス。
コメント。
ロックファイルを用いて排他制御を行いながらファイルにログを書き込むクラス。
電文(同期送信、同期応答)を保持するクラス。
メッセージ同期送信に使用する電文を変換するクラス。
メッセージ送信の処理前後に処理を行うためのインターフェイス。
フォーマット定義ファイルの内容に問題がある場合に送出される実行時例外。
システムアカウント権限テーブルのスキーマ情報を保持するクラス。
システムアカウントテーブルのスキーマ情報を保持するクラス。
システム許容文字で構成された文字列であることを表わすアノテーション。
システム許容文字で構成された文字列であることを表わすアノテーション。
複数指定用のアノテーション
システム許容文字のバリデーションを行う
ConstraintValidator
実装クラス。システム許容文字のバリデーションに関する設定を保持するクラス。
システム許容文字のみからなる文字列であるかをチェックするクラス。
システムプロパティをコンポーネント定義として読み込む
ExternalizedComponentDefinitionLoader
。システムプロパティの設定値を維持するクラス。
設定値およびコンポーネントを保持するクラス。
アプリケーションの設定値の取得とコンポーネントを生成する責務は
アプリケーションの設定値の取得とコンポーネントを生成する責務は
ObjectLoader
を実装したクラスが持つ。SystemRepository
登録対象のコンポーネントを表すアノテーション。SystemRepository
から委譲対象クラスのインスタンスを取得する
デリゲートファクトリ(DelegateFactory
)の実装クラス。システム日時を提供するクラスのインタフェース。
システム日付を取得するユーティリティ。
テーブルデータ保持クラス。
テストデータのテーブルデータを保持する。
テストデータのテーブルデータを保持する。
テストデータから
TableData
を解析するクラス。採番用のテーブルを使用して、連番の採番を行うクラス。
このクラスでは、業務トランザクションを使用して採番処理を行い、トランザクションのコミット処理は行わずに採番した値を返却する。
このため、業務アプリケーションの処理が確定されるまでコミットは行われないため、抜け番を発生させずに採番を行うことができる。
ただし、業務アプリケーションが確定されるまではロックが保有されるため、その他の業務処理でロック待機が発生し著しく性能を劣化させる可能性があるため注意が必要である。
このクラスでは、業務トランザクションを使用して採番処理を行い、トランザクションのコミット処理は行わずに採番した値を返却する。
このため、業務アプリケーションの処理が確定されるまでコミットは行われないため、抜け番を発生させずに採番を行うことができる。
ただし、業務アプリケーションが確定されるまではロックが保有されるため、その他の業務処理でロック待機が発生し著しく性能を劣化させる可能性があるため注意が必要である。
テーブルのスキーマ情報を保持するクラス。
タグをあらわすクラス。
タグ属性を表すクラス。
コメント。
解析対象のタグタイプを表す列挙型。
カスタムタグの作成を助けるユーティリティ。
hiddenタグの暗号化機能で改竄を検知した場合に発生する例外。
入力データ復元とHTMLエスケープを行うinputタグ(type="tel")を出力するクラス。
テンプレートエンジンを使用して件名と本文の準備をするクラス。
テンプレートエンジンを使用したテンプレートと変数のマージ処理をするためのインターフェース。
テンプレートエンジンで処理した結果を保持するクラス。
テンプレートエンジンの処理で発生した例外をラップする例外クラス。
定型メール送信要求を表すクラス。
データシートに定義されたテストケース情報を格納するクラス。
テストデータコンバータ
テストデータ記法を解釈するインタフェース。
様々なテストデータを簡略に表現する機能を持つ。 本インタフェースを実装するクラスは、おおよそ以下のような流れで処理をするとよい。 解釈対象の値を、
様々なテストデータを簡略に表現する機能を持つ。 本インタフェースを実装するクラスは、おおよそ以下のような流れで処理をするとよい。 解釈対象の値を、
InterpretationContext.getValue()
により取得する。
値を解釈できる場合は、解釈した結果を返却する。
自身で解釈しない(できない)場合は、InterpretationContext.invokeNext()
の値を返却する。
自身で解釈した値を更に、後続処理に渡したい場合は、InterpretationContext.setValue(String)
で解釈後の値を設定した後、InterpretationContext.invokeNext()
の値を返却する。
テストデータ取得インターフェース。
テストデータの読み込みインタフェース。
テスト対象のクラスとメソッド名を保持するルール
テストイベントディスパッチャクラス。
テスト実行時における各種イベントを検知し、リポジトリに登録されたリスナーに通知する。 テストクラスは本クラスまたは本クラスのサブクラスを継承することで、 リスナーに自動的にイベント通知を行えるようになる。
テスト実行時における各種イベントを検知し、リポジトリに登録されたリスナーに通知する。 テストクラスは本クラスまたは本クラスのサブクラスを継承することで、 リスナーに自動的にイベント通知を行えるようになる。
NTF の JUnit 5 用 Extension の基底となる抽象クラス。
テストイベントリスナーインタフェース。
テスト実行中の各種イベント通知を受け取る。
TestEventListener
実装のテンプレートクラス。リスナーを作成する際は、本クラスを継承し必要なメソッドのみ オーバライドするとよい。
ServletContextCreator
のテスト環境用実装クラス。明示的に生成したHTTPセッションからサーブレットコンテキストを生成する。
テストの前準備、結果検証を行うインタフェース。
処理方式固有の前準備、結果検証ロジックを実装すること。
処理方式固有の前準備、結果検証ロジックを実装すること。
テストサポートクラス。
本テスティングフレームワークを利用する際のヘルパーメソッドを提供する。
本テスティングフレームワークを利用する際のヘルパーメソッドを提供する。
TestSupport
を JUnit 5 で使用するための Extension 実装。入力データ復元とHTMLエスケープを行うtextareaタグを出力するクラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="text")を出力するクラス。
スレッド内で共有すべきオブジェクトを保持するクラス。
ThreadContext
に設定する属性を返すインタフェース。ThreadContextHandler
で設定したThreadContext
上の値をクリアするハンドラ。スレッドコンテキストに保持される共通属性を管理するハンドラ。
フレームワークには、スレッドコンテキストにユーザID・リクエストID・言語設定を保持する実装が含まれている。
これらを有効化するには以下のリポジトリ設定を追加する。
(同様にプロジェクト固有の属性を追加することも可能である。)
Thymeleafを使用する
TemplateEngineMailProcessor
の実装クラス。Thymeleafを使用する
CustomResponseWriter
実装クラス。リトライ時間によりリトライ処理を制御するクラス。
TimeRetryContext
を生成するクラス。ハンドラキューに追加することで、後続処理の実行時間をメトリクスとして収集するハンドラクラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="time")を出力するクラス。
スレッドコンテキストに保持するタイムゾーン属性。
クッキーを使用してタイムゾーンの保持を行うクラス。
クッキーのhttpOnly属性はアプリケーションで使用しているServlet APIがサポートしている場合のみ設定する。
HTTPセッションを使用してタイムゾーンの保持を行うクラス。
HTTP上でタイムゾーンの保持を行うクラスの実装をサポートするクラス。
HTTP上で選択されたタイムゾーンの保持を行う際に使用するユーティリティクラス。
簡易的なテンプレート機能を提供する
TemplateEngineMailProcessor
の実装クラス。Describes the input token stream.
トークンの生成を行うインタフェース。
二重サブミットトークンの管理を行うクラス。
Token Manager Error.
トークンを使用した二重サブミットの防止機能のユーティリティ。
なお、トークンは ExecutionContext#getSessionScopeMap で獲得可能なMapではなく、
HttpSession に直接格納する。
これは、SessionConcurrentAccessHandler と併用した場合、トークンはリクエストスレッド毎の
スナップショット上に保持されるので、本来エラーとなるタイミングでも並行実行されてしまう可能性
が発生するためである。
一覧検索において検索結果件数が検索結果の最大件数(上限)を超えた場合に発生する例外。
TPSを算出するクラス。
トランザクション制御を行うインタフェース。
業務処理が異常終了したことを示す例外クラス。
Deprecated.
Domaによるトランザクション制御を行うことを表すアノテーション。
Transactional
アノテーションのInterceptor
クラス。スレッドに紐付けられた
Transaction
を保持するクラス。トランザクション(コミット or ロールバック)毎に
呼び出されるコールバックメソッドを定義するインタフェース。
トランザクションイベントの発行を行うハンドラが継承するサポートクラス。
トランザクション制御ロジックを持つ抽象クラス。
トランザクション制御オブジェクト(
Transaction
)を生成するインタフェース。。後続処理における透過的トランザクションを実現するハンドラ。
通常の として使用する場合と、 として使用する場合で動作が異なる。
通常の として使用する場合と、 として使用する場合で動作が異なる。
データベースに対するトランザクション制御を行うインタフェース。
トランザクション内で簡易的な処理を記述する為のテンプレートクラス。
フレームワーク内部で使用する
TransactionTemplate
サブクラス。
トランザクションを制御する場合に使用する。
本クラスはアプリケーションには公開されていない。トランザクションタイムアウトエラー。
前後のホワイトスペース(
Character.isWhitespace(int)
)を除去するノーマライザ実装クラス。
ホワイトスペースを除去した結果、空文字列となった場合にはnull
に置き換える。必要な認証プロセスを経ていないため、処理を継続することができない
ことを示す例外。
汎用的なDAO機能を提供するクラス。
トランザクション境界を作るためのクラス。
アップロードファイルに対する定型処理を提供するユーティリティクラス。
ファイルアップロードに関する各種設定値を保持するクラス。
フレームワークで使用するURIの取り扱いを助けるユーティリティ。
DownloadFileNameEncoder
の実装クラス。
ダウンロードファイル名をURLエンコード方式でエンコードするクラス。
入力データ復元とHTMLエスケープを行うinputタグ(type="url")を出力するクラス。
フィールドの文字エンコーディングを指定する コンバータ。
このコンバーターはフィールドの設定処理のみを行うのみで、実際のエンコーディング処理は、データタイプのコンバータに委譲する。
UserAgent情報を表すクラス。
UserAgentの解析を行うインタフェース。
データベース更新時にフィールド情報にユーザIDを設定する事を表すアノテーション。
UserIdアノテーションが設定されているフィールドにユーザIDを設定するクラス。
ユーザIDは、
ユーザIDは、
ThreadContext
から取得した値を設定する。スレッドコンテキストに保持するユーザID属性。
セッションストアを使用してユーザIDの保持を行うクラス
ユーザに紐づくロールの一覧を解決するインタフェース。
ユーザセッションテーブルのスキーマ情報を保持するクラス。
二重サブミットを防止するために使用されるトークンを生成する
Interceptor
。UseToken
のインターセプタ。バージョン4のUUIDを使用してCSRFトークンの生成を行うクラス。
UUID(version4)を使用した
TokenGenerator
実装クラス。ValidationUtil でバリデーション可能なオブジェクトが実装するインタフェース。
バリデーション対象のパラメータを Map で取得するメソッドを持つ。
バリデーション対象のパラメータを Map で取得するメソッドを持つ。
ファイル内容のバリデーション機能を追加したデータリーダ。
バリデーションを行うオブジェクトが実装するインタフェース。
バリデーションを実装するメソッドに付与するアノテーション。
個別のバリデーションロジックを記述するためのインタフェース。
以下の処理を提供する。
1レコードに対するバリデーション処理
バリデーションエラーが発生した場合の処理
形式エラーが発生した場合の処理
バリデーション用のアノテーションであることを表わすアノテーション。
バリデーション実行中の情報を保持するクラス。
バリデーションとデータの変換を行うクラス。
実際のバリデーションとデータの変換はバリデータとコンバータに委譲する。
実際のバリデーションとデータの変換はバリデータとコンバータに委譲する。
バリデーション結果のメッセージを保持するクラス。
業務エラー時のメッセージ生成をサポートするユーティリティクラス。
リクエスト内容のバリデーション、オブジェクト生成ロジック。
階層構造を持つFormをバリデーションすることを表すアノテーション。
Form/Entityテスト実施時のコンテキスト情報を保持するクラス。
Form/Entityテストで使用するバリデーション毎のストラテジ。
バリデーションの実行時に使用するユーティリティクラス。
全てのメソッドは
全てのメソッドは
SystemRepository
から"validationManager"という名前で取得したValidationManager
に処理を委譲する。値のバリデーションを行うクラスが実装すべきメソッドを定義したインタフェース。
ValidatorFactory
を生成するクラス。Validator
に関するユーティリティクラス。フィールドデータの変換を行う際に、
一定のルールで変換を行うコンバータが実装するインターフェース。
一定のルールで変換を行うコンバータのサポートクラス。
値をフォーマットするインタフェース。
SQL文の可変条件構文を変換するクラス。
SQL文の可変IN構文を変換するクラス。
可変長データコンバータのファクトリクラス。
可変長ファイルの読み書きを行う際に使用するコンバータの設定情報を保持するクラス。
コンバータ名とコンバータ実装クラスの対応表 や、タイトルのレコードタイプ名などを、DIコンテナから設定できる。
フォーマット定義ファイルの内容に従い、可変長ファイルデータの読み書きを行うクラス。
可変長ファイルフォーマッタが共通的に使用するディレクティブの名前と値の型。(タイプセーフEnum)
以下に一覧を示す。
field-separator:String quoting-delimiter:String ignore-blank-lines:Boolean requires-title:Boolean max-record-length:Integer title-record-type-name:String
field-separator:String quoting-delimiter:String ignore-blank-lines:Boolean requires-title:Boolean max-record-length:Integer title-record-type-name:String
可変長ファイルを表すクラス。
可変長ファイルの断片を表すクラス。
固定長ファイルのテストデータを解析するクラス。
SQL文の可変ORDER BY構文を変換するクラス。
Velocityを使用する
TemplateEngineMailProcessor
の実装クラス。CSRFトークンの検証失敗時の処理を行うインタフェース。
HTTPリクエストがCSRFトークンの検証対象となるか判定を行うインターフェース。
排他制御用テーブルのバージョン番号を保持するクラス。
Webアプリケーションの設定を保持するクラス。
WebConfig
を取得するためのユーティリティ。アプリケーションサーバにデプロイして使用するリクエストコントローラ。
リクエスト処理に使用するユーティリティ。
Webアプリケーションの作成に必要となる共通機能を提供するユーティリティ。
入力データ復元とHTMLエスケープを行うinputタグ(type="week")を出力するクラス。
IBM MQを使用した
MessagingContext
の実装クラス。IBM MQを使用した
MessagingProvider
の実装クラス。メッセージの送信時と受信時に
MQMessage
のMQMDフィールドを操作するクラス。IBM MQを使用した分散トランザクションに対応した
TransactionManagerConnection
の実装クラス。IBM MQを使用した分散トランザクションに対応したデータベース接続を生成するクラス。
IBM MQを使用した分散トランザクションの制御を行うクラス。
WmqXATransaction
を生成するクラス。名前に対応する値を出力するクラス。
このタグで出力された値は必ずHTMLエスケープされる。
XMLファイルからコンポーネントの定義を読み込むクラス。
XMLパーサー。
この実装ではStAXを使用してXMLデータの構築を行います。
この実装ではStAXを使用してXMLデータの構築を行います。
XMLデータコンバータのファクトリクラス。
XMLデータの読み書きを行う際に使用するコンバータの設定情報を保持するクラス。
コンバータ名とコンバータ実装クラスの対応表 や、タイトルのレコードタイプ名などを、DIコンテナから設定できる。
XMLパーサー。
この実装ではDOMを使用してXMLデータの解析を行います。 5u14より、DTDの使用を禁止するように修正を行った。これはXXE攻撃を防ぐためである。 後方互換性を維持するため、DTDの使用を許可するプロパティを設けている(
この実装ではDOMを使用してXMLデータの解析を行います。 5u14より、DTDの使用を禁止するように修正を行った。これはXXE攻撃を防ぐためである。 後方互換性を維持するため、DTDの使用を許可するプロパティを設けている(
XmlDataParser.setAllowDTD(boolean)
)。
読み込み対象となるXMLが信頼できるものであり、かつ、DTDを使用しなければならない場合のみ、
本プロパティを使用してDTDの使用を許可することができる。フォーマット定義ファイルの内容に従い、XMLデータの読み書きを行うクラス。
X-XSS-Protectionレスポンスヘッダを設定するクラス。
YYYYMMConvertor
で許容する年月フォーマットを指定するアノテーション。入力値を年月を表す文字列に変換するクラス。
YYYYMMDDConvertor
で許容する年月日フォーマットを指定するアノテーション。入力値を年月日を表す文字列に変換するクラス。
年月日のフォーマットを行うクラス。
年月のフォーマットを行うクラス。
ゾーン10進数のデータタイプ。
ProgressLogListener
に置き換わりました。