Cosminexus　リファレンス　API編

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

はじめに

このマニュアルは，Cosminexus（コズミネクサス）のアプリケーション開発で使用するAPI／タグライブラリについて説明したものです。

Cosminexusでは，次に示すプログラムプロダクトを使用してアプリケーションサーバを構築，運用します。なお，これらのプログラムプロダクトを使用して構築したシステムを，Cosminexusシステムといいます。

このマニュアルでは，これらのプログラムプロダクトの構成ソフトウェアのうち，次に示す構成ソフトウェアの機能で使用するファイルについて説明しています。

なお，オペレーティングシステム（OS）の種類によって，機能が異なる場合があります。OSごとの違いがある場合の表記方法については，「適用OSの違いによる機能相違点の表記」を参照してください。

対象読者

このマニュアルは，Cosminexusが提供するAPIまたはタグライブラリを使用してアプリケーションを開発する方を対象としています。

なお，次の内容を理解されていることを前提としています。

また，このマニュアルは，マニュアル「Cosminexus　機能解説」を理解していることを前提としていますので，あらかじめお読みいただくことをお勧めします。

マニュアルの構成

このマニュアルは，次に示す章から構成されています。

第1章　APIとタグライブラリの概要
Cosminexusで使用するAPIとタグライブラリの種類，およびこのマニュアルでの記述形式について説明しています。

第2章　統合ユーザ管理フレームワークで使用するAPI
統合ユーザ管理フレームワークで使用するAPIおよび例外クラスについて説明しています。

第3章　統合ユーザ管理フレームワークで使用するタグライブラリ
統合ユーザ管理フレームワークで使用するJSPタグライブラリについて説明しています。

第4章　EJBクライアントアプリケーションで使用するAPI
EJBクライアントアプリケーションで使用するAPIおよび例外クラスについて説明しています。

第5章　ユーザログ機能で使用するAPI
ユーザログ機能で使用するAPIについて説明しています。

第6章　性能解析トレースで使用するAPI
性能解析トレースのルートアプリケーション情報取得機能で使用するAPIについて説明しています。

第7章　監査ログ出力で使用するAPI
J2EEアプリケーションまたはバッチアプリケーションで監査ログを出力する場合に使用するAPIについて説明しています。

第8章　JavaVMで使用するAPI
JavaVMで使用するAPIについて説明しています。

第9章　Cosminexus DABroker Libraryで使用するAPI
Cosminexus DABroker Libraryで使用するJDBCインタフェースおよびAPIについて説明しています。

第10章　Cosminexusが対応しているアノテーションおよびDependency Injection
Cosminexusが対応しているアノテーションおよびDependency Injectionについて説明しています。

第11章　アプリケーション開発時に使用できるプロパティ
アプリケーションを開発するときに使用できるプロパティについて説明しています。

関連マニュアル

Cosminexusのマニュアル体系について，次の図に示します。

[図データ]

マニュアル体系図で示した関連マニュアルについて，それぞれの位置づけを次に示します。

Cosminexus　概説
Cosminexusの製品概要について説明しています。

Cosminexus　機能解説
Cosminexus Component Containerの機能を中心に，uCosminexus Application Serverの概要と提供する機能について説明しています。

Cosminexus　システム設計ガイド
システム設計時に，システムの目的に応じたシステム構成や運用方法を検討するための指針について説明しています。また，チューニングの方法についても説明しています。

Cosminexus　簡易構築・運用ガイド
セットアップウィザードおよびSmart Composer機能を使用して，システムを構築・運用する手順について説明しています。また，セットアップウィザードおよびSmart Composer機能が提供するコマンドやファイルについても説明しています。

Cosminexus　システム構築ガイド
システム構築時に必要な機能の設定方法について説明しています。

Cosminexus　システム運用ガイド
Cosminexusを使用したシステムの運用方法のうち，Smart Composer機能を使用する運用以外の方法について説明しています。

Cosminexus　アプリケーション設定操作ガイド
Cosminexus Component Containerのサーバ管理コマンド，およびServer Plug-inを使用した操作について説明しています。

Cosminexus　運用管理操作ガイド
Cosminexus Component Containerの運用管理ポータルの使用方法について説明しています。

Cosminexus　リファレンス　コマンド編
Cosminexusのシステムを構築・運用するときに使用するコマンドについて説明しています。

Cosminexus　リファレンス　定義編
Cosminexusのシステムを構築・運用するとき，またはアプリケーションを開発するときに，使用するファイルの形式について説明しています。

Cosminexus　メッセージ 1　KAWS／KDAL／KDJE編，Cosminexus　メッセージ 2　KEOS／KEUC／KFCB編，Cosminexus　メッセージ 3　KFCT／KFDB／KFDJ編
Cosminexusで出力されるメッセージについて説明しています。

Hitachi Web Server
Hitachi Web Server（Webサーバ）の構築，管理方法について説明しています。

TPBroker　ユーザーズガイド
Cosminexus TPBrokerの概要，機能，運用方法について説明しています。

Cosminexus Reliable Messaging
Cosminexus RMを使用したメッセージの非同期通信によるアプリケーションの連携方法について説明しています。

Cosminexus　アプリケーション開発ガイド
構築したCosminexusのシステムで動作させる，アプリケーションの開発方法について説明しています。

また，マニュアル体系図に示したマニュアル以外で，このマニュアルと関連するマニュアルを次に示します。必要に応じてお読みください。

なお，このマニュアルでは，次のマニュアルについて，対象OSおよびバージョン番号を省略して表記しています。マニュアルの正式名称とこのマニュアルでの表記を次の表に示します。

正式名称 このマニュアルでの表記
スケーラブルデータベースサーバ HiRDB Version 8 UAP開発ガイド HiRDB UAP開発ガイド
スケーラブルデータベースサーバ HiRDB Version 7 UAP開発ガイド（UNIX(R)/Windows(R)用）
スケーラブルデータベースサーバ HiRDB Version 8 SQLリファレンス HiRDB SQLリファレンス
スケーラブルデータベースサーバ HiRDB Version 7 SQLリファレンス（UNIX(R)/Windows(R)用）

マニュアル体系の変更について

07-00では，06-70のマニュアル「Cosminexus Version 6　リファレンス（Windows(R)用）（3020-3-E56）」と「Cosminexus Version 6　リファレンス（UNIX(R)用）（3000-3-987）」の内容を3分冊して，マニュアル体系を変更しました。

目次構成の対応は次のようになっています。

06-70のマニュアル 07-00以降のマニュアル
第1編　コマンド マニュアル「Cosminexus　リファレンス　コマンド編」へ移動
第2編　ファイル マニュアル「Cosminexus　リファレンス　定義編」へ移動
第3編　オプション マニュアル「Cosminexus　リファレンス　定義編」へ移動
第4編　API／タグライブラリ マニュアル「Cosminexus　リファレンス　API編」へ移動
付録A　ログ出力のデフォルトの設定 削除
付録B　TPBrokerの運用支援機能用定義ファイル 削除
付録C　Naming Manager定義ファイル 削除
付録D　拡張MIBオブジェクト定義ファイル マニュアル「Cosminexus　リファレンス　定義編」へ移動
付録E　CMPのマッピング一覧 削除
付録F　Webアプリケーション用DD（web.xml） マニュアル「Cosminexus　リファレンス　定義編」へ移動
付録G　csecanalyzコマンドによるシステムのセキュリティ設定のチェック内容 削除
付録H　dabsetup（Cosminexus DABroker Libraryのセットアップ）※ マニュアル「Cosminexus　リファレンス　コマンド編」へ移動

注※
マニュアル「Cosminexus Version 6　リファレンス（UNIX(R)用）」だけにある目次項目です。

ご利用製品ごとの用語の読み替えについて

ご利用の製品によっては，マニュアルで使用している用語を，ご利用の製品名に読み替える必要があります。

次の表に従って，マニュアルで使用している用語をご利用の製品名に読み替えてください。

ご利用の製品名 マニュアルで使用している用語
uCosminexus Developer Professional※1 Application ServerおよびApplication Server Enterprise
uCosminexus Developer Standard※1※2 Application Server
uCosminexus Service Architect※1 Application ServerおよびApplication Server Enterprise
uCosminexus Service Platform

注※1　テスト環境で使用している場合にだけ読み替えが必要です。

注※2　uCosminexus Developer StandardとApplication Serverには一部機能差があります。機能差については，マニュアル「Cosminexus　アプリケーション開発ガイド」のDeveloper Standard使用時の注意事項に関する説明を参照してください。

このマニュアルでの表記

このマニュアルで使用する表記と，対応する製品名を次に示します。

表記 製品名
Application Server Application Server Enterprise uCosminexus Application Server Enterprise
Application Server Standard uCosminexus Application Server Standard
Developer Developer Professional uCosminexus Developer Professional
Developer Standard uCosminexus Developer Standard
HiRDBまたはHiRDBサーバ HiRDB/Parallel Server HiRDB/Parallel Server Version 7
HiRDB/Parallel Server Version 8
HiRDB/Single Server HiRDB/Single Server Version 7
HiRDB/Single Server Version 8
HiRDB Run TimeまたはHiRDBクライアント HiRDB/Run Time Version 7
HiRDB/Run Time Version 8
IPF Itanium(R) Processor Family
Oracle Oracle9i Oracle9i
Oracle9i R2
Oracle10g Oracle 10g
Oracle 10g R2
SQL Server SQL Server 2000 Microsoft(R) SQL Server(TM) 2000
SQL Server 2005 Microsoft(R) SQL Server(TM) 2005
SQL ServerのJDBCドライバ SQL Server 2000 Driver for JDBC Microsoft(R) SQL Server(TM) 2000 Driver for JDBC
SQL Server 2005 JDBC Driver Microsoft(R) SQL Server(TM) 2005 JDBC Driver
UNIX AIX AIX 5L V5.2
AIX 5L V5.3
HP-UX HP-UX（IPF） HP-UX 11i V2（IPF）
HP-UX 11i V3（IPF）
Linux Linux（IPF） Red Hat Enterprise Linux AS 3（IPF）
Red Hat Enterprise Linux AS 4（IPF）
Red Hat Enterprise Linux 5 Advanced Platform（Intel Itanium）
Linux（x86／AMD64 & Intel EM64T） Red Hat Enterprise Linux AS 3（x86）
Red Hat Enterprise Linux AS 4（x86）
Red Hat Enterprise Linux 5 Advanced Platform（x86）
Red Hat Enterprise Linux ES 3（x86）
Red Hat Enterprise Linux ES 4（x86）
Red Hat Enterprise Linux 5（x86）
Red Hat Enterprise Linux AS 3（AMD64 & Intel EM64T）
Red Hat Enterprise Linux AS 4（AMD64 & Intel EM64T）
Red Hat Enterprise Linux 5 Advanced Platform（AMD/Intel 64）
Red Hat Enterprise Linux ES 3（AMD64 & Intel EM64T）
Red Hat Enterprise Linux ES 4（AMD64 & Intel EM64T）
Red Hat Enterprise Linux 5（AMD/Intel 64）
Solaris Solaris 9
Solaris 10
Web Redirector uCosminexus Web Redirector
Windows Server 2003 Windows Server 2003 Enterprise Edition Microsoft(R) Windows Server(R) 2003，Enterprise Edition Operating System（x86）
Windows Server 2003 Standard Edition Microsoft(R) Windows Server(R) 2003，Standard Edition Operating System（x86）
Windows Server 2003 R2 Windows Server 2003 R2 Enterprise Edition Microsoft(R) Windows Server(R) 2003 R2，Enterprise Edition Operating System（x86）
Windows Server 2003 R2 Standard Edition Microsoft(R) Windows Server(R) 2003 R2，Standard Edition Operating System（x86）
Windows Server 2003（x64） Windows Server 2003 Enterprise x64 Edition Microsoft(R) Windows Server(R) 2003，Enterprise x64 Edition Operating System
Windows Server 2003 Standard x64 Edition Microsoft(R) Windows Server(R) 2003，Standard x64 Edition Operating System
Windows Server 2003 R2（x64） Windows Server 2003 R2 Enterprise x64 Edition Microsoft(R) Windows Server(R) 2003 R2，Enterprise x64 Edition Operating System
Windows Server 2003 R2 Standard x64 Edition Microsoft(R) Windows Server(R) 2003 R2，Standard x64 Edition Operating System
Windows Vista Windows Vista Business Microsoft(R) Windows Vista(R) Business
Windows Vista Enterprise Microsoft(R) Windows Vista(R) Enterprise
Windows Vista Ultimate Microsoft(R) Windows Vista(R) Ultimate
Windows XP Microsoft(R) Windows(R) XP Professional Operating System
XDM/RD E2 VOS3 XDM/RD E2

なお，Windows Server 2003，Windows Server 2003 R2，Windows Server 2003（x64），Windows Server 2003 R2（x64），Windows Vista，およびWindows XPを総称してWindowsと表記することがあります。

このマニュアルで使用している表記と，対応するCosminexusの機能名を次に示します。

表記 Cosminexusの機能名
Cosminexus Developer's Kit for Java Cosminexus Developer's Kit for JavaTM
Cosminexus RM Cosminexus Reliable Messaging
CTM Cosminexus Component Transaction Monitor
DB Connector for Cosminexus RM DB Connector for Cosminexus Reliable Messaging
Management Server Cosminexus Management Server
PRF Cosminexus Performance Tracer
Server Plug-in Cosminexus Server Plug-in
Smart Composer Cosminexus Smart Composer

このマニュアルで使用している表記と，対応するJava関連用語を次に示します。

表記 Java関連用語
DI Dependency Injection
EAR Enterprise ARchive
EJBまたはEnterprise JavaBeans Enterprise JavaBeansTM
EJB QL EJBTM Query Language
J2EEまたはJava 2 Platform, Enterprise Edition JavaTM 2 Platform, Enterprise Edition
J2SE JavaTM 2 Platform, Standard Edition
JAAS JavaTM Authentication and Authorization Service
JAR JavaTM Archive
Java JavaTM
Java 2 Runtime Environment, Standard Edition JavaTM 2 Runtime Environment, Standard Edition
Java 2 SDK, Standard Edition JavaTM 2 Software Development Kit, Standard Edition
JavaBeans JavaBeansTM
JavaMail JavaMailTM
JAXP JavaTM API for XML Processing
JCA J2EETM Connector Architecture
JCE JavaTM Cryptography Extension
JDBC JDBCTM
JavaTM Database Connectivity
JDK JavaTM Development Kit
JNDI Java Naming and Directory InterfaceTM
JNI JavaTM Native Interface
JSF JavaServerTM Faces Reference Implementation (RI) Version: 1.1_01 FCS
JSP JavaServer PagesTM
JTA JavaTM Transaction API
JTS JavaTM Transaction Service
Servletまたはサーブレット JavaTM Servlet
WAR Web ARchive

適用OSの違いによる機能相違点の表記

このマニュアルは，適用OSがWindows，AIX，HP-UX，Linux，およびSolarisの製品に対応します。OSによって記述を書き分ける場合，次に示す表記を使用して，それぞれの説明にOS名を明記しています。

表記 意味
Windowsの場合 Windowsに該当する表記です。
AIXの場合 AIXに該当する表記です。
HP-UXの場合 HP-UXに該当する表記です。
Linuxの場合 Linuxに該当する表記です。
Solarisの場合 Solarisに該当する表記です。
UNIXの場合 UNIX（AIX，HP-UX，Linux，Solaris）に該当する表記です。

このマニュアルで使用している略語

このマニュアルで使用している英略語を次に示します。

英略語 英字での表記
API Application Programming Interface
ASCII American Standard Code for Information Interchange
BMP Bean-Managed Persistence
BMT Bean-Managed Transaction
CA Certification Authority
CMP Container-Managed Persistence
CMR Container-Managed Relationship
CMT Container-Managed Transaction
CORBA Common Object Request Broker Architecture
CPU Central Processing Unit
CR Carriage Return
CRL Certificate Revocation List
CSR Certificate Signing Request
CSV Comma Separated Value
CUI Character User Interface
DB Database
DBMS Database Management System
DD Deployment Descriptor
DIT Directory Information Tree
DMZ Demilitarized Zone
DN Distinguished Name
DNS Domain Name System
DoS Denial of Service attack
DTD Document Type Definition
EIS Enterprise Information System
EJB QL EJB Query Language
EUC Extended UNIX Code
FF Form Feed
GC Garbage Collection
GUI Graphical User Interface
HTML Hyper Text Markup Language
HTTP Hyper Text Transfer Protocol
HTTPS Hyper Text Transfer Protocol Security
IDE Integrated Development Environment
IIOP Internet Inter-Orb Protocol
ISAPI Internet Server Application Programming Interface
ISO International Organization for Standardization
JAR Java Archive
JDBC Java Database Connectivity
JIS Japanese Industrial Standards
LAN Local Area Network
LDAP Lightweight Directory Access Protocol
LDIF LDAP Data Interchange Format
LF Line Feed
MDA Model Driven Architecture
MIB Management Information Base
OID Object Identifier
OMG Object Management Group
ORB Object Request Broker
OS Operating System
OTS Object Transaction Service
PIM Platform Independent Model
POA Portable Object Adapter
PSM Platform Specific Model
RAC Real Application Clusters
RDB Relational Database
RMI Remote Method Invocation
RPC Remote Procedure Call
SFO Session Fail Over
SHA Secure Hash Algorithm
SOA Service Oriented Architecture
SOAP Simple Object Access Protocol
SPI Service Provider Interface
SPP Service Providing Program
SSL Secure Sockets Layer
TCS Transaction Context Server
UDDI Universal Description, Discovery and Integration
UML Unified Modeling Language
UNC Universal Naming Convention
URI Uniform Resource Identifier
URL Uniform Resource Locator
UTC Universal Time Coordinated
UTF UCS Transformation Format
VM Virtual Machine
WSDL Web Service Description Language
XML Extensible Markup Language

このマニュアルで使用している記号

このマニュアルで使用する記号について次に示します。

記号 意　味
　｜ 横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。
（例）　A｜B
　AまたはBを指定することを示します。
{ 　 } この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。
（例）　｛A｜B｜C｝
　A，BまたはCのどれかを指定することを示します。
［　］ この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛ ｝と同じくどれか一つを選択します。
（例１）　［A］
　「何も指定しない」か「Aを指定する」ことを示します。
（例２）　［B｜C］
　「何も指定しない」か「BまたはCを指定する」ことを示します。
… 記述が省略されていることを示します。
（例）　ABC…
　ABCの後ろに記述があり，その記述が省略されていることを示します。
<　> この記号で囲まれている項目は，該当する要素を指定することを示します。
（例）　<プロパティ>
　プロパティを記述します。
　... この記号の直前に示す記号を繰り返し，複数個指定できることを示します。
（例）　<プロパティ>...
　プロパティは複数個，繰り返して指定できます。

このマニュアルで使用している構文要素

このマニュアルで使用する構文要素の種類を次に示します。

種類 定義
英字 A〜Z　a〜z
英小文字 a〜z
英大文字 A〜Z
数字 0〜9
英数字 A〜Z　a〜z　0〜9
記号 !　"　#　$　%　&　'　(　)　+　,　_　・　.　/　:　;　<　=　>　@　[　]　^　−　｛　｝　￣　タブ　空白

注　すべて半角文字を使用してください。


常用漢字以外の漢字の使用について

このマニュアルでは，常用漢字を使用することを基本としていますが，次に示す用語については，常用漢字以外の漢字を使用しています。

鍵（かぎ）　個所（かしょ）　必須（ひっす）

KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）は，それぞれ1,024バイト，1,0242バイト，1,0243バイト，1,0244バイトです。

[目次][前へ][次へ]

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2006, 2007, Hitachi, Ltd.