SQL Anywhere HTTP Web サーバを参照する方法

Web サービスの命名と設計の方法によって、使用可能な URL 名が定義されます。各 Web サービスには、独自の Web コンテンツがあります。通常、このコンテンツは、データベース内のカスタム関数とプロシージャによって生成されますが、SQL 文を指定する URL を使用してコンテンツを生成することもできます。別の方法として、またはこの方法と組み合わせて、専用サービスで処理されないすべての HTTP 要求を処理する root Web サービスを定義することもできます。通常、root Web サービスは、要求の URL とヘッダから、要求の処理方法を判断します。

URL によって、HTTP 要求または保護された HTTPS 要求を介して使用できる html コンテンツなどのリソースがユニークに指定されます。この項では、SQL Anywhere HTTP Web サーバで定義された Web サービスにアクセスできるようにするため、Web ブラウザの URL 構文をフォーマットする方法について説明します。

注意

この項で記載する情報は、RAW、XML、HTML、DISH サービスなどの汎用 HTTP Web サービスタイプを使用する HTTP Web サーバに適用されます。ブラウザを使用して、SOAP 要求を発行することはできません。JSON サービスからは、AJAX を使用した Web サービスアプリケーションで使用される結果セットが返されます。

構文

{http|https}://host-name[:port-number][/dbn]/service-name[/path-name|?url-query]

パラメータ

host-name と port-number Web サーバのロケーションを指定します。オプションとして、デフォルトの HTTP ポート番号または HTTPS ポート番号として定義されていない場合は、ポート番号を指定します。host-name には、Web サーバを実行中のコンピュータの IP アドレスを指定できます。port-number は、Web サーバを起動したときに使用されているポート番号に一致している必要があります。
-xs データベースサーバオプションとServerPort (PORT) プロトコルオプションを参照してください。
dbn データベース名を指定します。このデータベースは Web サーバで実行中であり、Web サービスが含まれている必要があります。
Web サーバで 1 つのデータベースしか実行されていない場合、またはプロトコルオプションの特定の HTTP/HTTPS リスナに対してデータベース名が指定されている場合は、dbn を指定する必要はありません。

-xs データベースサーバオプションとDatabaseName (DBN) プロトコルオプションを参照してください。
service-name アクセスする Web サービスの名前を指定します。この Web サービスは、dbn で指定されたデータベースに存在している必要があります。Web サービスを作成または変更する場合は、スラッシュ文字 ( / ) が有効であり、service-name の一部として使用できます。SQL Anywhere は、URL の残りの部分と定義されたサービスを一致させます。
service-name が未指定で、root Web サービスが定義されている場合は、クライアント要求が処理されます。要求を処理する適切なサービスをサーバで識別できない場合は、404 Not Found エラーが返されます。関連動作として、root Web サービスが存在せず、URL 基準に基づいて要求を処理できない場合は、404 Not Found エラーが生成されます。

path-name サービス名の解決後、残りのスラッシュで区切られたパスは、Web サービスプロシージャからアクセスできます。URL ON を指定して作成されたサービスの場合は、指定された URL HTTP 変数を使用してパス全体にアクセスできます。URL ELEMENTS を指定して作成されたサービスの場合は、指定された HTTP 変数 URL1 ～ URL10 を使用して各パス要素にアクセスできます。

パス要素変数は、サービス文定義のパラメータ宣言でホスト変数として定義できます。別の方法として、またはこの方法と組み合わせて、HTTP_VARIABLE 関数呼び出しを使用してストアドプロシージャ内から HTTP 変数にアクセスすることもできます。

次の例は、Web サービスの作成に使用する、URL 句を ELEMENTS に設定した SQL 文を示しています。

CREATE SERVICE TestWebService
    TYPE 'HTML'
    URL ELEMENTS
    AUTHORIZATION OFF
    USER DBA 
    AS CALL TestProcedure ( :url1, :url2 );

この TestWebService Web サービスは、url1 と url2 の各ホスト変数を明示的に参照するプロシージャを呼び出します。

この Web サービスには、次の URL を使用してアクセスできます。この場合、デフォルトのポートを介した localhost からデータベース demo で TestWebService が実行されていることが前提となります。

http://localhost/demo/TestWebService/Assignment1/Assignment2/Assignment3

この URL は、TestProcedure を実行し、Assignment1 値を url1 に割り当て、Assignment2 値を url2 に割り当てる TestWebService にアクセスします。オプションとして、HTTP_VARIABLE 関数を使用して、TestProcedure から他のパス要素にアクセスできます。たとえば、HTTP_VARIABLE( 'url3' ) 関数呼び出しは Assignment3 を返します。

URL ELEMENTS と URL ベースの変数の詳細については、CREATE SERVICE 文 [HTTP Web サービス] を参照してください。

url-query HTTP GET 要求は、HTTP 変数を指定するクエリコンポーネントがあるパスをたどることがあります。同様に、標準の application/x-www-form-urlencoded Content-Type を使用する POST 要求の本文は、要求本文内の HTTP 変数を渡すことができます。いずれの場合も、HTTP 変数は名前／値ペアとして渡されます。変数名は、等号で値から区切られます。変数は、アンパサンドで区切られます。

HTTP 変数は、サービス文のパラメータリスト内でホスト変数として明示的に宣言したり、サービス文のストアドプロシージャから HTTP_VARIABLE 関数を使用してアクセスしたりできます。

たとえば、次の SQL 文は、2 つのホスト変数を必要とする Web サービスを作成します。ホスト変数は、コロン (:) のプレフィクスで識別されます。

CREATE SERVICE ShowSalesOrderDetail
    TYPE 'HTML'
    URL OFF
    AUTHORIZATION OFF
    USER DBA 
    AS CALL ShowSalesOrderDetail( :customer_id, :product_id );

デフォルトのポートを介した localhost からデモデータベースで ShowSalesOrderDetail が実行されていると仮定した場合、次の URL を使用して Web サービスにアクセスできます。

http://localhost/demo/ShowSalesOrderDetail?customer_id=101&product_id=300

この URL は、ShowSalesOrderDetail にアクセスし、値 101 を customer_id に割り当て、値 300 を product_id に割り当てます。結果は、Web ブラウザに HTML フォーマットで表示されます。

備考

サーバへの接続にユーザ名とパスワードが必要な場合は、Web ブラウザから入力が求められます。ブラウザの base64 によりユーザ入力が認証要求ヘッダ内でエンコードされ、要求が再送信されます。

Web サービスの URL 句が ON または ELEMENTS に設定されている場合、path-name と url-query の URL 構文プロパティを同時に使用すると、異なるフォーマットオプションのいずれかを使用して Web サービスにアクセスできるようになります。これらの構文プロパティを同時に使用する場合は、path-name フォーマットを最初に使用し、その後で url-query フォーマットを使用する必要があります。

次の例に示す SQL 文は、URL 句が ON に設定され、url 変数を定義する Web サービスを作成します。

CREATE SERVICE ShowSalesOrderDetail
    TYPE 'HTML'
    URL ON
    AUTHORIZATION OFF
    USER DBA 
    AS CALL ShowSalesOrderDetail( :product_id, :url );

次に、url 値 101 と product_id 値 300 を割り当てる有効な URL のサンプルを示します。

http://localhost:80/demo/ShowSalesOrderDetail2/101?product_id=300
http://localhost:80/demo/ShowSalesOrderDetail2?url=101&product_id=300
http://localhost:80/demo/ShowSalesOrderDetail2?product_id=300&url=101

path-name と url-query のコンテキストでホスト変数名が複数回割り当てられていると、最後の割り当てが常に優先されます。たとえば、次のサンプル URL は、url 値 101 と product_id 値 300 を割り当てます。

http://localhost:80/demo/ShowSalesOrderDetail2/302?url=101&product_id=300
http://localhost:80/demo/ShowSalesOrderDetail2/String?product_id=300&url=101

参照

例

次の URL 構文は、gallery_image サービスが URL ON で定義されていると仮定した場合に、デフォルトのポートを介してローカル HTTP サーバ上の demo というデータベースで実行されている gallery_image という Web サービスにアクセスするために使用されます。

http://localhost/demo/gallery_image/sunset.jpg

この URL は、従来の Web サーバのディレクトリでグラフィックファイルを要求するように見えますが、HTTP Web サーバの入力パラメータとして sunset.jpg が指定された gallery_image サービスにアクセスします。

次の SQL 文は、この動作を実行するために、gallery サービスを HTTP サーバで定義する方法を示しています。

CREATE SERVICE gallery_image
    TYPE 'RAW'
    URL ON
    AUTHORIZATION OFF
    USER DBA 
    AS CALL gallery_image ( :url );

gallery_image サービスは、同じ名前でプロシージャを呼び出して、クライアントで指定された URL を渡します。この Web サービス定義によってアクセスできる gallery_image プロシージャの実装例については、%SQLANYSAMP16%\SQLAnywhere\HTTP\gallery.sql を参照してください。

DocCommentXchange で意見交換できます