![[目次]](figure/content.gif)
uCosminexus DocumentBroker Version 3 クラスライブラリ Java サンプルWebアプリケーション
![[用語]](figure/gloss.gif)
![[索引]](figure/index.gif)
![[前へ]](figure/front.gif)
![[次へ]](figure/after.gif)
コアアプリケーションクラスのJavaクラスファイルの格納先を次に示します。
/opt/HiEDMS/client/java/sample/websamplesrc/jp/co/Hitachi/soft/docbroker/sampleAPP/core
<インストールディレクトリ>\java\sample\websample\src\jp\co\Hitachi\soft\docbroker\sampleAPP\core
コアアプリケーションクラスには，次に示すクラスが含まれています。
アプリケーションに共通な情報を管理するクラスです。オブジェクトモデル（文書管理モデル）に関する情報，LDAPアクセス関連の情報などを保持します。アプリケーション情報クラスのJavaクラスファイルを次の表に示します。
表6-14 アプリケーション情報クラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| アプリケーション全体に共通な情報を管理する | DwcCoreApp.java | オブジェクトモデル（文書管理モデル）に関する情報，LDAPアクセス関連の情報などを保持します。 |
| コンテキストパラメタの内容を保持する | DwcAppParams.java | 配置ディスクリプタ（web.xml）の コンテキストパラメタのパラメタ名とキーを対で保持します。 |
| 文書管理モデルを保持する | DwcModelMap.java | 配置ディスクリプタ（web.xml）の コンテキストパラメタの指定に基づく文書管理モデルを保持します。 |
| リソース情報を取得するインターフェース | DwcGetResource.java | サーブレットコンテキストからリソースの情報を取得するためのインターフェースです。 |
APセッションを扱うクラスです。DocBroセッションの確立，切断，トランザクションの開始，確定，取り消しを行います。また，ログインユーザのユーザ情報や，トークン，ソートパラメタ，ワークディレクトリ情報などのAPセッション内での共有情報を保持します。セッションクラスのJavaクラスファイルを次の表に示します。
表6-15 セッションクラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| APセッションを扱う | DwcSession.java | DocBroセッションの確立・切断，およびトランザクションの開始・確定・取り消しを行います。 |
| ワークディレクトリを管理する | DwcDir.java | ファイルのダウンロード時やアップロード時に使用する作業用のディレクトリを管理します。 |
| アプリケーション情報にアクセスする | DwcIFrame.java | アプリケーションのセッション情報，コンテキストパラメタ情報を管理しているフレームにアクセスするためのインターフェースです。 |
| APセッションごとのトークンを管理する | DwcTokenMap.java | APセッション内で誤って同じ操作を連続して実行するのを防ぐためにトークンを管理します。 |
| トランザクションを制御する | DwcTran.java | トランザクションの開始・確定・取り消しを行います。 |
オブジェクトを扱うクラスです。オブジェクトクラスのJavaクラスファイルを次の表に示します。
表6-16 オブジェクトクラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| オブジェクトのスーパークラス | DwcCmnObj.java | オブジェクト共通の処理を行います。 |
| 文書オブジェクトを扱う | DwcDocObj.java | 文書オブジェクトの作成・削除，チェックイン・チェックアウトなどの操作を行います。 |
| フォルダオブジェクトを扱う | DwcFolderObj.java | フォルダオブジェクトの作成・削除，下位オブジェクトの一覧取得などの操作を行います。 |
| ルートフォルダオブジェクトを扱う | DwcRootFolderObj.java | ルートフォルダの作成・削除，一覧取得などの操作を行います。 |
| 共有ACLオブジェクトを扱う | DwcPubObj.java | 共有ACLオブジェクトの作成・削除などの操作を行います。 |
LDAP対応のディレクトリサービスにアクセスするためのクラスです。LDAPアクセスクラスのJavaクラスファイルを次の表に示します。
表6-17 LDAPアクセスクラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| LDAP検索を行う | DwcLdapImpl.java | LDAPにアクセスして指定された情報を取得します。 |
| LDAPアクセスデータをキャッシュする | DwcLdapCacheManager.java | LDAPアクセスデータをキャッシュに保持します。 |
| LDAPデータキャッシュ | DwcCacheData.java | LDAP検索条件と取得データを保持します。 |
| LDAP検索を行うインターフェース | DwcLdap.java | LDAPから指定された情報を取得するためのインターフェースです。 |
フォルダを扱うためのクラスです。フォルダを扱うクラスのJavaクラスファイルを次の表に示します。
表6-18 フォルダを扱うクラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| フォルダツリーを扱う | DwcFolderTree.java | 各フォルダをノードとしたツリー構造で管理します。 |
| フォルダツリーの各ノードを扱う | DwcFolderNode.java | フォルダノードの開閉状態やプロパティ値などを保持します。 |
| フォルダパスを扱う | DwcFolderPath.java | 表示用のフォルダのパスを取得します。 |
| 表示用のフォルダツリーを扱う | DwcDispFolderTree.java | 表示用のフォルダノードをリストで管理します。 |
| 表示用フォルダツリーの各ノードを扱う | DwcDispFolderNode.java | 表示用にフォルダの開閉状態やプロパティを保持します。 |
| 表示用フォルダパスを扱う | DwcDispFolderPath.java | 表示用のフォルダパスを構成する情報を保持します。 |
| ルートフォルダを検索する | DwcRootFolderSearch.java | ルートフォルダを検索し，一覧を取得します。 |
検索を行うためのクラスです。検索クラスのJavaクラスファイルを次の表に示します。
表6-19 検索クラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| 検索条件に関する情報を扱う | DwcSearchInfo.java | edmSQL文，検索対象テーブル名，？パラメタリスト， 検索対象タイプ（文書検索，フォルダ検索，チェックアウト中文書検索，共有ACL検索）を保持します。 |
| edmSQLの組み立て部品 | DwcQnode.java | edmSQL文を組み立てるための部品を提供します。 |
| 検索結果取得情報を扱う | DwcFetchInfo.java | 検索結果の取得開始位置，取得件数，最大取得件数などを保持します。 |
| ?パラメタを扱う | DwcQParam.java | ?パラメタとプロパティ情報を保持します。 |
検索結果をソートするためのクラスです。コンパレータクラスのJavaクラスファイルを次の表に示します。
表6-20 コンパレータクラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| 検索結果のコンパレータ | DwcResComp.java | 検索結果DbjResultSetをソートするためのコンパレータです。 |
| フォルダ一覧表示用のコンパレータ | DwcFolderContComp.java | フォルダ一覧をソートするためのコンパレータです。 |
| LDAP取得データ用のコンパレータ | DwcLdapResComp.java | LDAP取得データをソートするためのコンパレータです。 |
| バージョン一覧用のコンパレータ | DwcVerListComp.java | バージョン一覧をソートするためのコンパレータです。 |
プロパティに関するデータを扱うクラスです。プロパティデータクラスのJavaクラスファイルを次の表に示します。
表6-21 プロパティデータクラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| プロパティに関するデータを扱う | DwcDataOfSetProp.java | 文書，フォルダ，および共有ACLに定義されているプロパティに関するデータを扱うDbjPropSetインターフェースとそれ以外のデータをプロパティとして扱う場合のDbjPropSetインターフェースを保持します。 |
| 表示用プロパティを扱う | DwcDispList.java | DbjPropSetやDbjVerObjListインターフェースなどを要素として表示用プロパティを取得します。 |
コアアプリケーションクラスで使用する部品を提供するクラスです。ユティリティクラスのJavaクラスファイルを次の表に示します。
表6-22 ユティリティクラスのJavaクラスファイル（コアアプリケーションクラス）
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| ユティリティを提供 | DwcUtil.java | 日時変換，文字列操作，オブジェクトタイプチェックなどの部品を提供します。 |
コアアプリケーションクラスで使用する定数を定義するクラスです。定数定義クラスのJavaクラスファイルを次の表に示します。
表6-23 定数定義クラスのJavaクラスファイル（コアアプリケーションクラス）
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| コアアプリケーションクラスで使用する定数を定義する | DwcDef.java | コアアプリケーションクラスで使用する定数を定義します。 |
サンプルWebアプリケーション（コアアプリケーションクラス）の例外クラスです。例外クラスのJavaクラスファイルを次の表に示します。
表6-24 例外クラスのJavaクラスファイル（コアアプリケーションクラス）
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| サンプルWebアプリケーションで用いる例外のスーパークラス | DwcException.java | サンプルWebアプリケーションで用いる例外のスーパークラスです。 |
| 日付内容不正時の例外 | DwcDateFmtException.java | 日付指定の内容不正の例外です。 |
| 不完全日付指定例外 | DwcIncompleteDateException.java | 日付指定の不完全例外です。 |
| 日付順序不正の例外 | DwcInvalidOrderDateException.java | 日付を範囲指定する場合の順序不正の例外です。 |
| 文書管理モデルのモデル操作違反の例外 | DwcModelViolationException.java | サンプルWebアプリケーションでサポートしている文書管理モデルのモデル操作違反の例外です。 |
| サポート外のオブジェクト例外 | DwcNotSupportedObjectException.java | サンプルWebアプリケーションでサポートしていないオブジェクトを扱った場合の例外です。 |
| ルートフォルダが存在しない場合の例外 | DwcRootFolderNotFoundException.java | ルートフォルダが存在しない場合の例外です。 |
| 空でないフォルダ削除時の例外 | DwcFolderNotEmptyException.java | 下位に文書またはフォルダが格納されているフォルダを削除しようとした時の例外です。 |
サンプルWebアプリケーションの内部エラー例外クラスです。内部エラー例外クラスのJavaクラスファイルを次の表に示します。
表6-25 内部エラー例外クラスのJavaクラスファイル
| 機能名 | Javaクラスファイル名 | 機能概要 |
|---|---|---|
| サンプルWebアプリケーション内部エラー例外 | DwcInternalError.java | サンプルWebアプリケーション内部エラー例外のクラスです。 |
All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.