Symfoware Analytics Server(Operational Data Store編) アプリケーション開発ガイド

2.1 Java APIの概要

Java APIとは、API連携機能の提供するJava言語のAPIで、Java言語で作成したアプリケーションからIISのデータを抽出するためのインタフェースです。

提供するAPIのメソッド一覧を以下に示します。

表2.1 APIのメソッド一覧

項番	分類	クラス名	メソッド名	説明
1	コンストラクタ	IisAPI	IisAPI	本APIのコンストラクタ
2	環境設定	IisAPI	setRequestorHostName	制御サーバセットのホスト名の設定
3		IisAPI	setRequestorPortNo	制御サーバセットのポート番号設定
4		IisAPI	setCategoryName	カテゴリ名の設定
5		IisAPI	setTargetClassName	実行クラス名の設定
6		IisAPI	setTargetFileType	データ形式の設定
7		IisAPI	setSkipChar	検索対象外文字の変更
8		IisAPI	setSeparateChar	ワード検索区切り文字の変更
9		IisAPI	setRequestID	依頼IDの設定
10		IisAPI	setANKmix	半角英字大小区別の設定
11		IisAPI	setKNJmix	全角英字大小区別の設定
12		IisAPI	setLabelLine	CSVヘッダレコードの出力の有無を設定
13		IisAPI	setTimeout	最大応答待ち時間の設定
14	抽出	IisAPI	requestSelect	抽出実行
15		IisAPI	getDataCount	抽出結果件数の取得
16		IisAPI	deleteInstance	抽出結果情報の破棄
17	抽出結果出力	IisAPI	openData	抽出結果情報のオープン
18		IisAPI	readData	抽出結果情報の読込み
19		IisAPI	readDataEx	抽出結果情報の読込み
20		IisSelectedData	getRecordData	レコードの取得
21		IisSelectedData	getStoredFileID	蓄積データファイル識別IDの取得
22		IisAPI	getAttachedFile	蓄積添付ファイルの取得
23		IisAPI	closeData	抽出結果情報のクローズ
24		IisAPI	outputResultFile	抽出結果ファイルの出力
25	エラー取得	IisAPI	getLastError	エラー詳細番号の取得
26		IisAPI	getLastErrorMessage	エラーメッセージの取得

エラーが発生した場合、コンストラクタ以外のメソッドは例外を投げません。エラー情報は戻り値として返却します。

参照

Java APIの詳細については、“Java APIリファレンス”を参照してください。

API連携機能のメモリ見積り式については、“導入ガイド”の“IISクライアントセットのメモリ見積もり式”を参照してください。