HCP-SDK概要

HCP-SDKのAPIリファレンスです。

HCPシステムの概要とSDKの位置づけを説明するドキュメントは、{@link jp.ac.nii.hcp.client "HCP-SDK概要"}にあります。
HCP-SDKを利用したコーディングの手引きは、{@link jp.ac.nii.hcp.client.core "HCP-SDK クイックスタート"}を参照してください。

SDKの利用法

HCPシステムと接続して処理を行うSDKは、hcp-client.jarという.jarファイルとして提供されます。 このファイルにクラスパスを通すことで、SDKの提供する機能を利用したJavaプログラムの開発と実行を行えます。 また、SDKは内部的に複数のJavaライブラリを利用しているため、同様にこれらのファイルにクラスパスを通す必要があります。 これらのクラスパスの設定を行うことで、、システムに対するソフトウェアやミドルウェアのインストールを行うことなくSDKの全ての機能を利用可能です。

SDKの利用するライブラリ

  1. Jerseyクライアントライブラリ SunのプロジェクトであるJerseyの提供するHTTP接続を実行するライブラリです。 SDKからリポジトリへの通信に利用します。なお、リポジトリはJerseyのサーバサイドフレームワークを利用して開発されています。
  2. Jersey OAuthクライアントライブラリ Jerseyプロジェクトの一つとしてOAuth認証を行うためのライブラリです。 JerseyクライアントライブラリにOAuthの機能を追加することができます。
  3. SQLiteライブラリ ファイル型RDBのSQLiteを利用するためのライブラリです。 JDBCの仕様に従うインタフェースを持ち、SQLクエリによるデータ操作が行えます。 ワークスペース内のデータ操作に利用しています。
  4. HCP共有ライブラリ SDKとリポジトリや画像URIサーバなどのHCPアプリケーションで共通して利用するクラスを実装したライブラリです。 hcp-client.jarとは別のjarファイルとして、データモデルクラスなどのクラスファイルを持ちます。
  5. ロギングライブラリ HCP共有ライブラリが内部的に必要とするロギング用のライブラリです。 なお、SDKはログの出力は行いません。

開発環境へのSDKの追加

コンパイルを行う際に、javacの-cpオプション(-classpath)に、SDKのjarファイルと上記のjarファイルのパスを追加してください。 また、実行時も同様にjavaコマンドの-cpオプションに追加してください。 開発にEclipseを利用する場合は、プロジェクトのビルドパスにこれらのファイルを追加することで、 SDKの機能の実装、コンパイルとデバッグを実行できます。