uCosminexus DocumentBroker Version 3 クラスライブラリ Java サンプルWebアプリケーション

[目次][用語][索引][前へ][次へ]

6.3.1 Web依存アプリケーションクラスのJavaクラスファイル

Web依存アプリケーションクラスのJavaクラスファイルの格納先を次に示します。

UNIXの場合
/opt/HiEDMS/client/java/sample/websample/src/jp/co/Hitachi/soft/docbroker/sampleApp/web

Windowsの場合
<インストールディレクトリ>\java\sample\websample\src\jp\co\Hitachi\soft\docbroker\sampleApp\web

Web依存アプリケーションクラスには,次に示すクラスが含まれています。

<この項の構成>
(1) コマンドディスパッチャクラス
(2) コマンドサーブレットクラス
(3) APフレームクラス
(4) Webアプリケーション共通情報クラス
(5) 処理結果クラス
(6) 例外クラス
(7) ユティリティクラス
(8) 定数定義クラス
(9) リクエストパラメタクラス
(10) メッセージクラス
(11) プロパティ情報クラス

(1) コマンドディスパッチャクラス

クライアントからのHTTPリクエストを受け付けて,リクエスト(コマンド)に応じたServletに処理を分岐させるServletのクラスです。コマンドディスパッチャクラスのJavaクラスファイルを次の表に示します。

表6-3 コマンドディスパッチャクラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
通常リクエスト対応のディスパッチャ DwcDispatchSrv.java クライアントからHTTPリクエストを受け付けてリクエストに応じたコマンドサーブレットに処理を分岐させます。
マルチパーツリクエスト対応のディスパッチャ DwcUploadDispatchSrv.java クライアントからHTTPマルチパーツリクエストを受け付けてリクエストに応じたコマンドサーブレットに処理を分岐させます。ファイルのアップロード時に使用します。

(2) コマンドサーブレットクラス

リクエストに応じた処理を実行するServletのクラスです。コマンドサーブレットクラスのJavaクラスファイルを次の表に示します。

表6-4 コマンドサーブレットクラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
オブジェクト操作 文書作成 DwcCreateDocSrv.java 文書作成の制御を行います。文書作成部品1〜3を使用して文書作成を実行します。
文書作成部品1 DwcCreateDocParts1Srv.java 文書作成時のプロパティ入力画面を表示します。DwcCreateDocSrv.javaを介して実行されます。
文書作成部品2 DwcCreateDocParts2Srv.java 文書作成時のファイル指定画面を表示します。DwcCreateDocSrv.javaを介して実行されます。
文書作成部品3 DwcCreateDocParts3Srv.java 文書の作成を実行します。DwcCreateDocSrv.javaを介して実行されます。
文書削除 DwcRemeveDocSrv.java 文書の削除を実行します。
チェックアウト DwcCheckOutDocSrv.java 文書のチェックアウトを実行します。
チェックイン DwcCheckInDocSrv.java 文書のチェックインの制御を行います。チェックイン部品1〜3を使用して文書のチェックインを実行します。
チェックイン部品1 DwcCheckInDocParts1Srv.java 文書チェックイン時のプロパティ入力画面を表示します。DwcCheckInDocSrv.javaを介して実行されます。
チェックイン部品2 DwcCheckInDocParts2Srv.java 文書チェックイン時のファイル指定画面を表示します。DwcCheckInDocSrv.javaを介して実行されます。
チェックイン部品3 DwcCheckInDocParts3Srv.java 文書のチェックインを実行します。DwcCheckInDocSrv.javaを介して実行されます。
チェックアウトの取り消し DwcCancelCheckOutDocSrv.java 文書のチェックアウトの取り消しを実行します。
コンテンツのダウンロード DwcDownloadDocSrv.java コンテンツのダウンロードを実行します。
文書のプロパティ参照 DwcGetDocPropSrv.java 文書のプロパティを参照します。
文書のプロパティ更新 DwcUpdateDocPropSrv.java 文書のプロパティ更新の制御を行います。文書のプロパティ更新部品1〜2を使用してプロパティ更新を実行します。
文書のプロパティ更新部品1 DwcUpdateDocPropParts1Srv.java 文書のプロパティ更新時のプロパティ入力画面を表示します。DwcUpdateDocPropSrv.javaを介して実行されます。
文書のプロパティ更新部品2 DwcUpdateDocPropParts2Srv.java 文書のプロパティ更新を実行します。DwcUpdateDocPropSrv.javaを介して実行されます。
バージョン一覧表示 DwcGetDocVersionListSrv.java 文書のバージョン一覧を参照します。
バージョンプロパティ参照 DwcGetDocVersionPropSrv.java 文書のバージョンプロパティを参照します。
バージョン削除 DwcRemoveDocVersionSrv.java 文書のバージョンを削除します。
フォルダ作成 DwcCreateFolderSrv.java フォルダ作成の制御を行います。フォルダ作成部品1〜2を使用してフォルダ作成を実行します。
フォルダ作成部品1 DwcCreateFolderParts1Srv.java フォルダ作成時のプロパティ入力画面を表示します。DwcCreateFolderSrv.javaを介して実行されます。
フォルダ作成部品2 DwcCreateFolderParts2Srv.java フォルダの作成を実行します。DwcCreateFolderSrv.javaを介して実行されます。
フォルダ削除 DwcRemoveFolderSrv.java フォルダの削除を実行します。
フォルダのプロパティ参照 DwcGetFolderPropSrv.java フォルダのプロパティを参照します。
フォルダのプロパティ更新 DwcUpdateFolderPropSrv.java フォルダのプロパティ更新の制御を行います。フォルダのプロパティ更新部品1〜2を使用してプロパティ更新を実行します。
フォルダのプロパティ更新部品1 DwcUpdateFolderPropParts1Srv.java フォルダのプロパティ更新時のプロパティ入力画面を表示します。DwcUpdateFolderPropSrv.javaを介して実行されます。
フォルダのプロパティ更新部品2 DwcUpdateFolderPropParts2Srv.java フォルダのプロパティ更新を実行します。DwcUpdateFolderPropSrv.javaを介して実行されます。
共有ACL作成 DwcCreatePublicACLSrv.java 共有ACL作成の制御を行います。共有ACL作成部品1〜2を使用して共有ACL作成を実行します。
共有ACL作成部品1 DwcCreatePublicACLParts1Srv.java 共有ACL作成時のプロパティ入力画面を表示します。DwcCreatePublicACLSrv.javaを介して実行されます。
共有ACL作成部品2 DwcCreatePublicACLParts2Srv.java 共有ACL作成を実行します。DwcCreatePublicACLSrv.javaを介して実行されます。
共有ACL削除 DwcRemevePublicACLSrv.java 共有ACLの削除を実行します。
共有ACLのプロパティ参照 DwcGetPublicACLPropSrv.java 共有ACLのプロパティを参照します。
共有ACLのプロパティ更新 DwcUpdatePublicACLPropSrv.java 共有ACLのプロパティ更新の制御を行います。共有ACLのプロパティ更新部品1〜2を使用してプロパティ更新を実行します。
共有ACLのプロパティ更新部品1 DwcUpdatePublicACLPropParts1Srv.java 共有ACLのプロパティ更新時のプロパティ入力画面を表示します。DwcUpdatePublicACLPropSrv.javaを介して実行されます。
共有ACLのプロパティ更新部品2 DwcUpdatePublicACLPropParts2Srv.java 共有ACLのプロパティ更新を実行します。DwcUpdatePublicACLPropSrv.javaを介して実行されます。
システム開始・終了 ログイン DwcLoginSrv.java ユーザ認証を行いシステムにログインします。
ログアウト DwcLogOutSrv.java システムからログアウトします。
オブジェクト一覧 フォルダツリー表示 DwcGetFolderTreeSrv.java ルートフォルダを基点としたフォルダツリーを取得します。
フォルダリスト表示 DwcGetFolderContentListSrv.java フォルダ下のオブジェクトの一覧を取得します。
ルートフォルダ一覧 ルートフォルダ一覧表示 DwcGetRootFolderListSrv.java ルートフォルダの一覧を取得します。
検索 全文検索条件指定表示 DwcTextSearchCondSrv.java 全文検索条件指定画面を表示します。
全文検索実行 DwcTextSerchSrv.java 全文検索を実行します。
チェックアウト中文書検索条件指定表示 DwcCheckOutDocSerchCondSrv.java チェックアウト中文書検索条件指定画面を表示します。
チェックアウト中文書検索実行 DwcCheckOutDocSerchSrv.java チェックアウト中文書検索を実行します。
フォルダ検索条件指定表示 DwcFolderSerchCondSrv.java フォルダ検索条件指定画面を表示します。
フォルダ検索実行 DwcFolderSerchSrv.java フォルダ検索を実行します。
共有ACL検索条件指定表示 DwcPublicACLSerchCondSrv.java 共有ACL検索条件指定画面を表示します。
共有ACL検索実行 DwcPublicACLSerchSrv.java 共有ACL検索を実行します。
共有ACL管理 サブジェクト選択表示 DwcSelectSubjectCondSrv.java 共有ACLのサブジェクト選択画面を表示します。
サブジェクト選択 DwcSelectSubjectSrv.java 共有ACLのサブジェクトを選択します。
LDAP検索 ユーザ検索条件指定表示 DwcUserSearchCondSrv.java ユーザ検索条件指定画面を表示します。
ユーザ検索実行 DwcUserSearchSrv.java ユーザ検索を実行します。
グループ・組織内ユーザ検索実行 DwcGroupOrgUserSearchSrv.java グループ・組織内ユーザ検索を実行します。
ユーザ情報表示 DwcGetUserInfoSrv.java ユーザ情報を表示します。
組織検索条件指定表示 DwcOrgSearchCondSrv.java 組織検索条件指定画面を表示します。
組織検索実行 DwcOrgSearchSrv.java 組織検索を実行します。
グループ検索条件指定表示 DwcGroupSearchCondSrv.java グループ検索条件指定画面を表示します。
グループ検索実行 DwcGroupSearchSrv.java グループ検索を実行します。
アクセス権 アクセス権更新 DwcUpdatePermSrv.java アクセス権更新の制御を行います。アクセス権更新部品1〜2を使用してアクセス権更新を実行します。
アクセス権更新部品1 DwcUpdatePermPart1Srv.java アクセス権更新の画面を表示します。DwcUpdatePermSrv.javaを介して実行されます。
アクセス権更新部品2 DwcUpdatePermPart2Srv.java アクセス権を更新します。DwcUpdatePermSrv.javaを介して実行されます。
アクセス権選択(所有者) DwcSelectOwnerSrv.java 所有者選択画面を表示します。
アクセス権選択(グループ・組織) DwcSelectGroupOrgSrv.java グループ選択画面または組織選択画面を表示します。
アクセス権選択(共有ACL) DwcSelectPublicACLSrv.java 共有ACL選択画面を表示します。
スーパークラス コマンドサーブレット DwcCmdSrv.java コマンドサーブレットのスーパークラスです。
検索 DwcSearchSrv.java 検索機能のスーパークラスです。
LDAP検索 DwcLdapSearchSrv.java LDAP検索機能のスーパークラスです。
その他 JSP遷移 DwcNullSrv.java JSPファイルの遷移だけを行います。

(3) APフレームクラス

HttpSessionBindingListenerインターフェースを実装し,HTTPセッションにAPセッションをバインドする機能を持つクラスです。サンプルWebアプリケーションのHTTPセッションの役割をします。APフレームクラスのJavaクラスファイルを次の表に示します。

表6-5 APフレームクラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
APセッション DwcFrame.java HTTPセッションにAPセッションをバインドします。

(4) Webアプリケーション共通情報クラス

サンプルWebアプリケーションで共通の情報を扱うクラスです。HTTPセッション単位の情報を保持するAPフレームクラスを管理します。Webアプリケーション共通情報クラスのJavaクラスファイルを次の表に示します。

表6-6 Webアプリケーション共通情報クラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
Webアプリケーション共通情報管理 DwcApp.java HTTPセッション単位の情報を保持するAPフレームクラスを管理します。

(5) 処理結果クラス

オブジェクト操作に関するサーブレットの処理結果情報を保持するクラスです。処理結果クラスのJavaクラスファイルを次の表に示します。

表6-7 処理結果クラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
エラー情報 DwcErrorNotify.java サーブレットの処理にエラーが発生した場合のエラー情報を保持します。
処理結果情報1 DwcNormalNotify.java サーブレットの処理結果が正常な場合にオブジェクトの情報(オブジェクトタイプ,オブジェクト名)を保持します。
処理結果情報2 DwcNormalNotifyWithID.java サーブレットの処理結果が正常な場合にオブジェクトの情報(オブジェクトタイプ,オブジェクト名,オブジェクトのOIID)を保持します。
処理結果情報のスーパークラス DwcResultNotify.java 処理結果情報のスーパークラスです。

(6) 例外クラス

サンプルWebアプリケーション(Web依存アプリケーションクラス)の例外を扱うクラスです。例外クラスのJavaクラスファイルを次の表に示します。

表6-8 例外クラスのJavaクラスファイル(Web依存アプリケーションクラス)

機能名 Javaクラスファイル名 機能概要
サポート外のリクエストを受け付けた場合の例外 DwcNotSupportedRequestException.java サポートされていないリクエストを受け付けた場合のエラーを表します。

(7) ユティリティクラス

Web依存アプリケーションクラスで使用する部品を提供するクラスです。ユティリティクラスのJavaクラスファイルを次の表に示します。

表6-9 ユティリティクラスのJavaクラスファイル(Web依存アプリケーションクラス)

機能名 Javaクラスファイル名 機能概要
ユティリティを提供 DwcWUtil.java 文字列のエンコード,フィルタリング,スペース除去,フェッチ条件指定,ソート条件取得などの部品を提供します。

(8) 定数定義クラス

定数を定義するクラスです。定数定義クラスのJavaクラスファイルを次の表に示します。

表6-10 定数定義クラスのJavaクラスファイル(Web依存アプリケーションクラス)

機能名 Javaクラスファイル名 機能概要
サーブレット定数定義 DwcSrvDef.java サーブレットで使用する定数を定義します。
リクエストパラメタ定数 DwcParamDef.java リクエストパラメタを定義します。

(9) リクエストパラメタクラス

リクエストパラメタを扱うクラスです。リクエストパラメタクラスのJavaクラスファイルを次の表に示します。

表6-11 リクエストパラメタクラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
リクエストパラメタを扱うインターフェース DwcRequest.java リクエストパラメタを扱うインターフェースです。
通常のリクエストパラメタを扱う DwcNormalRequest.java リクエストパラメタを取得します。
マルチパーツ(LIST型)を含むリクエストパラメタを扱う DwcMultiPartRequest.java マルチパーツ(LIST型)を含むリクエストパラメタを取得します。
マルチパーツリクエスト用部品 DwcMultiPartRequestReader.java マルチパーツ(LIST型)リクエストを読み込みます。

(10) メッセージクラス

メッセージを定義するクラスです。メッセージクラスのJavaクラスファイルを次の表に示します。

表6-12 メッセージクラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
メッセージ定義 DwcSrvMsgDef.java サーブレットで使用するメッセージを定義します。

(11) プロパティ情報クラス

プロパティ情報を扱うクラスです。プロパティ情報クラスのJavaクラスファイルを次の表に示します。

表6-13 プロパティ情報クラスのJavaクラスファイル

機能名 Javaクラスファイル名 機能概要
プロパティ情報を扱う DwcOperateDataProps.java リクエストパラメタで指定されたプロパティ名称や画面遷移の引き継ぎに使用するプロパティ情報などを保持するメソッドを提供します。