oracle.lite.web.servlet
インタフェース OraUserProfile

public interface OraUserProfile

extends java.security.Principal

このインタフェースは、Oracle Web-to-Goシステム内でのユーザー・プロファイルの動作を定義します。 Oracle Web-to-Goシステムは、ユーザーがシステムにログオンしたときに、ユーザーがアクセス可能なアプリケーションの全サーブレットをリポジトリからロードします。 これらのサーブレットは、ユーザーがOracle Web-to-Goシステムからログアウトするまで、そのユーザーのコンテキスト内で実行されます。 Oracle Web-to-Goではシステム内のアプリケーションごとにサーブレットのインスタンスを1つしか保持しませんが、そのインスタンスのコンテキストはそのユーザー固有のものです。 サーブレットではユーザー固有の情報へのアクセスにこのインタフェースを使用する必要があります。 サーブレットでは、サーブレット起動メソッド（doGet、doPost、serviceなど）に渡されるOraHttpServletRequestからこのプロファイル・オブジェクトを取得できます。 OraHttpServletRequestインタフェースにより定義されているメソッドにアクセスするには、要求パラメータ（HttpServletRequest）の型をOraHttpServletRequestオブジェクトにキャストします。 Oracle Web-to-Goシステムで実行されるアプリケーションごとに、別個のユーザー・プロファイル・オブジェクトが作成されます。 HttpServletRequestクラスは、SunのJava Servlet SDKに説明されています。

フィールドの概要

static java.lang.String

FULL_NAME ユーザーのフル・ネーム。

メソッドの概要

OraHttpRequest	createHttpRequest(java.lang.String url) 別のサーブレットまたはアプリケーションをコールするためのHTTP要求オブジェクトを作成します。
java.lang.String	getAppletSessionId(javax.servlet.http.HttpServletRequest req) アプリケーションは、アプレットのセッションIDの取出しにこのメソッドを使用できます。
OraApplication	getApplication() アプリケーションは、アプリケーション・オブジェクトの取出しにこのメソッドを使用できます。
java.sql.Connection	getConnection() このメソッドは、現在のアブリケーションのJDBC接続の取出しに使用できます。
java.lang.String	getMode() Oracle Web-to-Goシステムでは、ユーザーはオンライン・モードかオフライン（切断）モードのいずれかで操作できます。
java.lang.String	getPreference(java.lang.String name) このメソッドは、ユーザー設定情報の取出しに使用できます。
java.util.Vector	getRoles() 各ユーザーはアプリケーションに対して一連のロール（1つ以上）を持ちます。
java.lang.Object	getValue(java.lang.String name) このメソッドを使用して、サーブレットでユーザーの名前/値ペアを取り出せます。
void	putValue(java.lang.String name, java.lang.Object value) このメソッドを使用して、サーブレットでユーザー固有のデータを格納できます。
void	removeValue(java.lang.String name) 現在のプロファイルから既存の名前/値ペアを削除します。

インタフェースjava.security.Principalから継承するメソッド

equals, getName, hashCode, toString

フィールドの詳細

FULL_NAME

public static final java.lang.String FULL_NAME 

ユーザーのフル・ネーム。

メソッドの詳細

getMode

public java.lang.String getMode() 

Oracle Web-to-Goシステムでは、ユーザーはオンライン・モードかオフライン（切断）モードのいずれかで操作できます。 このメソッドは、ログオン・ユーザーのモードの判別に使用できます。

戻り値:

ユーザーのモード。ユーザーがオンラインの場合は「ON」、オフラインの場合は「OFF」。

getPreference

public java.lang.String getPreference(java.lang.String name) 

このメソッドは、ユーザー設定情報の取出しに使用できます。 Oracle Web-to-Goシステムで使用できる設定名は前述のとおりです。

パラメータ:

name - 設定名。

戻り値:

文字列で表された設定の値。

createHttpRequest

public OraHttpRequest createHttpRequest(java.lang.String url)
                                 throws java.io.IOException 

別のサーブレットまたはアプリケーションをコールするためのHTTP要求オブジェクトを作成します。 ターゲット・サーブレットは同一マシン上でも別マシン上でもかまいません。

パラメータ:

url - 起動される仮想パスまたは完全なURL。 宛先URLが同じOracle Web-to-Goサーバー内にある場合は、URLに仮想パスのみを指定できます。

戻り値:

指定されたURLのOraRequestオブジェクト。

例外:

java.io.IOException - 例外が発生した場合に発生します。

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value) 

このメソッドを使用して、サーブレットでユーザー固有のデータを保存できます。 このユーザー・コンテキストで保存された名前/値ペアは、すべてのユーザー・セッションで共有されます。

パラメータ:

name - 名前/値ペアの名前。

len - 名前/値ペアの値。

getValue

public java.lang.Object getValue(java.lang.String name) 

このメソッドを使用して、サーブレットでユーザーの名前/値ペアを取り出せます。 その値は、すべてのユーザー・セッションで共有されます。

パラメータ:

name - 名前/値ペアの名前。

戻り値:

指定された名前の（STOREから設定またはロードされている）値。

removeValue

public void removeValue(java.lang.String name) 

カレント・プロファイルから既存の名前/値ペアを削除します。

パラメータ:

name - 削除される名前/値ペアの名前。

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException 

このメソッドは、現在のアプリケーションのJDBC接続の取出しに使用できます。 接続オブジェクトは、各アプリケーションで1セッション、1ユーザーにつき1つ作成されます。 接続オブジェクトは、このメソッドが初めてコールされたときに作成されます。

戻り値:

JDBC接続オブジェクト。

例外:

java.sql.SQLException - データベースに接続できなかった場合に発生します。

getRoles

public java.util.Vector getRoles() 

各ユーザーはアプリケーションに対して一連のロール（1つ以上）を持ちます。 このメソッドは、現在のアプリケーションのロールの取出しに使用できます。

戻り値:

現在のアプリケーションのユーザー・ロールのベクトル。

getApplication

public OraApplication getApplication() 

アプリケーションでは、Applicationオブジェクトの取出しにこのメソッドを使用できます。

戻り値:

アプリケーションのデータベース・ユーザー名。

getAppletSessionId

public java.lang.String getAppletSessionId(javax.servlet.http.HttpServletRequest req) 

アプリケーションでは、アプレットのセッションIDの取出しにこのメソッドを使用できます。

戻り値:

アプリケーションのセッションIDを文字列として返します。