Sm@rtDBのREST APIに関する設定
Sm@rtDB の REST APIを使用するにあたり関連する設定項目について記載します。本章に記載している設定を有効にする場合は、Tomcatの再起動が必要となります。
default.xml設定
本ファイルは標準の設定の場合、以下のパスに存在します。
/etc/hibiki/
default.xmlでのREST APIの設定
| ファイル | default.xml | ||
| 親要素 | hibiki.rest | ||
| 要素 | 名称 | 既定値 | 説明 |
| enable | true | 最上位の設定、Sm@rtDBのRESTサービスの全体の使用可否設定。 | |
| basic-auth-scope | /rest/1,/rest/2,/rest/custom | 認証が必要なURLパスをカンマ区切りで記載します。この設定に記載されたURLパスは、SSL＋Basic認証が必要となります。（/rest/2/ のパスは自動的に設定に含まれます。） | |
| authority-check | true |
RestAPI権限チェックのスイッチ
true・・・権限チェックが有効 false・・・権限チェックが無効 |
|
| 親要素 | hibiki.rest.enable要素 | ||
| 要素 | 名称 | 既定値 | 説明 |
| 1 | true | REST API Ver.1.0.xサービスの使用可否を設定します。 true・・・使用可 false・・・使用不可 | |
| 記述例 |
<hibiki>
<rest> <enable>true</enable> <enable.1>true</enable.1> <basic-auth-scope>/rest/1,/rest/2,/rest/custom</basic-auth-scope> <authority-check>false</authority-check> </rest> </hibiki> |
||
添付ファイルのデータを格納する一時領域のファイル削除に関する設定
Sm@rtDBのREST APIを利用し、画像部品やファイルフォルダ部品にファイルを登録する場合に、一旦、Sm@rtDB APサーバにファイルを格納します。格納した領域にあるファイルを自動で削除する時間や、間隔を設定できます。
REST APIで利用する一時領域の削除設定
| ファイル | default.xml | ||
| 親要素 | hibiki.rest. delete-temp-file | ||
| 要素 | 名称 | 既定値 | 説明 |
| enable | false | 文書の画像/ファイルフォルダ部品に添付する為に、Sm@rtDB APサーバ側にアップロードした一次ファイルを定期的に削除するための機能の使用可否設定です。 true・・・定期削除する。 false・・・定期削除しない。 既定値はfalse（定期削除しない）です。 |
|
| 要素 | 名称 | 既定値 | 説明 |
| cron-expression | 0 0/60 * * * ? | クライアントアプリ側で文書の画像/ファイルフォルダ部品に添付する為にアップロードした一時ファイルを定期的に削除するための設定項目です。既定値は毎時1回実行する設定となります。
Sm@rtDBのREST APIではファイルを添付する動作を行う場合、一時的に仮セッションのbase-directory/tmp/restに格納します。（ファイル添付についての詳細は「REST API DOC添付ファイル追加」をご参照ください）
この一時ファイルは、クライアントアプリ側で削除処理を実装しないかぎり、仮セッションのbase-directory配下に残ったままとなってしまいます。本設定を適用することで、定期的にこれらの一時ファイルの削除が実施できます。 ※設定値は（秒 分 時 日 月 年）となります。 ※既定値では、毎時1回動作する設定になっています。 【例】 毎日0時に動作する設定の場合 |
|
| 記述例 | <hibiki> <api> <delete-temp-file> <cron-expression>0 0 0 * ?</cron-expression> </delete-temp-file> </api> </hibiki> | ||
文書一覧表示時に取得する文書数の上限値設定
Sm@rtDBのREST APIを利用し、文書一覧を表示する際に、1回のSQL文発行で取得する文書数の上限値を設定できます。
文書一覧取得時に取得する文書数の設定
| ファイル | default.xml | ||
| 親要素 | hibiki.api | ||
| 要素 | 名称 | 既定値 | 説明 |
| batch-size | 100 | REST APIを利用して文書一覧を表示する際、1回のSQL文発行で取得する文書数の上限を設定します。REST APIで指定した上限（limit）より小さい場合は、繰返し、データ取得のSQL文を発行します。 ※本設定値は今後のバージョンにおいて、別のAPIでも使用される可能性があります。 | |
| 記述例 | <hibiki> <api> <batch-size>300</batch-size> </api> </hibiki> | ||
認証に関する設定
Sm@rtDBのREST APIを使う場合に、SSL通信を必要とするかどうかを設定できます。
認証に関する設定値
| ファイル | default.xml | ||
| 親要素 | hibiki.rest.basic-auth | ||
| 名称 | 既定値 | 説明 | |
| enable-insecure | true |
SSL通信の要否の設定項目です。 true・・・REST APIでSSL通信を必要としない false・・・REST APIでSSL通信を必須とする。 既定値はtrue（SSL通信を必要としない）です。 |
|
| 記述例 |
<hibiki>
<rest> <basic-auth> <enable-insecure>false</enable-insecure> </basic-auth> </rest> </hibiki> |
||
Sm@rtDBのREST APIでログイン処理を行わず、INSUITEのCookie情報を認証に使用する場合は、下記の設定をhibiki.xmlに追加する必要があります。本設定については『Sm@rtDB 運用ガイド』に詳細が記載されていますので、参照してください。
Sm@rtDBのREST APIでのログイン処理の詳細に関しては「REST DOC」をご参照ください。
INSUITEのCookie情報を使うかどうかの設定
| ファイル | hibiki.xml | ||
| 属性 | "name"属性 | "value"属性 | 説明 |
| useInsuiteSSO | true | INSUITE®とのSSOの際にリダイレクトを使用するかどうかの設定。 REST APIの認証処理でINSUITEのCookie情報を使用する場合、trueに設定します。 |
|
| 記述例 |
<itsukushima> <property name="useInsuiteSSO" value="true"/> </itsukushima> |
||