1 Oracle REST Data Servicesのインストール

この項では、Oracle REST Data Servicesをインストールおよびデプロイする方法について説明します。(RESTはRepresentational State Transferの略です。)

注意:

Oracle REST Data Servicesは、リリース2.0.6の前はOracle Application Express Listenerと呼ばれていました。

トピック:

• Oracle REST Data Servicesについて

• インストール・プロセスの理解

• Oracle REST Data Servicesの構成およびインストール

• スタンドアロン・モードでの実行

• Oracle WebLogic Serverへのデプロイ

• Apache Tomcatへのデプロイ

• Oracle REST Data Servicesのアップグレード

• Bequeath接続を使用したOracle REST Data Servicesのインストール、アップグレード、検証またはアンインストール

1.1 Oracle REST Data Servicesについて

Oracle REST Data Servicesは、Oracle HTTP Serverおよびmod_plsqlのかわりとなるJava EEベースのサービスです。Java EEの実装では、コマンドライン・ベースの設定、セキュリティの強化、ファイル・キャッシュおよびRESTful Webサービスなどの豊富な機能が提供されます。また、Oracle REST Data Servicesでは、Oracle WebLogic Server、Apache Tomcatおよびスタンドアロン・モードを使用したデプロイをサポートすることで、高い柔​​軟性が提供されます。

Oracle Application Expressアーキテクチャでは、WebブラウザとOracle Application Expressエンジンとの間でリクエストを代理するため、なんらかの形態のWebサーバーが必要です。Oracle REST Data Servicesは、この要件を満たしていますが、Oracle Application Express構成の範囲を超えて使用されています。Oracle REST Data Servicesでは、埋込のJDBCドライバを使用して接続が提供され、Oracleホームが必要ないため、デプロイ・プロセスが単純です。

1.2 インストール・プロセスの理解

この項では、Oracle REST Data Servicesの概要を説明し、サポートされるJavaプラットフォーム、Enterprise Edition(Java EE)アプリケーション・サーバー、およびシステム要件についての情報を提供します。

トピック:

• サポートされるJava EEアプリケーション・サーバー

• システム要件

1.2.1 サポートされるJava EEアプリケーション・サーバー

Oracle REST Data Servicesでは、次のJava EEアプリケーション・サーバーがサポートされます。

アプリケーション・サーバー	サポートされているリリース
Oracle WebLogic Server	12g リリース2 (12.2.1.3)以上
Apache Tomcat	リリース8.5以上

1.2.2 システム要件

Oracle REST Data Servicesのシステムの要件は次のとおりです。

• Oracle Database (Enterprise Edition、Standard EditionまたはStandard Edition One)リリース11gリリース2以上またはOracle Database 11gリリース2 Express Edition。

• Oracle Java 8以上。

• Webブラウザの要件:

  • Microsoft Internet Explorer 8.0以上。

  • Mozilla Firefox 3.0以上。

  • Google Chrome 2.0以上。

注意:

Oracle Application ExpressはOracle REST Data Servicesを使用するための前提条件ではありません。

Oracle Application Expressがインストールされ、インストール時にRESTfulサービスが構成されている場合(『Oracle Application Expressインストレーション・ガイド』のRESTfulサービスの構成のステップを参照)は、Oracle Applicationで定義されたRESTfulサービスの実行を含め、Oracle REST Data Servicesはそれをサポートします。

1.2.3 Oracle REST Data Servicesのインストールについて

Oracle REST Data Servicesをインストールするには、次の手順を実行します。

1. Oracle REST Data Servicesをダウンロード、インストールおよび構成します。

2. Oracle REST Data Servicesをデプロイします。デプロイ・オプションには次のものがあります。

   • スタンドアロン・モード。

   • Oracle WebLogic Server。

   • Apache Tomcat。

1.3 Oracle REST Data Servicesの構成およびインストール

Oracle REST Data Servicesをデプロイする前に、コマンドライン・インタフェースを使用してそれをインストールおよび構成する必要があります。

トピック:

• コマンドライン・インタフェースの使用について

• Oracle REST Data Servicesで使用されるデータベース・ユーザーについて

• Oracle REST Data Servicesに必要な権限

• Oracle REST Data Servicesのダウンロード、構成およびインストール

• SQL Developerを使用したOracle REST Data Servicesの管理(オプション)

• 非HTTPS環境でOAuth2の使用

関連項目:

JSONデータの永続にOracle REST APIを使用する場合は、Oracle REST APIもインストールする必要があります。詳細は、『Oracle REST Data Services SODA for REST開発者ガイド』のOracle REST APIのインストールに関する項を参照してください。

1.3.1 コマンドライン・インタフェースの使用について

Oracle REST Data Servicesでは、いくつかのコマンドライン・コマンドが提供されています。たとえば、Oracle REST Data Servicesの構成ファイルを保存する場所を構成でき、Oracle REST Data Servicesで使用するデータベースを構成でき、Oracle REST Data Servicesをスタンドアロン・モードで開始できます。

利用可能なコマンドの完全なリストを表示するには、ords.warファイルが保存されているディレクトリまたはフォルダに移動し、次のコマンドを実行します。

java -jar ords.war help

使用可能なコマンドのリストが表示されます。各コマンドの使用方法の説明を表示するには、次のように「help」に続けてコマンド名を入力します。

java -jar ords.war help configdir

1.3.2 Oracle REST Data Servicesで使用されるデータベース・ユーザーについて

Oracle REST Data Servicesでは、次のデータベース・ユーザーが使用されます。

ユーザー名	必須かどうか	説明
APEX_PUBLIC_USER	Oracle Application ExpressでOracle REST Data Servicesを使用している場合のみ	Oracle Application ExpressとともにOracle REST Data Servicesを使用する場合、すべてのOracle Application Express操作など、PL/SQLゲートウェイ操作の起動に使用されるデータベース・ユーザーです。 APEX_PUBLIC_USERのロック解除の詳細は、『Oracle Application Expressインストレーション・ガイド』のAPEX_PUBLIC_USERアカウントの構成の項を参照してください。
APEX_REST_PUBLIC_USER	バージョン5.0以上のApplication Expressで定義されているRESTfulサービスを使用する場合のみです。	Application Expressのワークスペースに定義されているRESTfulサービスにアクセスする場合に、Oracle Application ExpressのRESTfulサービスの呼出しに使用されるデータベース・ユーザーです。
APEX_LISTENER	バージョン5.0以上のApplication Expressで定義されているRESTfulサービスを使用する場合のみです。	Application Expressのワークスペースに定義されているRESTfulサービスにアクセスする場合に、Oracle Application Expressに格納されているRESTfulサービス定義の問合せに使用されるデータベース・ユーザーです。
ORDS_METADATA	はい	Oracle REST Data Servicesの多くの機能の実装に使用されるPL/SQLパッケージの所有者です。ORDS_METADATAには、Oracle REST Data Services対応のスキーマのメタデータが格納されます。 Oracle REST Data Servicesから直接このメタデータにアクセスすることはなく、Oracle REST Data ServicesアプリケーションはORDS_METADATAスキーマへの接続を作成することはありません。スキーマ・パスワードはランダムな文字列に設定され、接続権限は削除、パスワードの有効期限は期限切れです。
ORDS_PUBLIC_USER	はい	Oracle REST Data Services対応のスキーマでRESTfulサービスを呼び出すためのユーザーです。

APEX_<xxx>ユーザーは、Oracle Application Expressのインストール・プロセスの中で作成されます。

1.3.3 Oracle REST Data Servicesに必要な権限

Oracle REST Data Servicesインストールの一部として、次のような権限が複数のユーザーに付与されます。

• PUBLICには、多くのORDS_METADATA表およびビューのSELECT権限が付与されます。

• PUBLICには、ユーザーの起動できるPL/SQLパッケージのEXECUTE権限が付与されます。

• 次のパッケージにPUBLICに対するEXECUTE権限が付与されていない場合、ORDS_METADATAには、そのパッケージのEXECUTE権限が付与されます。

  • SYS.DBMS_ASSERT

  • SYS.DBMS_LOB

  • SYS.DBMS_OUTPUT

  • SYS.DBMS_SCHEDULER

  • SYS.DBMS_SESSION

  • SYS.DBMS_UTILITY

  • SYS.DEFAULT_JOB_CLASS

  • SYS.HTP

  • SYS.OWA

  • SYS.WPG_DOCLOAD

• 次のビューにPUBLICに対するSELECT権限またはREAD権限が付与されていない場合、ORDS_METADATAには、そのビューのSELECT権限(11g)またはREAD権限(12c以上)が付与されます。
  • SYS.SESSION_PRIVS
• ORDS_METADATAには、次のパッケージのEXECUTE権限が付与されます。

  • SYS.DBMS_CRYPTO

  • SYS.DBMS_METADATA

• ORDS_METADATAには、次のビューのSELECT権限(11g)またはREAD権限(12c以上)が付与されます。

  • SYS.DBA_OBJECTS

  • SYS.DBA_ROLE_PRIVS

  • SYS.DBA_TAB_COLUMNS

• ORDS_METADATAには、次のビューのWITH GRANT OPTIONを含むSELECT権限が付与されます。

  • SYS.USER_CONS_COLUMNS

  • SYS.USER_CONSTRAINTS

  • SYS.USER_OBJECTS

  • SYS.USER_PROCEDURES

  • SYS.USER_TAB_COLUMNS

  • SYS.USER_TABLES

  • SYS.USER_VIEWS

• ORDS_METADATAには、次のシステム権限が付与されます。

  • ALTER USER

  • CREATE ANY TRIGGER

  • CREATE JOB

  • CREATE PUBLIC SYNONYM

  • DROP PUBLIC SYNONYM

• ORDS_METADATAには、Application ExpressのRESTデータをORDS_METADATA表に移行するために必要なオブジェクト権限が付与されます。

1.3.4 Oracle REST Data Servicesのダウンロード、構成およびインストール

このトピックの手順は、従来の(非CDB)データベースにOracle REST Data Servicesをインストール場合に適用されます。

注意:

アプリケーション・サーバーにデプロイする前に、この項の構成ステップを完了する必要があります。

Oracle REST Data Servicesをインストールおよび構成するには、次の手順を実行します。

1. Oracle REST Data Servicesのダウンロード・ページからords.version.number.zipファイルをダウンロードします。

   ファイル名のversion.numberに現在のリリース番号が反映されることに注意してください。

2. ダウンロードしたZIPファイルを任意のディレクトリ(フォルダ)に解凍します。

   • UNIXおよびLinuxの場合: ords.version.number.zipを解凍します。

   • Windowsの場合: Windowsエクスプローラでords.version.number.zipファイルをダブルクリックします。

3. 次のインストール・オプションのいずれかを選択します。

   • コマンドライン・プロンプトを使用した拡張インストール

   • パラメータ・ファイルを使用したサイレント・インストール

4. Oracle REST Data Servicesは、必要に応じて再インストールまたはアンインストールできます。

関連項目:

Oracle REST Data Servicesのダウンロード

1.3.4.1 ORDSインストーラの権限スクリプト

この項では、ORDSをインストール、アップグレード、検証およびアンインストールする権限をユーザーに付与するスクリプト・ファイルについて説明します。

注意:

このスクリプトは、SYS AS SYSDBAを使用せずに、Oracle PDBまたはOracle 11gでORDSをインストール、アップグレード、検証およびアンインストールする場合に使用します。

ORDS 19.2リリース以降では、Oracle REST Data Servicesインストール・アーカイブ・ファイルのインストーラ・フォルダに、ords_installer_privileges.sqlスクリプトが含まれています。このスクリプトは、Oracleプラガブル・データベースまたはOracle 11gでORDSをインストール、アップグレード、検証およびアンインストールする権限を割り当てられたデータベース・ユーザーに付与します。

次のステップを実行します。

1. SQLclまたはSQL*Plusを使用して、SYSDBA権限でOracle PDBまたは11gデータベースに接続します。
2. データベース・ユーザーを指定して次のスクリプトを実行します。

   SQL> @/path/to/installer/ords_installer_privileges.sql exampleuser
   SQL> exit

ORDSをインストール、アップグレード、検証およびアンインストールするには、指定されたデータベース・ユーザーを使用する必要があります。

1.3.4.2 コマンドライン・プロンプトを使用した拡張インストール

拡張インストールを実行すると、必要なパラメータ値の入力を求めるプロンプトが表示されます。

拡張インストールを実行するには、次のコマンドを入力します。

java -jar ords.war install advanced

注意:

TNS接続を使用してORDSをインストールする場合は、tnsnames.oraファイルのあるフォルダを含むoracle.net.tns_adminシステム・プロパティをコマンドラインで指定する必要があります。

TNS接続を使用してインストールを実行するには、次のコマンドを入力します。

java -Doracle.net.tns_admin=/path/to/tnsFolder -jar ords.war install advanced

インストール・コマンドで使用可能な追加のオプションを確認するには、オンライン・ヘルプ・コマンドjava –jar ords.war help installを使用します。

インストール時に、Oracle REST Data Servicesは指定された構成フォルダに構成ファイルがすでに存在するかどうかをチェックします。

• そのフォルダに構成ファイルが存在しない場合は、作成されます。たとえば、defaults.xml、apex_pu.xmlファイルです。

• 以前のリリースの構成ファイルがそのフォルダに存在する場合、Oracle REST Data Servicesは<name>_pu.xmlの有無をチェックします。存在しない場合、ORDS_PUBLIC_USERアカウントのパスワードを入力するよう求めるプロンプトが表示されます。リリース2.0.nの構成ファイル<name>_al.xmlおよび<name>_rt.xmlが存在する場合は、保持されます。(ただし、2.0.nリリースではRESTfulサービスはオプションだったため、構成フォルダにファイルが存在しない可能性もあります。)

• 以前のリリースの構成ファイルが複数存在し(例: apex.xml、apex_al.xml、apex_rt.xml、sales.xml、sales_al.xml、sales_rt.xml、…)、<name>_pu.xmlが存在しない場合は、データベース構成を選択し、Oracle REST Data Servicesスキーマをそのデータベースで作成できるようにするように求められます。

次に拡張インストールの例を示します。この例では、Enter 1 if you wish to start in standalone mode or 2 to exit [1]に対してデフォルト値の1を受け入れると、残りのプロンプトが表示され、Oracle Application Expressを使用する場合はAPEX static resources locationを指定する必要があります。

d:\ords> java -jar ords.war install advanced

This Oracle REST Data Services instance has not yet been configured.
Please complete the following prompts

Enter the location to store configuration data: /path/to/config

Specify the database connection type to use.
Enter number for [1] Basic  [2] TNS  [3] Custom URL [1]:
Enter the name of the database server [localhost]:
Enter the database listen port [1521]:
Enter 1 to specify the database service name, or 2 to specify the database SID [1]:
Enter the database service name:orcl
Enter 1 if you want to verify/install Oracle REST Data Services schema or 2 to skip this step [1]:
Enter the database password for ORDS_PUBLIC_USER:
Confirm password:
Requires to login with administrator privileges to verify Oracle REST Data Services schema.

Enter the administrator username:EXAMPLEUSER
Enter the database password for EXAMPLEUSER:
Confirm password:
Connecting to database user: EXAMPLEUSER url: jdbc:oracle:thin:@//localhost:1521/orcl

Retrieving information.
Enter the default tablespace for ORDS_METADATA [SYSAUX]:
Enter the temporary tablespace for ORDS_METADATA [TEMP]:
Enter the default tablespace for ORDS_PUBLIC_USER [USERS]:
Enter the temporary tablespace for ORDS_PUBLIC_USER [TEMP]:
Enter 1 if you want to use PL/SQL Gateway or 2 to skip this step.
If using Oracle Application Express or migrating from mod_plsql then you must enter 1 [1]:
Enter the PL/SQL Gateway database user name [APEX_PUBLIC_USER]:
Enter the database password for APEX_PUBLIC_USER:
Confirm password:
Enter 1 to specify passwords for Application Express RESTful Services database users (APEX_LISTENER, APEX_REST_PUBLIC_USER) or 2 to skip this step [1]:
Enter the database password for APEX_LISTENER:
Confirm password:
Enter the database password for APEX_REST_PUBLIC_USER:
Confirm password:
Enter a number to select a feature to enable [1] SQL Developer Web [2] REST Enabled SQL [3] None [1]:


Enter 1 if you wish to start in standalone mode or 2 to exit [1]:
Enter the APEX static resources location:/path/to/apex/images
Enter 1 if using HTTP or 2 if using HTTPS [1]:
Enter the HTTP port [8080]:   
OR
Enter 1 if using HTTP or 2 if using HTTPS [1]:2
Enter the HTTPS port [8443]:
Enter the SSL hostname:mysslhost    
Enter 1 to use the self-signed certificate or 2 if you will provide the SSL certificate [1]:

1.3.4.2.1 拡張インストール・プロンプトの説明

この項では、Oracle REST Data Servicesスキーマの拡張インストールを実行中に選択できるオプションを説明します。

表1-1 ORDSのインストールおよび構成の拡張インストール・プロンプト

オプション	説明
This Oracle REST Data Services instance has not yet been configured. Please complete the following prompts Enter the location to store configuration data:/path/to/config	ORDS構成ファイルの場所を指定します。場所が存在しない場合は作成されます。
Specify the database connection type to use. Enter number for [1] Basic [2] TNS [3] Custom URL [1]:	基本接続、TNS接続またはカスタムURL接続を使用する場合に指定します
次の例は、基本接続の例です。
Enter the name of the database server [localhost]:	Oracle Databaseのホスト名を指定します。
Enter the database listen port [1521]:	Oracle Databaseのポートを指定します。
Enter 1 to specify the database service name, or 2 to specify the database SID [1]: Enter the database service name:orcl	オプション1を選択する場合は、Oracle Databaseサービス名を指定します。そうでない場合、オプション2を選択する場合は、Oracle DatabaseのSIDを指定します。
次の例は、TNS接続の例です。
Enter the TNS Network Alias:orcl	TNSネットワーク別名識別子を指定します。
次の例は、カスタムURL接続の例です。
Enter the Custom JDBC URL: jdbc:oracle:thin:@//localhost:1521/orcl	カスタムURLを指定します。
Enter 1 if you want to verify/install Oracle REST Data Services schema or 2 to skip this step [1]: Enter the database password for ORDS_PUBLIC_USER: Confirm password:	Oracle REST Data Servicesスキーマをインストールし、Oracle REST Data Servicesプロキシ・ユーザーORDS_PUBLIC_USERを作成するには、1を指定します。 プロキシ・ユーザーORDS_PUBLIC_USERおよび対応するパスワードを指定します。
Requires to login with administrator privileges to verify Oracle REST Data Services schema. Enter the administrator username:EXAMPLEUSER Enter the database password for EXAMPLEUSER: Confirm password:	ORDSインストーラ権限またはSYS AS SYSDBAアカウントを持つユーザーを指定します。 ユーザーのパスワードを指定します。
Enter the default tablespace for ORDS_METADATA [SYSAUX]: Enter the temporary tablespace for ORDS_METADATA [TEMP]:	Oracle REST Data ServicesスキーマORDS_METADATAのデフォルト表領域および一時表領域を指定します。
Enter the default tablespace for ORDS_PUBLIC_USER [USERS]: Enter the temporary tablespace for ORDS_PUBLIC_USER [TEMP]	Oracle REST Data Servicesプロキシ・ユーザーORDS_PUBLIC_USERのデフォルト表領域および一時表領域を指定します。

表1-2 Application Expressを構成するか、mod_plsqlから移行するためのオプション

オプション	説明
Enter 1 if you want to use PL/SQL Gateway or 2 to skip this step. If using Oracle Application Express or migrating from mod_plsql then you must enter 1 [1]: Enter the PL/SQL Gateway database user name [APEX_PUBLIC_USER]: Confirm password: Enter the database password for APEX_PUBLIC_USER:	次のいずれかを実行できます。 Oracle Application Expressを使用する場合、PL/SQLゲートウェイ・ユーザーAPEX_PUBLIC_USERおよび対応するデータベース・パスワードを指定します。 Oracle mod_plsqlから移行する場合、PL/SQLゲートウェイ・データベースのユーザー名およびデータベースのパスワードを指定します。 Oracle Application Expressを使用するか、Oracle mod_plsqlから移行するかのいずれかでない場合、2を選択してこのステップをスキップします。
Enter 1 to specify passwords for Application Express RESTful Services database user (APEX_LISTENER, APEX_REST_PUBLIC_USER) or 2 to skip this step [1]: Enter the database password for APEX_LISTENER: Confirm password: Enter the database password for APEX_REST_PUBLIC_USER: Confirm password:	PL/SQLゲートウェイ・ユーザーにAPEX_PUBLIC_USERを指定した場合は、Application Express RESTfulサービスの使用を選択できます。 Application Express RESTful Servicesを使用しない場合は、2を指定してこのステップをスキップします。 Application Express 5.0以上の場合、オプション1が必要です。データベース・ユーザーは、Application Expressのインストール・メディアで提供されているスクリプトapex_rest_config.sqlを使用して作成されます。

表1-3 ORDSでの機能の有効化

オプション	説明
Enter a number to select a feature to enable [1] SQL Developer Web [2] REST Enabled SQL [3] None [1]:	SQL Developer Web機能の場合は1を、REST対応SQL機能の場合は2を指定します。 詳細は、「SQL Developer Webへのアクセス」および「REST対応SQLサービス」のドキュメントを参照してください。

表1-4 スタンドアロン・モードで実行するためのオプション

オプション	説明
Enter 1 if you wish to start in standalone mode or 2 to exit [1]:	ORDSにバンドルされているJetty Webサーバーを使用してスタンドアロン・モードで起動するには、1を指定します。
Enter the APEX static resources location:/path/to/apex/images	Application Expressイメージの場所を指定します。PL/SQLゲートウェイ・ユーザーにAPEX_PUBLIC_USERを指定してある場合、このプロンプトが表示されます。
Enter 1 if using HTTP or 2 if using HTTPS [1]: Enter the HTTP port [8080]:	1を選択する場合はHTTPポートを指定します。
OR Enter 1 if using HTTP or 2 if using HTTPS [1]:2 Enter the HTTPS port [8443]: Enter the SSL hostname:mysslhost Enter 1 to use the self-signed certificate or 2 if you will provide the SSL certifi cate [1]:	2を選択する場合はHTTPSポートとSecure Socket Layer(SSL)のホスト名を指定します。 自己署名証明書を使用でき、使用する場合は自己署名証明書が自動的に生成されます。
OR Enter 1 to use the self-signed certificate or 2 if you will provide the SSL certifi cate [1]:2 Enter the path for the SSL Certificate:/path/to/sslcert Enter the path for the SSL Certificates private key:/path/to/sslcertprivatekey	2を選択する場合、SSL証明書のパス、およびSSL証明書の秘密キーのパスを指定します。

1.3.4.3 ORDSパラメータ・ファイル

Oracle REST Data Servicesは、ユーザーが操作しなくても、簡易モードまたはサイレント・モードでインストールできます。

Oracle REST Data Servicesをインストールした場所にあるparams/ords_params.propertiesファイルに指定されているパラメータを使用して、Oracle REST Data Servicesの簡易インストールまたはサイレント・インストールを実行できます。これはデフォルトのOracle REST Data Servicesパラメータ・ファイルです。このファイルを編集し、使用環境や好みを反映してデフォルト値を変更できます。

Oracle REST Data Servicesをインストールした場所にあるparams/ords_params.propertiesファイルに指定されているパラメータを使用して、Oracle REST Data Servicesのインストールを実行できます。これはデフォルトのOracle REST Data Servicesパラメータ・ファイルです。Oracle REST Data Servicesのパラメータ・ファイルは、key=valueの形式のキーまたは値のペアで構成されます。

または、--parameterFileオプションを含めることで、独自のOracle REST Data Servicesパラメータ・ファイルを指定できます。--parameterFileオプションを指定しない場合、デフォルトのOracle REST Data Servicesパラメータ・ファイルが使用されます。

1.3.4.3.1 ORDSパラメータ・ファイルで使用されるパラメータ

この項では、ORDSパラメータ・ファイルで使用されるパラメータを示しています。

トピック:

• データベース接続のパラメータ

• Oracle REST Data Servicesをインストールするためのパラメータ

• CDBにインストールするためのパラメータ

• Application Expressを構成するためのパラメータ

• スタンドアロン・モードで実行するためのパラメータ

• その他のパラメータ

1.3.4.3.1.1 データベース接続のパラメータ

この項では、プロパティ・ファイルで指定する必要があるデータベース接続パラメータを示します。基本、TNSまたはカスタムURL接続を指定できます。

トピック:

• 基本接続のパラメータ
• TNS接続のパラメータ
• カスタムURL接続のパラメータ

1.3.4.3.1.1.1 基本接続のパラメータ

この項では、基本データベース接続のプロパティ・ファイルで指定する必要のあるパラメータを示しています。

基本接続では、db.hostnameおよびdb.portデータベース接続パラメータを指定する必要があります。また、db.servicenameまたはdb.sidのいずれかのパラメータを指定します。Oracle 12.x PDBへのデータベース接続を指定する場合は、db.servicenameパラメータを指定します。

キー	型	説明	例
db.connectionType	文字列	接続タイプを指定します。値はbasicです。	basic
db.hostname	文字列	Oracleデータベースのホスト・システムを指定します。	myhostname
db.port	数値	データベース・リスナーのポートを指定します。	1521
db.servicename	文字列	データベースのネットワーク・サービス名を指定します。	orcl.example.com
db.sid	文字列	データベースの名前を指定します。	orcl

1.3.4.3.1.1.2 TNS接続のパラメータ

この項では、ORDSをインストールするためのTNS接続のパラメータを示しています。

TNS接続を使用してORDSをインストールする場合は、tnsnames.oraファイルのあるフォルダを含むoracle.net.tns_adminシステム・プロパティをコマンドラインで指定する必要があります。そのフォルダにtnsnames.oraファイルが存在する必要があります。次に例を示します。

$ java -Doracle.net.tns_admin=/path/to/tnsFolder -jar ords.war install
    simple

キー	型	説明	例
db.connectionType	文字列	接続タイプを指定します。値はtnsです。	tns
db.tnsDirectory	文字列	tnsnames.oraファイルのあるフォルダを指定します。	/path/to/tnsfolder
db.tnsAliasName	文字列	tnsnames.oraファイルに存在する必要があるtns別名を指定します。	orcl

1.3.4.3.1.1.3 カスタムURL接続のパラメータ

この項では、ORDSをインストールするためのカスタムURL接続のパラメータを示しています。

キー	型	説明	例
db.connectionType	文字列	接続タイプを指定します。値はcustomurlです。	customurl
db.customURL	文字列	カスタムURLを指定します。	jdbc:oracle:thin:@//localhost:1521/orcl
db.tnsAliasName	文字列	tnsnames.oraファイルに存在する必要があるtns別名を指定します。	orcl

1.3.4.3.1.2 Oracle REST Data Servicesをインストールするためのパラメータ

この項では、Oracle REST Data Servicesスキーマをインストールするために必要なパラメータを示します。

Oracle REST Data Servicesスキーマをインストールするには、次のパラメータを指定する必要があります。

• ORDSインストーラ権限を持つ、またはSYS AS SYSDBAアカウントを持つユーザーのユーザー名とパスワード。

• ORDS_PUBLIC_USERのパスワード

• ORDS_METADATAスキーマおよびORDS_PUBLIC_USERの既存のデフォルト表領域と一時表領域

注意:

すべてのデフォルト表領域パラメータおよび一時表領域パラメータがOracle REST Data Servicesのパラメータ・ファイルで省略されている場合、Oracleデータベースのデフォルトの表領域および一時表領域が使用されます。

表1-5 Oracle REST Data Servicesをインストールするためのパラメータ

キー	型	説明	例
rest.services.ords.add	ブール値	Oracle REST Data Servicesスキーマをインストールするかどうかを指定します。この値にはtrueを設定します。 サポートされている値: true false (デフォルト)	true
user.public.password	文字列	ORDS_PUBLIC_USERのパスワードを指定します。	password
schema.tablespace.default	文字列	ORDS_METADATAのデフォルト表領域を指定します。既存のデフォルト表領域を指定します。	SYSAUX
schema.tablespace.temp	文字列	ORDS_METADATAの一時表領域を指定します。既存の一時表領域を指定します。	TEMP
user.tablespace.default	文字列	ORDS_PUBLIC_USERのデフォルト表領域を指定します。既存のデフォルト表領域を指定します。	SYSAUX
user.tablespace.temp	文字列	ORDS_PUBLIC_USERの一時表領域を指定します。既存の一時表領域を指定します。	TEMP
bequeath.connect	ブール値	Bequeath接続に使用するかどうかを指定します。 サポートされている値: true false (デフォルト)	true

1.3.4.3.1.3 SQL Developer Webを有効にするためのパラメータ

この項では、SQL Developer Webを有効にするためのパラメータを示しています。

表1-6 SQL Developer Webを有効にするためのパラメータ

キー	型	説明	例
feature.sdw	文字列	SQL Developer Webが有効かどうかを指定します。 注意: SQL Developer Webを有効にする場合は、restEnabledSql.activeの値もtrueにする必要があります。 デフォルト値はfalseです。	true
restEnabledSql.active	文字列	REST対応SQLが有効かどうかを指定します。 デフォルト値はfalseです。	true

1.3.4.3.1.4 REST対応SQLを有効にするためのパラメータ

この項では、REST対応SQLを有効にするためのパラメータについて説明します。

表1-7 REST対応SQLを有効にするためのパラメータ

キー	型	説明	例
restEnabledSql.active	文字列	REST対応SQLが有効かどうかを指定します。 デフォルト値はfalseです。	true

1.3.4.3.1.5 CDBにインストールするためのパラメータ

この項では、CDBおよびそのすべてのPDBにOracle REST Data Servicesをインストールするために必要なパラメータを示します。

Oracle Database 12.xでは、CDBおよびそのすべてのPDBにOracle REST Data Servicesをインストールできます。

注意:

db.servicenameにCDBサービス名を指定するか、db.sidにsidを指定します。

表1-8 CDBにインストールするためのパラメータ

キー	型	説明	例
pdb.open.asneeded	ブール値	PDBのステータスがクローズまたは読取り専用である場合に、すべてのPDBを読取り/書込みモードでオープンするかどうかを指定します。この値をtrueに設定すると、次のPDBパラメータは無視されます。 pdb.open.readwrite pdb.skip.closed pdb.skip.readonly サポートされている値: true false (デフォルト)	true
pdb.open.readwrite	文字列	ステータスが読取り専用の場合に、読取り/書込みモードでオープンするPDBサービス名のリストを指定します。	PDB1、PDB2、MYPDB
pdb.skip.closed	ブール値	クローズ状態のPDBをスキップするかどうかを指定します。 サポートされている値: true false (デフォルト)	true
pdb.skip.readonly	ブール値	読取り専用ステータスのPDBをスキップするかどうかを指定します。 サポートされている値: true false (デフォルト)	true
pdb.exclude	文字列	インストール時に除外するPDBサービス名のリストを指定します。	PDB3、PDB4、PDB_X

1.3.4.3.1.6 Application Expressを構成するためのパラメータ

この項では、Application Expressを使用するためのパラメータを示します。

表1-9 Application Expressを構成するためのパラメータ

キー	型	説明	例
plsql.gateway.add	ブール値	Oracle REST Data ServicesをApplication Express用に構成するかどうかを指定します。この値をtrueに設定します。 サポートされている値: true false (デフォルト)	true
db.username	文字列	PL/SQLゲートウェイのユーザー名を指定します。Application Expressでは、APEX_PUBLIC_USERを指定する必要があります。	APEX_PUBLIC_USER
db.password	文字列	APEX_PUBLIC_USERのパスワードを指定します。パスワードは、APEX_PUBLIC_USERデータベース・パスワードと一致する必要があります。	password
rest.services.apex.add	ブール値	Oracle REST Data ServicesをApplication Express RESTfulサービス用に構成するかどうかを指定します。 サポートされている値: true false (デフォルト) APEX RESTfulサービスを使用する場合は、この値をtrueに設定します。	true
user.apex.listener.password	文字列	APEX_LISTENERのパスワードを指定します。rest.services.apex.addがtrueに設定されている場合、APEX_LISTENERのパスワードを指定する必要があります。パスワードは、APEX_LISTENERデータベース・パスワードと一致する必要があります。一致しない場合、rest.services.apex.addがfalseに設定されていれば、このパラメータを省略します。	password
user.apex.restpublic.password	文字列	APEX_REST_PUBLIC_USERのパスワードを指定します。rest.services.apex.addがtrueに設定されている場合、APEX_REST_PUBLIC_USERのパスワードを指定する必要があります。パスワードは、APEX_REST_PUBLIC_USERデータベース・パスワードと一致する必要があります。一致しない場合、rest.services.apex.addがfalseに設定されていれば、このパラメータを省略します。	password

例1-1 Application ExpressおよびAPEX RESTfulサービスを構成し、スタンドアロン・モードで実行するためのパラメータ

次の例では、Oracle REST Data Servicesをインストールし、Application ExpressおよびAPEX RESTfulサービス用に構成し、httpを使用してスタンドアロン・モードで実行するためのパラメータを示します。

注意:

パラメータ・ファイル内のパスワードは、インストール時に暗号化されます。暗号化されたパスワードはパラメータ・ファイルに格納されます。たとえば、 user.public.password=@0585904F6C9B442532D5212962835D00C8です。

db.hostname=localhost
db.password=password
db.port=1521
db.servicename=orcl.example.com
db.username=APEX_PUBLIC_USER
plsql.gateway.add=true
rest.services.apex.add=true
rest.services.ords.add=true
schema.tablespace.default=SYSAUX
schema.tablespace.temp=TEMP
standalone.http.port=8080
standalone.mode=true
standalone.static.images=/path/to/images
standalone.use.https=false
user.apex.listener.password=password
user.apex.restpublic.password=password
user.public.password=password
user.tablespace.default=SYSAUX
user.tablespace.temp=TEMP

関連項目:

• APEX_PUBLIC_USERの詳細は、『Oracle Application Expressインストレーション・ガイド』にあるAPEX_PUBLIC_USERアカウントの構成の項を参照してください。

• APEX_LISTENERおよびAPEX_REST_PUBLIC_USERの詳細は、『Oracle Application Expressインストレーション・ガイド』にあるOracle REST Data Servicesを使用したRESTfulサービスの構成の項を参照してください。

1.3.4.3.1.7 スタンドアロン・モードで実行するためのパラメータ

この項では、Oracle REST Data Servicesをスタンドアロン・モードで実行するためのパラメータを示します。

表1-10 スタンドアロン・モードでOracle REST Data Servicesをインストールするためのパラメータ

キー	型	説明	例
standalone.mode	ブール値	Oracle REST Data Servicesに含まれているWebアプリケーション・サーバー(Jetty)を使用するかどうかを示します。 サポートされている値: true false (デフォルト)	true
standalone.http.port	数値	HTTPリスナー・ポートを指定します。	8080
standalone.use.https	ブール値	httpsを使用するかどうかを指定します。	true
standalone.https.port	数値	HTTPSリスナー・ポートを指定します。	8443
standalone.ssl.host	文字列	Secure Socket Layer (SSL)証明書ホスト名を指定します。httpsを使用している場合は、このオプションを指定する必要があります。	mysecurehost
standalone.use.ssl.cert	ブール値	SSL証明書を提供するかどうかを指定します。この値がtrueに設定されている場合、standalone.ssl.cert.pathおよびstandalone.ssl.key.pathを指定する必要があります。	true
standalone.ssl.cert.path	文字列	SSL証明書のパスを指定します。SSL証明書を提供する場合は、証明書の場所を指定する必要があります。	/path/to/ssl/cert
standalone.ssl.key.path	文字列	SSL証明書のキーのパスを指定します。SSL証明書を提供する場合は、証明書のキーの場所を指定する必要があります。	/path/to/ssl/key
standalone.static.images	文字列	Application Expressイメージの場所を指定します。Application Expressを使用している場合、Application Expressイメージの場所を指定します。	/path/to/apex/images

注意:

Microsoft Windowsシステムでは、standalone.static.imagesにApplication Expressの静的イメージの場所を指定する場合、バックスラッシュ(/)をコロンの前に指定し、スラッシュをフォルダのセパレータとして使用します。例: standalone.static.images=d\:/test/apex426/apex/images/

例1-2 httpを使用してスタンドアロン・モードで実行するためのパラメータ

次のコード・スニペットでは、Oracle REST Data Servicesをインストールして、httpを使用してスタンドアロン・モードで実行するために指定するパラメータのリストの例を示します。

db.hostname=localhost
db.port=1521
db.servicename=orcl.example.com
plsql.gateway.add=false
rest.services.apex.add=false
rest.services.ords.add=true
schema.tablespace.default=SYSAUX
schema.tablespace.temp=TEMP
standalone.http.port=8080
standalone.mode=true
standalone.use.https=false
user.public.password=password
user.tablespace.default=SYSAUX
user.tablespace.temp=TEMP

例1-3 httpsを使用し、SSL証明書のパスを指定して、スタンドアロン・モードで実行するためのパラメータ

次のコード・スニペットでは、httpsを使用し、SSL証明書のパスを指定して、スタンドアロン・モードでOracle REST Data Servicesをインストールおよび実行するために指定するパラメータのリストの例を示します。

db.hostname=localhost
db.port=1521
db.servicename=orcl.example.com
plsql.gateway.add=false
rest.services.apex.add=false
rest.services.ords.add=true
schema.tablespace.default=SYSAUX
schema.tablespace.temp=TEMP
standalone.https.port=8443
standalone.mode=true
standalone.ssl.cert.path=/path/to/ssl/cert
standalone.ssl.host=mysecurehost
standalone.ssl.key.path=/path/to/ssl/key
standalone.use.https=true
standalone.use.ssl.cert=true
user.public.password=password
user.tablespace.default=SYSAUX
user.tablespace.temp=TEMP

1.3.4.3.1.8 その他のパラメータ

この項では、その他のパラメータをいくつか示します。

表1-11 その他のパラメータ

キー	型	説明	例
migrate.apex.rest	ブール値	APEX RESTfulサービス定義をOracle REST Data Servicesスキーマに移行するかどうかを指定します。 サポートされている値: true false (デフォルト)	true

1.3.4.4 パラメータ・ファイルを使用した簡易インストール

Oracle REST Data Servicesは、ユーザーが操作しなくても、簡易モードでインストールできます。

ORDSパラメータ・ファイルを使用してOracle REST Data Servicesの簡易インストールを実行できます。簡易インストールでは、必要なパラメータがORDSパラメータ・ファイルに存在しない場合、情報の入力を求めるプロンプトが表示されます。

Oracle REST Data Servicesを簡易モードでインストールするためのコード・スニペットの例を次に示します。

java -jar ords.war install simple
java -jar ords.war install --parameterFile /path/to/my_params.properties simple

java -jar ords.war install
java -jar ords.war install --parameterFile /path/to/my_params.properties

java -jar ords.war

注意:

インストール・コマンドで使用可能な追加のオプションを確認するには、オンライン・ヘルプ・コマンドjava –jar ords.war help installを使用します。

1.3.4.5 パラメータ・ファイルを使用したサイレント・インストール

Oracle REST Data Servicesは、ユーザーが操作しなくても、サイレント・モードでインストールできます。

ORDSパラメータ・ファイルを使用してOracle REST Data Servicesのサイレント・インストールを実行できます。サイレント・インストールでは、必要なパラメータをパラメータ・ファイルに定義する必要があり、定義しないとエラーが発生します。

Oracle REST Data Servicesをサイレント・モードでインストールするためのコード・スニペットの例を次に示します。

java -jar ords.war install --silent
java-jar ords.war install --silent --parameterFile /path/to/my_params.properties

注意:

インストール・コマンドで使用可能な追加のオプションを確認するには、オンライン・ヘルプ・コマンドjava –jar ords.war help installを使用します。

1.3.4.5.1 サイレント・インストールに必要なパラメータ

この項では、Oracle REST Data Servicesをサイレント・モードでインストールするために必要なパラメータについて説明します。

Oracle REST Data Servicesをサイレント・モードでインストールする場合は、必須パラメータをORDSパラメータ・ファイルに定義する必要があります。

パラメータ・グループ	必須パラメータ	説明
データベース接続	パラメータのリストについては、「データベース接続のパラメータ」を参照してください。	基本、TNSまたはカスタムURL接続を指定します。
ORDSのインストール	rest.services.ords.add サポートされている値: true false	rest.services.ords.add=trueの場合、追加のパラメータについては「ORDSパラメータ・ファイルで使用されるパラメータ」の項を参照してください。
Application ExpressまたはPL/SQL Gatewayの構成	plsql.gateway.add サポートされている値: true false	plsql.gateway.add=trueの場合、追加の必須パラメータについては「Application Expressを構成するためのパラメータ」を参照してください。
スタンドアロン・モードでの実行	standalone.mode サポートされている値: true false	standalone.mode=trueの場合、追加の必須パラメータについては「スタンドアロン・モードでOracle REST Data Servicesを実行するためのパラメータ」を参照してください。

1.3.4.6 コマンドラインからのデフォルト構成の変更

この項では、ORDSのデフォルト構成ファイルを更新する方法について説明します。

次のset propertyコマンドを使用してORDSのデフォルト構成ファイルを更新します。

$ java -jar ords.war set-property <property key> <value>

変更を有効にするには、ORDSを再起動する必要があります。

例1-4

機能の有効化の例。

次の例では、既存のdefault.xmlファイルのプロパティを更新してSQL Developer Webを有効にします。

$ java -jar ords.war set-property feature.sdw true
$ java -jar ords.war set-property restEnabledSql.active true

例1-5

次の例では、既存のdefault.xmlファイルのプロパティを更新してREST対応SQLを有効にします。

$ java -jar ords.war set-property restEnabledSql.active true

1.3.4.7 Oracle REST Data Servicesインストールの検証

Oracle REST Data Servicesインストールが有効であることを確認する場合は、ords.warファイルのあるディレクトリまたはフォルダに移動し、validateコマンドを次の形式で入力します。

java -jar ords.war validate [--database <dbname>]

注意:

Oracle REST Data Servicesをインストールするとき、Oracle Application Express (APEX)スキーマの検出が試行され、ビューが作成されます。このビューは、APEXスキーマ内の関連する表をOracle REST Data Servicesスキーマ内の表に結合したものです。APEXの前にOracle REST Data Servicesをインストールする場合、Oracle REST Data ServicesではAPEXスキーマが見つからないため、欠落しているAPEX表のかわりにスタブ・ビューが作成されます。

Oracle REST Data ServicesをAPEXの後にインストールし、Oracle REST Data Servicesから問い合せる必要があるAPEXオブジェクトが必ず存在しているようにすることをお薦めします。Oracle REST Data ServicesをAPEXの前にインストールする場合、validateコマンドを使用して、Oracle REST Data ServicesによるAPEXスキーマに対する問合せを強制的に再構築します。

-databaseを指定する場合、<dbname>はOracle REST Data Services構成ファイルに格納されているプール名です。

ホスト、ポート、SIDまたはサービス名、およびORDSインストーラ権限を持つユーザーまたはSYS AS SYSDBAユーザーの名前とパスワードなど、プール名の構成からは入手できない必要な情報の入力を求められます。

注意:

validateコマンドをCDBに対して実行すると、CDBとそのすべてのPDBが検証されます。

注意:

TNS接続を使用してORDSを検証する場合は、tnsnames.oraファイルのあるフォルダを含むoracle.net.tns_adminシステム・プロパティをコマンドラインで指定する必要があります。

例:

$ java -Doracle.net.tns_admin=/path/to/tnsFolder -jar ords.war validate

1.3.4.8 Oracle REST Data Servicesを再インストールまたはアンインストール(削除)する場合

Oracle REST Data Servicesを再インストールする場合は、まず既存のOracle REST Data Servicesをアンインストールする必要があります。そして、アンインストールの前にはOracle REST Data Servicesが停止していることを確認します。

Oracle REST Data Servicesをアンインストールすると、ORDS_METADATAスキーマ、ORDS_PUBLIC_USERユーザー、およびOracle REST Data Services関連のデータベース・オブジェクト(パブリック・シノニムを含む)がデータベースに存在している場合は、削除されます。Oracle REST Data Servicesをアンインストール(削除)するには、ords.warファイルのあるディレクトリまたはフォルダに移動し、次のようなuninstallコマンドを入力します。

java -jar ords.war uninstall

uninstallにより、いくつかの必要な情報(ホスト、ポート、SIDまたはサービス名、ユーザー名、パスワード)を入力するよう求められます。

関連項目:

Oracle REST Data ServicesをCDBからアンインストールするには、「Oracle REST Data Servicesでのマルチテナント・アーキテクチャの使用」を参照してください。

注意:

TNS接続を使用してORDSをアンインストールする場合は、tnsnames.oraファイルのあるフォルダを含むoracle.net.tns_adminシステム・プロパティをコマンドラインで指定する必要があります。

例:

$ java -Doracle.net.tns_admin=/path/to/tnsFolder -jar ords.war uninstall

1.3.5 SQL Developerを使用したOracle REST Data Servicesの管理(オプション)

この項では、Oracle SQL Developerを使用してOracle REST Data Servicesを管理する方法について説明します。

関連項目:

『Oracle SQL Developerユーザーズ・ガイド』のOracle REST Data Servicesの管理の項を参照してください。

トピック:

• SQL DeveloperのOracle REST Data Services管理について

• 管理者ユーザーの構成

1.3.5.1 SQL DeveloperのOracle REST Data Services管理について

Oracle SQL Developerでは、グラフィカル・ユーザー・インタフェースを使用してOracle REST Data Servicesを管理できます。これらの管理機能をフルに活用するには、SQL Developerのリリース4.1以上を使用する必要があります。Oracle REST Data Services管理のためのSQL Developerの使用はオプションです。

グラフィカル・ユーザー・インタフェースを使用して、データベース接続、JDBC設定、URLマッピング、RESTful接続、セキュリティ(許可されたプロシージャ、ブロックされたプロシージャ、検証ファンクションおよびウイルス・スキャン)、キャッシング、事前/事後処理プロシージャ、環境、およびExcel設定を更新できます。Oracle SQL Developerでは、統計レポート、エラー・レポートおよびログも提供されます。

関連項目:

『Oracle SQL Developerユーザーズ・ガイド』のOracle REST Data Servicesの管理の項を参照してください。

1.3.5.2 管理者ユーザーの構成

SQL Developerを使用してOracle REST Data Servicesを管理する場合は、次のように管理者ユーザーを構成する必要があります。

• 次のコマンドを実行します。

  java -jar ords.war user adminlistener "Listener Administrator"
  

• adminlistenerユーザーのパスワードを入力します。

• adminlistenerユーザーのパスワードを確認します。

• HTTPSを使用せずにOracle REST Data Servicesを使用する場合は、「非HTTPS環境でのOAuth2の使用」のステップに従います。

Oracle REST Data Services構成の取得またはアップロード(あるいはその両方)にSQL Developerを使用する場合は、プロンプトが表示されたら、前述のリストの資格証明を入力します。

1.3.6 非HTTPS環境でOAuth2の使用

RESTfulサービスは、非公開データへのアクセスを制御するOAuth2プロトコルで保護できます。データのスヌーピングを防ぐため、OAuth2では、OAuth2認証プロセスに関与するすべてのリクエストをHTTPSを使用して転送する必要があります。Oracle REST Data Servicesのデフォルトの動作では、OAuth2関連のすべてのリクエストはHTTPSを使用して受信されたことを検証されます。HTTPを介して受信するリクエストへのサービスは拒否され、403 ForbiddenのHTTPステータス・コードが返されます。

このデフォルトの動作は、HTTPSを使用できない環境では次のようにして無効にできます。

1. Oracle REST Data Servicesの構成が保存されているフォルダを検索します。

2. defaults.xmlという名前のファイルを編集します。

3. このファイルの最後にある</properties>タグの直前に次の設定を追加します。

   <entry key="security.verifySSL">false</entry>
   

4. ファイルを保存します。

5. 実行中なら、Oracle REST Data Servicesを再起動します。

この設定の使用は、開発またはテスト環境でのみ適切であることに注意してください。ユーザーの資格証明がクリア・テキストで渡されることになるので、本番環境でこの設定を使用するのは適切ではありません。

注意:

Oracle REST Data Servicesは、構成の変更を行った後に再起動する必要があります。アプリケーションを再起動する方法はアプリケーション・サーバーのマニュアルを参照してください。

1.4 スタンドアロン・モードでの実行

Oracle REST Data ServicesではJava EEアプリケーション・サーバーがサポートされていますが、スタンドアロン・モードで実行するオプションもあります。この項では、Oracle REST Data Servicesをスタンドアロン・モードで実行する方法について説明します。

スタンドアロン・モードは、開発での使用に適しており、本番デプロイでサポートされています。ただし、スタンドアロン・モードの管理機能は、大部分のJava EEアプリケーション・サーバーと比べて最小限であり、環境によっては、本番使用に十分でない場合があります。

トピック:

• スタンドアロン・モードでの起動

• スタンドアロン・モードのサーバーの停止

• 非Application Expressの静的リソースのドキュメント・ルートの構成

1.4.1 スタンドアロン・モードでの起動

スタンドアロン・モードでOracle REST Data Servicesを起動するには、次の手順を実行します。

1. スタンドアロン・モードで起動するには、次のコマンドを実行します。

   java -jar ords.war standalone
   

   まだスタンドアロン構成を完了していない場合は、完了するように求められます。

   ヒント:

   スタンドアロン・モードのオプションのヘルプを表示するには、次のコマンドを実行します。

   java -jar ords.war help standalone
   

   注意:

   セキュアなアクセスを必要とするRESTfulサービスを使用する場合には、HTTPSを使用する必要があります。

2. プロンプトが表示されたら、Oracle REST Data Servicesが使用するOracle Application Expressの静的リソースを含むフォルダの場所を指定するか、場所を指定しない場合は[Enter]を押します。
3. プロンプトが表示されたら、Oracle REST Data Servicesによって自己署名証明書が自動生成されるようにするか、自分の証明書を指定するかを選択します。自分の証明書を使用する場合は、プロンプトが表示されたら、証明書およびDERエンコードされた関連の秘密キーのパスを指定します。

   秘密キーをDERにまだ変換していない場合は、ここで値を入力する前に、「DERへの秘密キーの変換(LinuxおよびUNIX)」を参照してください。

   これらの値は、スタンドアロン・モードの初回起動時にのみ入力を求められます。

   注意:

   選択したポートで他のサーバーがリスニングしていないことを確認してください。デフォルトのポート8080は、通常、埋込みのPL/SQLゲートウェイを含むHTTPまたはアプリケーション・サーバーによって使用されます。デフォルトのセキュア・ポート8443は、通常、HTTPSによって使用されます。

1.4.1.1 DERへの秘密キーの変換(LinuxおよびUNIX)

通常、秘密キーおよび証明書署名リクエストを作成してから、署名証明書を取得します。秘密キーは、Oracle REST Data Servicesで適切に読み取れるようにDERに変換する必要があります。

たとえば、OpenSSLツールを使用して次のいずれかのようなコマンドで、元の秘密キーを作成したとします。

openssl req -new -newkey rsa:2048 -nodes -keyout yourdomain.key -out yourdomain.csr

または

openssl genrsa -out private.em 2048

この場合、次のようなコマンドを実行して秘密キーを変換し、暗号化を解除する必要があります。openssl pkcs8 -topk8 -inform PEM -outform DER -in yourdomain.key -out yourdomain.der -nocrypt

openssl pkcs8 -topk8 -inform PEM -outform DER -in yourdomain.key -out yourdomain.der -nocrypt

そのようにすると、Oracle REST Data Servicesでプロンプトが表示されたときにyourdomain.derへのパスを含めることも、conf/ords/standalone/standalone.propertiesの次のエントリを変更することもできます。

ssl.cert=<path to yourdomain.crt>
ssl.cert.key=<path to yourdomain.der>
ssl.host=yourdomain

また、jetty.secure.portが必ず設定されます。

1.4.2 スタンドアロン・モードのサーバーの停止

スタンドアロン・モードのOracle REST Data Servicesサーバーを停止するには、コマンド・プロンプトで[Ctrl+C]を押します。

1.4.3 非Application Expressの静的リソースのドキュメント・ルートの構成

Application Expressの静的リソースで予約された/iフォルダ以外の静的リソースをデプロイするためにスタンドアロン・モードのドキュメント・ルートを構成できます。

構成するには、次の例に示すように、--doc-rootパラメータをスタンドアロン・モード・コマンドで指定します。

java -jar ords.war standalone --doc-root /var/www/html

前述の例では、http://server:port/の下の/var/www/htmlにあるすべてのリソースを使用できるようにします。たとえば、ファイル/var/www/html/hello.txtが存在する場合、http://server:port/hello.txtでアクセス可能です。

--doc-rootに指定された値は、standalone.doc.rootプロパティの${config.dir}/ords/standalone/standalone.propertiesに格納されます。カスタム・ドキュメント・ルートが--doc-rootを使用して指定されていない場合、${config.dir}/ords/standalone/doc_rootのデフォルトのdoc-root値が使用されます。このフォルダに格納されているすべてのフォルダはルート・コンテキストで使用できます。

このアプローチには、次の機能および考慮事項があります。

• HTMLリソースはファイル拡張子なしでアドレス可能です。たとえば、hello.htmlという名前のファイルがドキュメント・ルートに存在する場合、URI http://server:port/helloでアクセスできます。

• ファイル拡張子ありでHTMLリソースにアドレスしようとすると、ファイル拡張子なしの場所にリダイレクトされます。たとえば、URI http://server:port/hello.htmlにアクセスしようとすると、クライアントはhttp://server:port/helloにリダイレクトされます。

  通常のプラクティスはHTMLリソースにファイル拡張子なしで使用することであるため、この機能はそのプラクティスを手助けし、さらにリダイレクトはファイル拡張子ありでアドレスされたリソースを扱います。

• フォルダの索引ページがサポートされます。フォルダにindex.htmlまたはindex.htmという名前のファイルがある場合、そのファイルはフォルダの索引ページとして使用されます。たとえば、/var/www/htmlに/abc/xyz/index.htmlがある場合、http://server:port/abc/xyz/にアクセスすると、index.htmlの内容が表示されます。

• 末尾にスラッシュなしでフォルダをアドレス入力すると、末尾にスラッシュありのURIにリダイレクトされます。たとえば、クライアントがhttp://server:port/abc/xyzにアクセスした場合、サーバーはhttp://server:port/abc/xyz/へのリダイレクトを発行します。

• リソースは、ファイルの修正スタンプに基づき弱いetagと、リソースを1時間キャッシュするキャッシュ制御ヘッダー付きで生成されます。

1.5 Oracle WebLogic Serverへのデプロイ

この項では、Oracle WebLogic ServerにOracle REST Data Servicesをデプロイする方法について説明します。Oracle WebLogic Serverのインストール・プロセスを完了し、Oracle WebLogic Serverに精通した読者を前提としています。ドメイン、管理対象サーバー、デプロイ、セキュリティ、ユーザーおよびロールに不慣れな場合は、Oracle WebLogic Serverのドキュメントを参照してください。

トピック:

• Oracle WebLogic Serverについて

• Oracle REST Data Servicesのダウンロード、インストールおよび構成

• Oracle Application Expressイメージの構成

• 管理サーバー・コンソールの起動

• Oracle WebLogic Serverデプロイのインストール

• HTTPのBasicチャレンジを正しく処理するためのWebLogicの構成

• ordsおよびiの状態と健全性の検証

1.5.1 Oracle WebLogic Serverについて

Oracle WebLogic ServerはOracle Technology Networkからダウンロードできます。

Oracle WebLogic Serverのインストールの詳細は、『Oracle Fusion Middleware Oracle WebLogic Serverインストレーション・スタート・ガイド』および『Oracle Fusion Middleware Oracle WebLogic Serverインストレーション・ガイド』を参照してください。

関連項目:

weblogic_downloads

1.5.2 Oracle REST Data Servicesのダウンロード、インストールおよび構成

Oracle REST Data ServicesをWebLogicにデプロイする前に、このステップを完了する必要があります。

1.5.3 Oracle Application Expressイメージの構成

Oracle Application Expressを使用している場合、Oracle Application Expressを参照するためにWebアーカイブ(イメージ・ファイル)を作成する必要があります。ただし、Oracle Application Expressを使用していない場合、Oracle Application Expressイメージを構成することに関するこの項の以降の手順をスキップできます。

作業を開始する前に、Oracle Application Expressのイメージ・ファイルを参照するWebアーカイブ(WAR)ファイルを作成する必要があります。i.warという名前のWebアーカイブ・ファイルを作成する​​には、次のようにstaticコマンドを使用します。

java -jar ords.war static <apex directory>\images

説明:

• <apex directory>は、Oracle Application Expressディレクトリの場所です。

このコマンドにより、ords.warファイルに含まれるstaticコマンドが実行されます。これにより、Application Expressの静的イメージがi.warという名前のアーカイブ・ファイルにパッケージ化されます。

作成されるイメージのWARには静的リソースは含まれず、そのかわりに静的リソースが保存されている場所が参照されます。このため、WARがデプロイされるサーバー上の指定したパスで静的リソースが利用可能である必要があります。

ヒント:

staticコマンドのすべてのオプションを確認するには、java -jar ords.war help staticを使用します。

i.warファイルは、次のステップでWebLogicへのデプロイに使用します。

1. 管理サーバー・コンソールの起動

2. Oracle WebLogic Serverデプロイのインストール

3. HTTPのBasicチャレンジを正しく処理するためのWebLogicの構成

1.5.4 管理サーバー・コンソールの起動

管理サーバー・コンソールを起動するには、次の手順を実行します。

1. 管理サーバーを起動します。
2. Webブラウザに次のURLを入力して、WebLogic管理コンソールを起動します。

   http://<host>:<port>/console
   

   説明:

   • <host>は、管理サーバーのDNS名またはIPアドレスです。

   • <port>は、管理サーバーでリクエストをリスニング中のポートです(デフォルトでは7001ポート)。

3. WebLogic管理者のユーザー名およびパスワードを入力します。
4. ドメインが本番モードの場合、「チェンジ・センター」サブメニューの下の左ペインの「ロックして編集」ボタンをクリックします。ドメインが開発モードの場合は、このボタンは表示されません。

1.5.5 Oracle WebLogic Serverデプロイのインストール

ヒント:

この作業を開始する前に、Oracle REST Data Servicesのファイルであるords.warおよびi.warが使用可能になっている必要があります。

デプロイをインストールするには、次の手順を実行します。

1. WebLogic Serverのホームページに移動します。「ドメイン構成」の下で、「デプロイメント」を選択します。

   「デプロイメントの概要」が表示されます。

2. 「インストール」をクリックします。

3. ords.warファイルの場所を指定し、「次」をクリックします。

   ords.warファイルは、Oracle REST Data ServicesのZIPファイルを解凍したフォルダにあります。

   ヒント:

   WebLogic Serverは、WARアーカイブのファイル名からコンテキスト・ルートを決定します。下位互換を維持する必要がある場合は、URLがhttp://server/ords/...ではなくhttp://server/apex/...という形式になるように、デプロイ前にords.warという名前をapex.warに変更する必要があります。

   アプリケーション・インストール・アシスタントが表示されます。

4. 「このデプロイメントをアプリケーションとしてインストールする」を選択して「次へ」をクリックします。

5. アプリケーションまたはモジュールのデプロイ先とするサーバーまたはクラスタを選択して、「次」をクリックします。

   ヒント:

   追加の管理対象サーバーまたはクラスタを作成していない場合、このアシスタント・ページは表示されません。

6. 「オプション設定」では、次のように指定します。

   1. 名前 - 次を入力します。

      ords
      

   2. セキュリティ - 次を選択します。

      カスタム・ロール: 管理コンソール内に定義されたロールを使用します。デプロイメント記述子内に定義されたポリシーを使用します。

   3. ソースのアクセス可能性 - 次を選択します。

      デプロイメントのターゲットに定義されるデフォルトを使用

7. 「次へ」をクリックします。

   概要ページが表示されます。

8. 「追加構成」の下で、次のいずれかを選択します。

   • はい、デプロイメントの構成画面に移動します。 - 構成ページが表示されます。

   • いいえ、後で構成を確認します。 - 「デプロイメントのサマリー」ページに戻ります。

9. 指定した構成設定の概要を確認します。

10. 「終了」をクリックします。

11. 前述のステップを繰り返してi.warファイルをデプロイします。

    オプション設定では、次のように指定します。

    1. 名前 - 次を入力します。

       i
       

    2. セキュリティ - 次を選択します。

       カスタム・ロール: 管理コンソール内に定義されたロールを使用します。デプロイメント記述子内に定義されたポリシーを使用します。

    3. ソースのアクセス可能性 - 次を選択します。

       デプロイメントのターゲットに定義されるデフォルトを使用

12. ドメインが本番モードの場合、「チェンジ・センター」で「変更のアクティブ化」をクリックします。

1.5.6 HTTPのBasicチャレンジを正しく処理するためのWebLogicの構成

デフォルトでは、WebLogic Serverにより、すべてのHTTP Basic認証のチャレンジのインターセプトが試行されます。Oracle REST Data Servicesを正常に機能させるには、このデフォルトの動作を無効にする必要があります。そのためには、enforce-valid-basic-auth-credentialsフラグを更新します。WebLogic Server管理コンソールでは、enforce-valid-basic-auth-credentials設定は表示されません。WebLogic Scripting Tool (WLST)コマンド使用して、実行中のサーバーの値を確認および編集できます。 

次のWLSTコマンドによりドメイン設定が表示されます。

connect('weblogic','weblogic','t3://localhost:7001')
cd('SecurityConfiguration')
cd('mydomain') 
ls()

ドメイン設定が表示されたら、次のエントリを含めます。

-r--   EnforceValidBasicAuthCredentials             true

次に、このエントリをfalseに設定する必要があります。

エントリをfalseに設定するには、次のようにWLSTコマンドを使用します。

connect('weblogic', 'weblogic', 't3://localhost:7001')
edit()
startEdit()
cd('SecurityConfiguration')
cd('mydomain')  
set('EnforceValidBasicAuthCredentials','false')
save()
activate()
disconnect()
exit()

注意:

新しい設定を有効にするには、WebLogic Serverを再起動する必要があります。

前述の例は、次のとおりです。

• weblogicは管理権限を持つWebLogicユーザーです

• weblogicはパスワードです

• mydomainはドメインです

• AdminServerはローカルホストおよびポート 7001上で実行されています

1.5.7 ordsおよびiの状態と健全性の検証

「デプロイメントのサマリー」で、「制御」タブを選択し、ordsおよびiの両方の「状態」が「アクティブ」および「ヘルス」状態でOKであることを確認します。

ordsまたはi、あるいはその両方が「アクティブ」でない場合は、有効にします。「デプロイメント」表で、ordsまたはi(あるいはその両方)の隣にあるチェック・ボックスを選択します。「開始」をクリックし、「すべてのリクエストを処理」を選択してそれらをアクティブにします。

1.6 Apache Tomcatへのデプロイ

この項では、Apache TomcatにOracle REST Data Servicesをデプロイする方法について説明します。

トピック:

• Apache Tomcatについて

• Oracle REST Data Servicesのダウンロード、インストールおよび構成

• Oracle Application Expressイメージの構成

• Apache Tomcatデプロイのインストール

1.6.1 Apache Tomcatについて

ヒント:

この項は、Apache Tomcatのインストール・プロセスを完了し、Apache Tomcatに精通した読者を前提としています。ドメイン、サーバー、アプリケーション、セキュリティ、ユーザーおよびロールに不慣れな場合は、Apache Tomcatのドキュメントを参照してください。

Apache Tomcatは次のURLからダウンロードできます。

関連項目:

apache_tomcat_80

1.6.2 Oracle REST Data Servicesのダウンロード、インストールおよび構成

Oracle REST Data ServicesをApache Tomcatにデプロイする前に、このステップを完了する必要があります。

1.6.3 Oracle Application Expressイメージの構成

Oracle Application Expressを使用している場合、Oracle Application Expressを参照するためにWebアーカイブ(イメージ・ファイル)を作成する必要があります。ただし、Oracle Application Expressを使用していない場合、Oracle Application Expressイメージを構成することに関するこの項の以降の手順をスキップできます。

Apache Tomcat上でOracle Application Expressイメージを構成するには、次のようにします。

• <apex directory>/imagesフォルダのコンテンツを<Tomcat directory>/webapps/i/にコピーします。

  説明:

  • <apex directory>は、Oracle Application Expressディストリビューションのディレクトリの場所です。

  • <Tomcat directory>は、Apache Tomcatがインストールされているフォルダです。

1.6.4 Apache Tomcatデプロイのインストール

ヒント:

この作業を開始する前に、Oracle REST Data Servicesのファイルであるords.warが使用可能になっている必要があります。

Apache Tomcatデプロイをインストールするには、次の手順を実行します。

1. ords.warファイルをApache Tomcatがインストールされているwebappsフォルダに移動します。

   ヒント:

   Apache Tomcatは、WARアーカイブのファイル名からコンテキスト・ルートを決定します。下位互換を維持する必要がある場合は、URLがhttp://server/ords/...ではなくhttp://server/apex/...という形式になるように、webappsフォルダに移動する前に、ords.warという名前をapex.warに変更する必要があります。

2. Webブラウザに次のURLを入力して、Oracle Application Expressにアクセスします。

   http://<hostname>:<port>/ords/
   

   説明:

   • <hostname>は、Apache Tomcatが実行されているサーバーの名前です。

   • <port>は、Apache Tomcatアプリケーション・サーバー用に構成されたポート番号です。

1.7 Oracle REST Data Servicesのアップグレード

新しいリリースのOracle REST Data Servicesにアップグレードする場合は、次のようにする必要があります。

1. Oracle REST Data Servicesインスタンスを停止します。

   • アプリケーション・サーバー(Oracle WebLogic ServerまたはApache Tomcatなど)上でOracle REST Data Servicesを実行している場合は、Oracle REST Data Servicesを停止します。

   • Oracle REST Data Servicesをスタンドアロン・モードで実行している場合は、「スタンドアロン・モードのサーバーの停止」を参照してください。

2. 新しいOracle REST Data Servicesリリース・ディストリビューションを解凍したフォルダに移動します。

3. コマンドラインに次のコマンドを入力します。

   java -jar ords.war install advanced

   または

   java -jar ords.war 

4. 構成フォルダの入力を求められたら、Oracle REST Data Servicesの構成ファイルが格納されている構成フォルダを使用します。(構成場所は、ords.warファイルに収録されます。)

   • 構成ファイルが格納されている既存のOracle REST Data Servicesの構成フォルダを指定すると、Oracle REST Data Servicesでは、構成フォルダ内に定義されている各データベースに接続して、インストール済バージョンをチェックしようとします。

   • 存在しないOracle REST Data Servicesの構成フォルダを指定すると、データベース接続情報、ORDS_PUBLIC_USER資格証明およびその他の構成情報の入力を求められます。Oracle REST Data Servicesでは、そのデータベースに接続してインストール済バージョンをチェックしようとします。

Oracle REST Data Servicesによるインストール済バージョンのチェックでは、データベースにすでにインストールされているバージョンが3.0.nより前かどうかに応じて、次のように処理が行われます。

• インストール済バージョンが以前の3.0.nバージョンのOracle REST Data Servicesの場合は、Oracle REST Data Servicesでインプレース・アップグレードを適用できるように、ユーザー名とパスワード(ORDSインストーラ権限またはSYS AS SYSDBAを持つユーザー)の入力を求められます。インプレース・アップグレードでは、既存のインストールが変更され、更新されたスキーマ・オブジェクトおよびパッケージが追加されます。Oracle REST Data Servicesのスキーマに格納されている既存のメタデータは元の状態のままになります。

• Oracle REST Data Servicesがデータベースにまだインストールされていない場合(またはリリース2.0.nからアップグレードしている場合)は、Oracle REST Data Servicesでインストールを実行できるようにユーザー名とパスワード(ORDSインストーラ権限またはSYS AS SYSDBAを持つユーザー)の入力だけでなく、ORDS_METADATAスキーマのデフォルトの表領域および一時表領域とORDS_PUBLIC_USERの入力も求められます。

アップグレードまたはインストールが完了すると、ords.warファイルをアプリケーション・サーバーに再度デプロイすることも、スタンドアロン・モードでOracle REST Data Servicesを起動することもできます。

1.8 Bequeath接続を使用したOracle REST Data Servicesのインストール、アップグレード、検証またはアンインストール

Bequeath接続を使用して、Oracle REST Data Servicesのインストール、アップグレード、検証またはアンインストールを実行できます。インストーラからは、操作のSYSユーザー名とパスワードの入力を求められません。

パラメータ・ファイルに次のプロパティを追加します: bequeath.connect=true

Oracle REST Data Servicesのインストール、検証またはアンインストールへのBequeath接続の使用は、Oracle Databaseリリース12の場合はLinuxおよびWindowsシステムでサポートされていますが、Oracle Databaseリリース11の場合はLinuxシステムでのみサポートされています。

使用するコマンドは、DBAグループのメンバーであるオペレーティング・システム・ユーザーが実行する必要があります。Oracle REST Data Servicesのインストールの例を次に示します。

java -jar ords.war

Linuxを使用したBequeath接続

Linuxシステムでは、Bequeath接続を使用するように次の環境変数を設定する必要があります。

• ORACLE_HOME

• ORACLE_SID

• LD_LIBRARY_PATH (ORACLE_HOME/libを指すため)

Oracle Databaseリリース11 (リリース12ではなく)の場合、オプション-DuseOracleHome=trueを指定する必要があります。LinuxシステムでのOracle REST Data Servicesのインストールの例を次に示します。

• Oracle Databaseリリース11の場合: java -DuseOracleHome=true -jar ords.war

• Oracle Databaseリリース12の場合: java -jar ords.war

1.9 Oracle Data Guardで保護されているユーザーにアクセスするためのOracle REST Data Servicesの認可

Oracle Data Vault Realmで保護されているデータベース・スキーマ・オブジェクトにアクセスするには、Oracle REST Data Services Publicユーザーにプロキシ・ユーザー認可を付与する必要があります。

次の例では、Oracle REST Data Servicesのパブリック・ユーザーORDS_PUBLIC_USERがデータベースのHRユーザーのプロキシとして動作することを認可します。

begin
  DBMS_MACADM.AUTHORIZE_PROXY_USER('ORDS_PUBLIC_USER','HR');
end;
/