ヘッダーをスキップ
Oracle Database PL/SQLパッケージ・プロシージャおよびタイプ・リファレンス
11g リリース1(11.1)
E05686-02
  目次
目次
索引
索引

戻る
戻る
 
次へ
次へ
 

172 OWA_COOKIE

OWA_COOKIEパッケージでは、クライアントのブラウザからHTTP Cookieの送信および取得を行うインタフェースを提供します。


関連項目:

このパッケージの実装の詳細は、次のマニュアルを参照してください。
  • 『Oracle Fusion Middleware Administrator's Guide for Oracle HTTP Server』

  • 『Oracle Fusion Middleware User's Guide for mod_plsql』


この章では、次の項目について説明します。


OWA_COOKIEの使用方法


概要

Cookieとは、HTTPコール間の状態を維持するためにブラウザに送信される不透明な文字列です。状態は、クライアントのセッションの間維持されるか、または期限切れ日が含まれている場合はそれより長く維持されます。 システム日は、OWA_CUSTOMパッケージで指定された情報に対して計算されます。


データ型

このデータ型には、Cookieの名前/値ペアが含まれます。HTTP標準にはオーバーロードされたCookie名を許可する(すなわち同じCookie名に複数の値を関連付けられる)ため、PL/SQL RECORDは特定のCookie名に関連するすべての値を保持します。

TYPE vc_arr IS TABLE OF VARCHAR2(4000) INDEX BY BINARY_INTEGER.

TYPE COOKIE IS RECORD (
   name           VARCHAR2(4000),
   vals           vc_arr,
   num_vals       INTEGER);

ルールおよび制限

すべてのHTTPヘッダーは、英語およびASCII文字セットで使用する必要があります。ヘッダーがデータベースから生成された場合、それらが英語で作成されていることを確認する必要があります。


OWA_COOKIEサブプログラムの要約

表172-1 OWA_COOKIEパッケージのサブプログラム

サブプログラム 説明

GETファンクション


指定したCookieの値を取得します。

GET_ALLプロシージャ


Cookieの名前/値ペアを取得します。

REMOVEプロシージャ


指定されたCookieを削除します。

SENDプロシージャ


HTTPヘッダーのSet-Cookie行を生成します。



GETファンクション

このファンクションは、指定したCookieに関連付けられた値を戻します。 値は、OWA_COOKIE.COOKIEデータ型で戻されます。

構文

OWA_COOKIE.GET(
    name           IN       VARCHAR2)
  RETURN COOKIE;

パラメータ

表172-2 GETファンクションのパラメータ

パラメータ 説明

name

Cookieの名前。


戻り値

OWA_COOKIE.COOKIEデータ型。


GET_ALLプロシージャ

このプロシージャは、クライアントのブラウザからすべてのCookie名およびその値を戻します。値は、ブラウザから送信された順序で表示されます。

構文

OWA_COOKIE.GET_ALL(
   names          OUT      vc_arr,
   vals           OUT      vc_arr,
   num_vals       OUT      INTEGER);

パラメータ

表172-3 GET_ALLプロシージャのパラメータ

パラメータ 説明

names

Cookieの名前。

vals

Cookieの値。

num_vals

Cookie/値ペアの数。



REMOVEプロシージャ

このプロシージャは、HTTPヘッダーのSet-Cookie行のexpiresフィールドを01-Jan-1990に設定することにより、Cookieを即時に期限切れにします。このプロシージャは、HTTPヘッダーのコンテキスト内でコールされます。

構文

OWA_COOKIE.REMOVE(
   name           IN       VARCHAR2,
   val            IN       VARCHAR2,
   path           IN       VARCHAR2   DEFAULT NULL);

パラメータ

表172-4 REMOVEプロシージャのパラメータ

パラメータ 説明

name

期限切れするCookieの名前。

val

Cookieの値。

path

(現在は使用されていません。)



SENDプロシージャ

このプロシージャは、Cookieをクライアントに送信するSet-Cookie行を生成します。このプロシージャは、HTTPヘッダーのコンテキスト内で発生します。

構文

OWA_COOKIE.SEND(
   name           in       varchar2,
   value          in       varchar2,
   expires        in       date       DEFAULT NULL,
   path           in       varchar2   DEFAULT NULL,
   domain         in       varchar2   DEFAULT NULL,
   secure         in       varchar2   DEFAULT NULL);

パラメータ

表172-5 SENDプロシージャのパラメータ

パラメータ 説明

name

Cookieの名前。

value

Cookieの値。

expires

Cookieの期限が切れる日付。

path

パス・フィールドの値。

domain

ドメイン・フィールドの値。

secure

このパラメータの値がNULLでない場合、行にはsecureフィールドが追加されます。