OData サーバを設定する方法

データベース接続パラメータ、Embedded HTTP サーバオプション、OData プロデューサオプションを設定ファイルに設定します。OData サーバを起動したら、コマンドラインでこのファイルを指定します。

Embedded HTTP サーバオプション

次の Embedded HTTP サーバオプションを設定ファイルで指定できます。

オプション	説明
LogFile = path-and-filename	Embedded HTTP サーバが OData プロデューサの出力をロギングするパスとファイル名を指定します。デフォルトの動作では、ロギングが無効になります。パスは、サーバの実行プログラムの場所に対する相対パスです。
LogVerbosity = { 1 \| 2 \| 3 \| 4 }	ログの冗長性レベルを指定します。冗長性レベルが高い場合、追加情報がロギングされ、すべてのレベルで提供される情報が含まれます。冗長性レベル 1 は、予期しないエラーに関する情報を出力します。冗長性レベル 2 は、一般的な情報と設定メッセージを出力します。冗長性レベル 3 は、HTTP 要求に関する詳細な情報を出力します。冗長性レベル 4 は、デバッグメッセージを出力します。
ServerPort = port-number	Embedded HTTP サーバが受信するポート番号を指定します。デフォルト設定値は 80 です。
ShutdownListenerPort = port-number	Embedded HTTP サーバがシャットダウン要求を受信するポート番号を指定します。デフォルト設定値は 2449 です。
SSLKeyStore = path-and-filename	Embedded HTTP サーバがトラフィックを暗号化するために使用する SSL 証明書が含まれる Java Key Store キーストアに、パスとファイル名を指定します。このオプションが指定されている場合、SSL が有効になり、暗号化されていない HTTP トラフィックがブロックされます。パスは、サーバの実行プログラムの場所に対する相対パスです。
SSLKeyStorePassword = SSLKeyStore-password	SSLKeyStore オプションによって識別された Java キーストアに対して認証するために Embedded HTTP サーバが使用するパスワードを指定します。

OData プロデューサオプションとデータベース接続パラメータ設定

次の OData プロデューサオプションと接続パラメータ設定は、設定ファイルで指定できます。

オプション	説明
Authentication = { none \| database }	データベースに接続するためのクレデンシャルを指定します。デフォルト設定の database は、各ユーザが DbConnectionString オプションに追加されるパーソナル化クレデンシャルで接続し、独自の完全なデータベース接続文字列を形成することを示します。これらのクレデンシャルは、HTTP 基本認証を使用して要求されます。 none 設定は、すべてのユーザが DbConnectionString オプションによって示される同じ接続文字列を使用して接続することを示します。
ConnectionPoolMaximum = num-max-connections	OData プロデューサが接続プールで使用するために開き続ける同時接続の最大数を示します。少ない接続は、サーバの負荷に応じて、接続プールによって使用されます。デフォルトでは、接続プールのサイズは、データベースサーバによって許可される同時接続の最大数によって制限されています。
DbConnectionString = connection-string	データベースに接続するための接続文字列を指定します。認証オプションがデータベースに設定されている場合、接続文字列では UID および PWD パラメータを除外する必要があります。
DbProduct = sqlanywhere	OData プロデューサが接続するデータベースサーバのタイプを示します。
PageSize = num-max-entities	次のリンクを発行する前に、取得エンティティセット応答に含めるエンティティの最大数を指定します。デフォルト設定値は 100 です。
Model = path-and-filename	OData メタデータでどのテーブルとビューを公開するかを示す OData プロデューサのサービスモデルを含む OData Service Definition Language (OSDL) ファイルのパスとファイル名を指定します。デフォルトの動作では、テーブルとビューをユーザ権限に基づいて公開します。プライマリキーのないテーブルとビューは公開されません。パスは、サーバの実行プログラムの場所に対する相対パスです。
ModelConnectionString = connection-string	OData プロデューサが起動中に OSDL ファイルを検証するために使用する接続文字列を指定します。 OSDL の検証では、エンリストされているテーブルとカラムが存在すること、キーリストが適切に使用されていること、ファイルがセマンティック上正しいことを確認します。接続文字列には、UID および PWD パラメータが含まれている必要があります。デフォルトの動作では、OSDL ファイルが有効であることを前提にしています。
ReadOnly = { true \| false }	変更要求を無視するかどうかを示します。デフォルト設定は false です。
ServiceRoot = / path-prefix	OData サーバで OData サービスのルートを指定します。デフォルト設定は /odata です。この OData プロデューサのすべてのリソースには、次のフォーマットの URI を使用してアクセスします。 scheme:host:port/path-prefix/resource-path[query-options] 例：http://services.odata.org/OData/OData.svc/Category(1)/Products?$top=2&$orderby=name

参照

例

次の例は、OData サーバで使用する設定ファイルをフォーマットする方法について説明します。

# Embedded HTTP server options
# ----------------------------
LogFile = ../../odata.log
LogVerbosity = 1
ServerPort = 8000
ShutdownListenerPort = 8083
SSLKeyStore = ../../samplekeystore.jks
SSLKeyStorePassword = pwd

# OData Producer options
# ----------------------
Authentication = none
ConnectionPoolMaximum = 10
DbProduct = sqlanywhere
Model = ../../model.osdl
ModelConnectionString = uid=dba;pwd=sql;eng=orderentry;dbf=orderentry.db
PageSize = 100
ReadOnly = false
ServiceRoot = /odata/MyProducer

# Database connection parameters
# ------------------------------
DbConnectionString = uid=dba;pwd=sql;eng=orderentry;dbf=orderentry.db

ファイルを server.properties で保存し、次のコマンドを実行して、その設定ファイルで指定されたオプションで OData サーバを起動します。

dbosrv16 server.properties

DocCommentXchange で意見交換できます