jp.terasoluna.fw.web.struts.actions
クラス ClearSessionAction

java.lang.Object
  上位を拡張 org.apache.struts.action.Action
      上位を拡張 jp.terasoluna.fw.web.struts.actions.ActionEx
          上位を拡張 jp.terasoluna.fw.web.struts.actions.ClearSessionAction

public class ClearSessionAction
extends ActionEx

セッションから指定されたプロパティを削除する。

Bean定義ファイルに指定されたキーのリストから、 セッションより削除するキーを取得し削除を行う。

遷移先は、常に<action>要素の parameter属性に指定されたアドレスにフォワードするため、 parameter属性が必須となる。 続いて、下記はBean定義ファイル及びstruts-config.xmlの 設定例である。

Bean定義ファイルのClearSessionAction設定例

 <bean name="/clearSessionAction" scope="singleton"
   class="jp.terasoluna.fw.web.struts.actions.ClearSessionAction">
   <property name="clearSessionKeys">
   <list>
     <value>userAddress</value>
     <value>userPhoneNo</value>
     <value>sampleSession</value>
   </list>
   </property>
 </bean>
 

struts-config.xmlの設定例

 <action path="/clearSessionAction"
   name="_sampleForm"
   scope="session"
   parameter="/sessionCleared.do">
 </action>
 
上記設定により、アクションパス名"/clearSessionAction" が実行されると、clearSessionKeysプロパティが削除対象のキー となり、その結果、userAddress、userPhoneNo、sampleSessionという 3つのセッションキーから参照されるセッション情報が削除される。
現在のセッションそのものを破棄する場合は、LogoffActionを参照のこと。

関連項目:
LogoffAction

フィールドの概要
private  java.util.List clearSessionKeys
          セッションから削除するキーのリスト。
private static java.lang.String FORWARD_ERRORPAGE_ERROR
          エラーページ(404)遷移失敗を示すエラーコード。
private static org.apache.commons.logging.Log log
          ログクラス。
 
クラス jp.terasoluna.fw.web.struts.actions.ActionEx から継承されたフィールド
FORWARD_TXTOKEN_ERROR
 
クラス org.apache.struts.action.Action から継承されたフィールド
defaultLocale, servlet
 
コンストラクタの概要
ClearSessionAction()
           
 
メソッドの概要
 org.apache.struts.action.ActionForward doExecute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          セッションクリアを行い、次画面へフォワードする。
 void setClearSessionKeys(java.util.List clearSessionKeys)
          セッションから削除するキーのリストを設定。
 
クラス jp.terasoluna.fw.web.struts.actions.ActionEx から継承されたメソッド
addErrors, addMessages, execute, isSaveToken, isTokenCheck, processTokenCheck, setSaveToken, setTokenCheck
 
クラス org.apache.struts.action.Action から継承されたメソッド
addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

log

private static org.apache.commons.logging.Log log
ログクラス。


FORWARD_ERRORPAGE_ERROR

private static final java.lang.String FORWARD_ERRORPAGE_ERROR
エラーページ(404)遷移失敗を示すエラーコード。

関連項目:
定数フィールド値

clearSessionKeys

private java.util.List clearSessionKeys
セッションから削除するキーのリスト。

コンストラクタの詳細

ClearSessionAction

public ClearSessionAction()
メソッドの詳細

setClearSessionKeys

public void setClearSessionKeys(java.util.List clearSessionKeys)
セッションから削除するキーのリストを設定。

パラメータ:
clearSessionKeys - セッションから削除するキーのリスト

doExecute

public org.apache.struts.action.ActionForward doExecute(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
セッションクリアを行い、次画面へフォワードする。

削除対象のキーが1つも見つからない場合は、 遷移先情報を返却し、処理を終了する。

定義:
クラス ActionEx 内の doExecute
パラメータ:
mapping - アクションマッピング
form - アクションフォーム
request - HTTPリクエスト
response - HTTPレスポンス
戻り値:
遷移先情報