目次

例一覧

図一覧

表一覧

タイトルおよび著作権情報

はじめに

• 対象読者
• ドキュメントのアクセシビリティについて
• 関連ドキュメント
• 表記規則
• サード・パーティ・ライセンス情報

このリリースでの『Oracle REST Data Servicesインストレーション、構成および開発ガイド』の変更点

• Oracle REST Data Servicesリリース17.4での変更点
  • 新機能
  • 非推奨となった機能

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

• 1.1 Oracle REST Data Servicesについて
• 1.2 インストール・プロセスの理解
  • 1.2.1 サポートされるJava EEアプリケーション・サーバー
  • 1.2.2 システム要件
  • 1.2.3 Oracle REST Data Servicesのインストールについて
• 1.3 Oracle REST Data Servicesの構成およびインストール
  • 1.3.1 コマンドライン・インタフェースの使用について
  • 1.3.2 Oracle REST Data Servicesで使用されるデータベース・ユーザーについて
  • 1.3.3 Oracle REST Data Servicesによって付与される権限
  • 1.3.4 Oracle REST Data Servicesのダウンロード、構成およびインストール
    • 1.3.4.1 コマンドライン・プロンプトを使用した拡張インストール
      • 1.3.4.1.1 拡張インストール・プロンプトの説明
    • 1.3.4.2 パラメータ・ファイルを使用したサイレント・インストール
      • 1.3.4.2.1 サイレント・モードでインストールするためのパラメータ
    • 1.3.4.3 Oracle REST Data Servicesインストールの検証
    • 1.3.4.4 Oracle REST Data Servicesを再インストールまたはアンインストール(削除)する場合
  • 1.3.5 SQL Developerを使用したOracle REST Data Servicesの管理(オプション)
    • 1.3.5.1 SQL DeveloperのOracle REST Data Services管理について
    • 1.3.5.2 管理者ユーザーの構成
  • 1.3.6 非HTTPS環境でOAuth2の使用
• 1.4 スタンドアロン・モードでの実行
  • 1.4.1 スタンドアロン・モードでの起動
    • 1.4.1.1 DERへの秘密鍵の変換(LinuxおよびUNIX)
  • 1.4.2 スタンドアロン・モードのサーバーの停止
  • 1.4.3 非Application Expressの静的リソースのドキュメント・ルートの構成
• 1.5 Oracle WebLogic Serverへのデプロイ
  • 1.5.1 Oracle WebLogic Serverについて
  • 1.5.2 Oracle REST Data Servicesのダウンロード、インストールおよび構成
  • 1.5.3 Oracle Application Expressイメージの構成
  • 1.5.4 管理サーバー・コンソールの起動
  • 1.5.5 Oracle WebLogic Serverデプロイのインストール
  • 1.5.6 HTTPのBasicチャレンジを正しく処理するためのWebLogicの構成
  • 1.5.7 ordsおよびiの状態と健全性の検証
• 1.6 GlassFish Serverへのデプロイ
  • 1.6.1 GlassFish Serverについて
  • 1.6.2 Oracle REST Data Servicesのダウンロード、インストールおよび構成
  • 1.6.3 Oracle Application Expressイメージの構成
  • 1.6.4 管理サーバー・コンソールの起動
  • 1.6.5 GlassFish Serverデプロイのインストール
• 1.7 Apache Tomcatへのデプロイ
  • 1.7.1 Apache Tomcatについて
  • 1.7.2 Oracle REST Data Servicesのダウンロード、インストールおよび構成
  • 1.7.3 Oracle Application Expressイメージの構成
  • 1.7.4 Apache Tomcatデプロイのインストール
• 1.8 Oracle REST Data Servicesのアップグレード
• 1.9 Bequeath接続を使用したOracle REST Data Servicesのインストール、アップグレード、検証またはアンインストール

2 Oracle REST Data Servicesの構成(詳細)

• 2.1 複数データベースの構成
  • 2.1.1 リクエストURLについて
  • 2.1.2 追加のデータベースの構成
  • 2.1.3 リクエスト・パスの接頭辞に基づくルーティング
    • 2.1.3.1 リクエスト・パスの接頭辞に基づくルーティングの例
  • 2.1.4 リクエストURLの接頭辞に基づくルーティング
    • 2.1.4.1 リクエストURLの接頭辞に基づくルーティングの例
• 2.2 Oracle REST Data Servicesでのマルチテナント・アーキテクチャの使用
  • 2.2.1 インストールの選択項目の理解
  • 2.2.2 Oracle REST Data ServicesのCDBへのインストール
  • 2.2.3 CDB環境でのOracle REST Data Servicesのアップグレード
  • 2.2.4 Oracle REST Data Servicesによって、すべてのPDBをアドレス可能にする(プラガブル・マッピング)
  • 2.2.5 CDB環境でのOracle REST Data Servicesのアンインストール
• 2.3 Oracle RAC Fast Connection Failoverのサポート
• 2.4 セキュリティ、キャッシュ、前処理と後処理、環境、およびExcel設定の構成
• 2.5 REST対応SQLサービス設定の構成
• 2.6 問合せから戻される行の最大数の構成
• 2.7 カスタム・エラー・ページの構成
• 2.8 Oracle REST Data Servicesで使用するRESTfulサービスの開発

3 Oracle REST Data Servicesアプリケーションの開発

• 3.1 関連するソフトウェアの紹介
  • 3.1.1 Oracle Application Expressについて
  • 3.1.2 RESTful Webサービスについて
• 3.2 RESTfulサービスのスタート・ガイド
  • 3.2.1 RESTfulサービスの用語
  • 3.2.2 リクエスト・パスの構文要件について
  • 3.2.3 インストールに含まれるドキュメント「スタート・ガイド」
  • 3.2.4 cURLおよびRESTfulサービスのテストについて
  • 3.2.5 RESTアクセスのためのスキーマ・オブジェクトの自動的な有効化(AutoREST)
    • 3.2.5.1 例: RESTfulサービスを使用してオブジェクトにアクセスする
      • 3.2.5.1.1 スキーマ・メタデータのGet
      • 3.2.5.1.2 オブジェクト・メタデータのGet
      • 3.2.5.1.3 オブジェクト・データのGet
      • 3.2.5.1.4 ページ区切りを使用した表データのGet
      • 3.2.5.1.5 問合せを使用した表データのGet
      • 3.2.5.1.6 主キーを使用した表の行のGet
      • 3.2.5.1.7 表の行の挿入
      • 3.2.5.1.8 表の行の更新/挿入
      • 3.2.5.1.9 フィルタを使用したDelete
      • 3.2.5.1.10 バッチ・ロードによるPost
    • 3.2.5.2 問合せでのフィルタリング
      • 3.2.5.2.1 FilterObjectの文法
      • 3.2.5.2.2 例: FilterObjectの記述
    • 3.2.5.3 自動PL/SQL
      • 3.2.5.3.1 PL/SQLオブジェクトの自動有効化がサポートされているメソッドとコンテンツ・タイプ
      • 3.2.5.3.2 PL/SQLオブジェクトの自動有効化
      • 3.2.5.3.3 PL/SQLエンドポイントの生成
      • 3.2.5.3.4 リソース入力ペイロード
      • 3.2.5.3.5 リソース・ペイロード・レスポンス
      • 3.2.5.3.6 ファンクションの戻り値
  • 3.2.6 SQLおよびPL/SQLを使用したRESTful Servicesの手動作成
    • 3.2.6.1 Oracle REST Data Servicesのパラメータ引き渡しメカニズムについて
      • 3.2.6.1.1 JSONを使用したパラメータの引き渡し
      • 3.2.6.1.2 ルート・パターンを使用したパラメータの引き渡し
      • 3.2.6.1.3 オプションのパラメータのための問合せ文字列の使用
    • 3.2.6.2 SQL/JSONデータベース・ファンクションの使用
      • 3.2.6.2.1 ネストされたJSONオブジェクトの関係表への挿入
      • 3.2.6.2.2 階層リレーショナル・データからのネストされたJSONオブジェクトの生成
      • 3.2.6.2.3 RESTfulサービスのテスト
  • 3.2.7 Oracle REST Data Servicesでの日付の使用について
    • 3.2.7.1 Oracle REST Data Servicesによる日時処理について
    • 3.2.7.2 タイムゾーンの設定について
    • 3.2.7.3 Application ExpressでのサンプルのRESTfulサービスの調査(チュートリアル)
• 3.3 RESTfulサービスへのセキュアなアクセスの構成
  • 3.3.1 認証
    • 3.3.1.1 ファースト・パーティのCookieベースの認証
    • 3.3.1.2 サード・パーティのOAuth 2.0ベースの認証
      • 3.3.1.2.1 Two-LeggedおよびThree-LeggedのOAuthフロー
  • 3.3.2 リソースにアクセスするための権限について
  • 3.3.3 リソースにアクセスするためのユーザーおよびロールについて
  • 3.3.4 ファイルベースのユーザー・リポジトリについて
  • 3.3.5 チュートリアル: リソースの保護およびアクセス
    • 3.3.5.1 OAuthフローと各フローの用途
    • 3.3.5.2 このチュートリアルの前提
    • 3.3.5.3 このチュートリアルの手順
• 3.4 Oracle REST Data Servicesのユーザー・ロールについて
  • 3.4.1 Oracle Application ExpressのユーザーとOracle REST Data Servicesのロールについて
    • 3.4.1.1 Application ExpressユーザーにOracle REST Data Servicesロールを付与する
    • 3.4.1.2 Application Expressユーザーに自動的にOracle REST Data Servicesロールを付与する
  • 3.4.2 ロールによるRESTfulサービスのアクセス制御
    • 3.4.2.1 RESTfulサービスのロールの定義について
    • 3.4.2.2 ロールとRESTful権限の関連付け
• 3.5 WebLogic ServerおよびGlassFishユーザー・リポジトリに対する認証
  • 3.5.1 WebLogic Serverに対する認証
    • 3.5.1.1 WebLogic Serverユーザーの作成
    • 3.5.1.2 WebLogic Serverユーザーの検証
  • 3.5.2 GlassFishに対する認証
    • 3.5.2.1 GlassFishユーザーの作成
    • 3.5.2.2 GlassFishユーザーの検証
• 3.6 既存のグループ/ロール・モデルとの統合
  • 3.6.1 role-mapping.xmlについて
    • 3.6.1.1 マッピング・ルールのパラメータ化
    • 3.6.1.2 パラメータの間接参照
    • 3.6.1.3 間接マッピング
• 3.7 Oracle REST Data Services PL/SQL APIの使用
  • 3.7.1 PL/SQL APIを使用したRESTfulサービスの作成
  • 3.7.2 RESTfulサービスのテスト

4 REST対応SQLサービス

• 4.1 REST対応SQLサービスの用語
• 4.2 REST対応SQLサービスの構成
• 4.3 REST対応SQLサービスでのcURLの使用
• 4.4 REST対応SQLサービスのスタート・ガイド
  • 4.4.1 Oracle DatabaseスキーマのREST対応
  • 4.4.2 REST対応SQL認証
  • 4.4.3 REST対応SQLエンドポイント
• 4.5 REST対応SQLサービスの例
  • 4.5.1 application/sql Content-Typeを使用するPOSTリクエスト
    • 4.5.1.1単一のSQL文の使用
    • 4.5.1.2 cURLを使用したファイルの使用
    • 4.5.1.3 複数のSQL文の使用
  • 4.5.2 application/json Content-Typeを使用するPOSTリクエスト
    • 4.5.2.1 cURLを使用したファイルの使用
    • 4.5.2.2 POSTリクエストでのページ区切りの制限値の指定
    • 4.5.2.3 POSTリクエストでのページ区切りのオフセット値の指定
    • 4.5.2.4 POSTリクエストでのバインドの定義
    • 4.5.2.5 POSTリクエストでのバッチ文の指定
  • 4.5.3 DATEおよびTIMESTAMP形式を使用するPOSTリクエストの例
  • 4.5.4 サポートされるデータ型と形式
• 4.6 REST対応SQLリクエストおよびレスポンスの仕様
  • 4.6.1 リクエストの仕様
  • 4.6.2 レスポンスの仕様
• 4.7 サポートされるSQL、SQL*PlusおよびSQLcl文
  • 4.7.1 サポートされているSQL文
  • 4.7.2 サポートされているPL/SQL文
  • 4.7.3 サポートされているSQL*Plus文
    • 4.7.3.1 システム変数の設定
    • 4.7.3.2 システム変数の表示
  • 4.7.4 サポートされているSQLcl文

5 NoSQLおよびOracle REST Data Services

• 5.1 NoSQLおよびOracle REST Data Servicesについて
  • 5.1.1 テクノロジ環境
  • 5.1.2 標準的なOracle REST Data Servicesの入力および出力
• 5.2 NoSQLストアのインストールおよび登録
• 5.3 Oracle REST Data Servicesで使用するNoSQLストアの追加および削除
• 5.4 NoSQL RESTサービス
  • 5.4.1 メタデータ・サービス
    • 5.4.1.1 メタデータ読取り(GET)
  • 5.4.2 データ・サービス
    • 5.4.2.1 データ読取り(GET)
    • 5.4.2.2 べき等書込み(PUT)
    • 5.4.2.3 書込み(POST)
    • 5.4.2.4 削除(DELETE)
  • 5.4.3 DDLサービス
    • 5.4.3.1 作成/更新(POST)
    • 5.4.3.2 ドロップ(POST)
    • 5.4.3.3 ポーリング(GET)
  • 5.4.4 共通パラメータ
    • 5.4.4.1 結果をスキップおよび結果の数を制限するパラメータ
    • 5.4.4.2 問合せ条件を指定するパラメータ
    • 5.4.4.3 方向(順序)、一貫性および永続性保証を指定するパラメータ

6 Oracle REST Data Services PL/SQLパッケージのリファレンス

• 6.1 ORDS.CREATE_ROLE
• 6.2 ORDS.CREATE_SERVICE
• 6.3 ORDS.DEFINE_HANDLER
• 6.4 ORDS.DEFINE_MODULE
• 6.5 ORDS.DEFINE_PARAMETER
• 6.6 ORDS.DEFINE_PRIVILEGE
• 6.7 ORDS.DEFINE_SERVICE
• 6.8 ORDS.DEFINE_TEMPLATE
• 6.9 ORDS.DELETE_MODULE
• 6.10 ORDS.DELETE_PRIVILEGE
• 6.11 ORDS.DELETE_ROLE
• 6.12 ORDS.DROP_REST_FOR_SCHEMA
• 6.13 ORDS.ENABLE_OBJECT
• 6.14 ORDS.ENABLE_SCHEMA
• 6.15 ORDS.PUBLISH_MODULE
• 6.16 ORDS.RENAME_MODULE
• 6.17 ORDS.RENAME_PRIVILEGE
• 6.18 ORDS.RENAME_ROLE
• 6.19 ORDS.SET_MODULE_ORIGINS_ALLOWED
• 6.20 ORDS.SET_URL_MAPPING

7 OAUTH PL/SQLパッケージのリファレンス

• 7.1 OAUTH.CREATE_CLIENT
• 7.2 OAUTH.DELETE_CLIENT
• 7.3 OAUTH.GRANT_CLIENT_ROLE
• 7.4 OAUTH.RENAME_CLIENT
• 7.5 OAUTH.REVOKE_CLIENT_ROLE
• 7.6 OAUTH.UPDATE_CLIENT

A Oracle REST Data Servicesデータベース・タイプのマッピング

• A.1 Oracle組込み型
• A.2 構造化されたデータベース・タイプの処理
• A.3 Oracle Geospacial Encoding
• A.4 データベース・マッピング・サポートの有効化

B Oracle REST Data Servicesの構成ファイルについて

• B.1 構成ファイルの検索
• B.2 構成ファイルの場所を設定する
• B.3 構成フォルダの構造を理解する
• B.4 構成ファイルの形式を理解する
  • B.4.1 url-mapping.xmlファイルの形式を理解する
• B.5 構成可能なパラメータの理解

C Oracle REST Data Servicesのトラブルシューティング

• C.1 デバッグ・トレースの有効化
• C.2 詳細なリクエスト・エラー・メッセージの有効化
• C.3 Oracle REST Data ServicesでのApplication Expressの静的リソースの構成

D イメージ・ギャラリの作成

• D.1 はじめに
  • D.1.1 URIについて
  • D.1.2 ブラウザのサポートについて
  • D.1.3 Application Expressワークスペースの作成
• D.2 ギャラリ・データベース表の作成
• D.3 ギャラリRESTfulサービス・モジュールの作成
• D.4 ギャラリRESTfulサービスの試用
• D.5 ギャラリ・アプリケーションの作成
• D.6 ギャラリ・アプリケーションの試用
• D.7 ギャラリRESTfulサービスの保護
  • D.7.1 RESTfulサービスの保護
  • D.7.2 ファースト・パーティ認証を使用するためのアプリケーションの変更
• D.8 サード・パーティ・アプリケーションからのRESTfulサービスへのアクセス
  • D.8.1 サード・パーティの開発者ユーザーの作成
  • D.8.2 サード・パーティ・アプリケーションの登録
  • D.8.3 アクセス・トークンの取得
  • D.8.4 アクセス・トークンの使用
  • D.8.5 ブラウザのオリジンについて
  • D.8.6 クロス・オリジン・リソース共有のためのRESTfulサービスの構成
  • D.8.7 認可コード・プロトコル・フローを使用したトークンの取得
    • D.8.7.1 クライアント・アプリケーションの登録
    • D.8.7.2 認可コードの取得
    • D.8.7.3 認可コードとアクセス・トークンの交換
    • D.8.7.4 OAuth 2.0セッションの継続時間の延長
  • D.8.8 アクセス・トークンの保護について

索引