wisdom.core.application
インタフェース IRequestHandler

すべてのスーパーインタフェース:

IHandler

既知の実装クラスの一覧:

RequestHandler

public interface IRequestHandler

extends IHandler

RequestCommandで使用できるアプリケーション情報の取得を定義したインターフェース
データソースへの接続、トランザクション管理、セッション情報へのアクセスをするためのインターフェースです。 このインターフェースのインスタンスは実行時に RunTimeServletによって生成されます。
セッション情報は ServletRuntimeConfig.isEnablesSession()がtrueのときに使用可能になります。falseのときに セッション情報へアクセスした場合、例外が送出されます。 2004/6/9 このインターフェースが持つメソッドがIHandlerになるために、一部のメソッドの定義 が削除されました。

バージョン:

1

作成者:

Takao Kouda

関連項目:

ServletRuntimeConfig

メソッドの概要

void	addUnremovableSessionAttributeName(java.lang.String key) セッション属性を除外不可として設定します ここで登録されたキー値はcleanupRemovableSessionAttributes()が実行されても セッション情報から除去されません
void	addUnremovableSessionAttributeNames(java.lang.String[] keys) セッション属性を除外不可として設定します ここで登録されたキー値はcleanupRemovableSessionAttributes()が実行されても セッション情報から除去されません
void	cleanupRemovableSessionAttributes() 除外不可として設定されていないセッション属性の値をすべてクリアします
IRequestCommand	getInvoker() このオブジェクトを使用しているRequestCommandのインスタンスを取得します
java.lang.String	getReqId() 実行中のIRequestCommandが持つreqidを取得します。
javax.servlet.http.HttpServletRequest	getRequest() 使用しているHttpServletRequestのインスタンスを取得します。
IRequestParser	getRequestParser() 使用しているIRequestParserインターフェースの実装オブジェクトを取得します。
javax.servlet.http.HttpServletResponse	getResponse() 使用しているHttpServletResonseのインスタンスを取得します。
javax.servlet.ServletConfig	getServletConfig() 使用しているServletConfig のインスタンスを取得します。
javax.servlet.ServletContext	getServletContext() このオブジェクトに含まれる ServletContext のインスタンスを返します。
java.lang.Object	getSessionAttribute(java.lang.String key) UserSession#getAttribute(key)を実行します
java.lang.Object	getSessionAttribute(java.lang.String key, boolean allowNull) UserSession#getAttribute(key,boolean)を実行します
java.util.List	getUnremovableSessionAttributeNames() 除外不可として設定されたセッション情報のキー値のString配列を取得します
IUserSession	getUserSession() IUserSessionオブジェクトを取得します。
void	removeSessionAttribute(java.lang.String key) UserSession#removeAttribute(key,object)を実行します
void	removeUnremovableSessionAttributeName(java.lang.String key) 除外不可対象として設定されたセッション情報のキー値を除外します
void	setSessionAttribute(java.lang.String key, java.lang.Object object) UserSession#setAttribute(key,object)を実行します

インタフェース wisdom.core.application.IHandler から継承したメソッド

closeConnection, getAttribute, getConnection, getConnection, getConnection, getConnection, getConnection, getConnection, getConnection, getConnection, setAttribute

メソッドの詳細

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

使用しているHttpServletRequestのインスタンスを取得します。

戻り値:

HttpServletRequestのインスタンス

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

使用しているHttpServletResonseのインスタンスを取得します。

戻り値:

HttpServletResponseのインスタンス

getRequestParser

public IRequestParser getRequestParser()

使用しているIRequestParserインターフェースの実装オブジェクトを取得します。

戻り値:

IRequestParser

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

使用しているServletConfig のインスタンスを取得します。

戻り値:

ServletConfigのインスタンス

getServletContext

public javax.servlet.ServletContext getServletContext()

このオブジェクトに含まれる ServletContext のインスタンスを返します。

戻り値:

ServletContext ServletContextのインスタンス

getReqId

public java.lang.String getReqId()

実行中のIRequestCommandが持つreqidを取得します。

戻り値:

rqid

getUserSession

public IUserSession getUserSession()

IUserSessionオブジェクトを取得します。

戻り値:

IUserSessionのインスタンス

setSessionAttribute

public void setSessionAttribute(java.lang.String key,
                                java.lang.Object object)

UserSession#setAttribute(key,object)を実行します

パラメータ:

key - 設定するキー

object - 設定するオブジェクト

removeSessionAttribute

public void removeSessionAttribute(java.lang.String key)

UserSession#removeAttribute(key,object)を実行します

パラメータ:

key - 除外するキー

getSessionAttribute

public java.lang.Object getSessionAttribute(java.lang.String key)
                                     throws MissingSessionObjectException

UserSession#getAttribute(key)を実行します

パラメータ:

key - 設定するキー

例外:

MissingSessionObjectException - 指定されたキーのオブジェクトがセッション情報にない場合に送出されます。

getSessionAttribute

public java.lang.Object getSessionAttribute(java.lang.String key,
                                            boolean allowNull)
                                     throws MissingSessionObjectException

UserSession#getAttribute(key,boolean)を実行します

パラメータ:

key - 設定するキー

allowNull - trueの場合、セッション情報にないとき例外送出ではなくnullが戻されます

例外:

MissingSessionObjectException - 指定されたキーのオブジェクトがセッション情報にない場合に送出されます。

cleanupRemovableSessionAttributes

public void cleanupRemovableSessionAttributes()

除外不可として設定されていないセッション属性の値をすべてクリアします

addUnremovableSessionAttributeName

public void addUnremovableSessionAttributeName(java.lang.String key)

セッション属性を除外不可として設定します
ここで登録されたキー値はcleanupRemovableSessionAttributes()が実行されても セッション情報から除去されません

パラメータ:

key - 除外不可として設定するセッション情報のキー値

addUnremovableSessionAttributeNames

public void addUnremovableSessionAttributeNames(java.lang.String[] keys)

セッション属性を除外不可として設定します
ここで登録されたキー値はcleanupRemovableSessionAttributes()が実行されても セッション情報から除去されません

パラメータ:

keys - 除外不可として設定するセッション情報のキー値の配列

removeUnremovableSessionAttributeName

public void removeUnremovableSessionAttributeName(java.lang.String key)

除外不可対象として設定されたセッション情報のキー値を除外します

パラメータ:

key - 除外対象から取り除くセッション情報のキー値

getUnremovableSessionAttributeNames

public java.util.List getUnremovableSessionAttributeNames()

除外不可として設定されたセッション情報のキー値のString配列を取得します

戻り値:

除外不可として設定されたセッション情報のキー値のString配列

getInvoker

public IRequestCommand getInvoker()

このオブジェクトを使用しているRequestCommandのインスタンスを取得します

戻り値:

RequestCommandのインスタンス