|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectorg.apache.struts.action.Action
ActionはHTTPリクエストの内容とそのリクエストを処理するために実行されるべきビジネスロジックとの間のアダプタクラスです。
コントローラ(ActionServlet)はリクエストに適切なActionを選択して(必要に応じて)インスタンスを生成し、performメソッドを呼び出します。
コントローラは同時に発生した複数のリクエストに対して同一のインスタンスを共有するため、Actionはスレッドセーフであるようにプログラムすべきです。 すなわち次の項目に従って設計すべきです。
Actionインスタンスが最初に生成される時、コントローラServletはそのActionが結びつけられるコントローラServletインスタンスを識別するためにnullでない引数とともにsetServlet()を呼び出します。
コントローラServletがシャットダウン(または再起動)する時、そのActionに割り当てられている使用中のリソースをクリーンアップするためにsetServlet()がnullの引数とともに呼び出されます。
| フィールドの概要 | |
static java.lang.String |
ACTION_SERVLET_KEY
推奨されていません。 代わりにGlobals.ACTION_SERVLET_KEYを使用して下さい。 |
static java.lang.String |
APPLICATION_KEY
推奨されていません。 Globals.MODULE_KEYに置き換えられました。
|
static java.lang.String |
DATA_SOURCE_KEY
推奨されていません。 Globals.DATA_SOURCE_KEYに置き換えられました。
{Replaced by Globals.DATA_SOURCE_KEY} |
protected static java.util.Locale |
defaultLocale
システムのデフォルトのロケールです。 |
static java.lang.String |
ERROR_KEY
推奨されていません。 Globals.ERROR_KEYに置き換えられました。
|
static java.lang.String |
EXCEPTION_KEY
推奨されていません。 Globals.EXCEPTION_KEYに置き換えられました。
|
static java.lang.String |
FORM_BEANS_KEY
推奨されていません。 ModuleConfigの中のコレクションに置き換えられました。 |
static java.lang.String |
FORWARDS_KEY
推奨されていません。 ModuleConfigの中のコレクションに置き換えられました。 |
static java.lang.String |
LOCALE_KEY
推奨されていません。 Globals.LOCALE_KEYに置き換えられました。
|
static java.lang.String |
MAPPING_KEY
推奨されていません。 Globals.MAPPING_KEYに置き換えられました。
|
static java.lang.String |
MAPPINGS_KEY
推奨されていません。 ModuleConfigの中のコレクションに置き換えられました。 |
static java.lang.String |
MESSAGE_KEY
推奨されていません。 Globals.MESSAGE_KEYに置き換えられました。
|
static java.lang.String |
MESSAGES_KEY
推奨されていません。 代わりにGlobals.MESSAGES_KEYを使用して下さい。 |
static java.lang.String |
MULTIPART_KEY
推奨されていません。 代わりにGlobals.MULTIPART_KEYを使用して下さい。 |
static java.lang.String |
PLUG_INS_KEY
推奨されていません。 Globals.PLUG_INS_KEYに置き換えられました。
|
static java.lang.String |
REQUEST_PROCESSOR_KEY
推奨されていません。 代わりにGlobals.REQUEST_PROCESSOR_KEYを使用して下さい。 |
protected ActionServlet |
servlet
このActionに関連づけられているコントローラサーブレットです。 |
static java.lang.String |
SERVLET_KEY
推奨されていません。 代わりにGlobals.SERVLET_KEYを使用して下さい。 |
private static TokenProcessor |
token
トークン機能のために使用されるTokenProcessorのインスタンスです。 |
static java.lang.String |
TRANSACTION_TOKEN_KEY
推奨されていません。 代わりに Globals.TRANSACTION_TOKEN_KEYを使用して下さい。 |
| コンストラクタの概要 | |
Action()
|
|
| メソッドの概要 | |
ActionForward |
execute(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
指定されたHTTPリクエストを処理して、 対応するHTTPレスポンスを生成します (またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします)。 |
ActionForward |
execute(ActionMapping mapping,
ActionForm form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
指定された非HTTPリクエストを処理して、 対応する非HTTPレスポンスを生成します (またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします)。 |
protected java.lang.String |
generateToken(javax.servlet.http.HttpServletRequest request)
1つのトランザクションに対してリクエストが1つだけであるようにするために使用する、 新しいトランザクショントークンを生成します。 |
protected javax.sql.DataSource |
getDataSource(javax.servlet.http.HttpServletRequest request)
現在のモジュールのデフォルトのデータソースを返します。 |
protected javax.sql.DataSource |
getDataSource(javax.servlet.http.HttpServletRequest request,
java.lang.String key)
現在のモジュールの指定されたデータソースを返します。 |
protected java.util.Locale |
getLocale(javax.servlet.http.HttpServletRequest request)
ユーザの現在選択されているロケールを返します。 |
protected MessageResources |
getResources()
推奨されていません。 このメソッドはデフォルトモジュールのリソースを返すだけです。 現在のモジュールのリソースを取得するには getResources(HttpServletRequest)を使用して下さい。 |
protected MessageResources |
getResources(javax.servlet.http.HttpServletRequest request)
現在のモジュールのメッセージリソースを返します。 |
protected MessageResources |
getResources(javax.servlet.http.HttpServletRequest request,
java.lang.String key)
現在のモジュールの指定されたメッセージリソースを返します。 |
ActionServlet |
getServlet()
このActionに関連づけられているコントローラサーブレットのインスタンスを返します。 |
protected boolean |
isCancelled(javax.servlet.http.HttpServletRequest request)
現在のフォームのキャンセルボタンが押されていれば trueを返します。
|
protected boolean |
isTokenValid(javax.servlet.http.HttpServletRequest request)
ユーザの現在のセッションにトランザクショントークンが保持されていて、 かつこのアクションのリクエストパラメータとして送信された値がそのトークンとマッチする場合に trueを返します。
|
protected boolean |
isTokenValid(javax.servlet.http.HttpServletRequest request,
boolean reset)
ユーザの現在のセッションにトランザクショントークンが保持されていて、 かつこのアクションのリクエストパラメータとして送信された値がそのトークンとマッチする場合に trueを返します。
|
ActionForward |
perform(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
推奨されていません。 代わりに execute()メソッドを使用して下さい。
|
ActionForward |
perform(ActionMapping mapping,
ActionForm form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
推奨されていません。 代わりに execute()メソッドを使用して下さい。
|
protected void |
resetToken(javax.servlet.http.HttpServletRequest request)
ユーザのセッションに保存されているトランザクショントークンをリセットします。 |
protected void |
saveErrors(javax.servlet.http.HttpServletRequest request,
ActionErrors errors)
なんらかのエラーメッセージが必要な場合、 <html:errors>タグが利用できるように、 指定されたエラーメッセージキーを適切なリクエスト属性に保存します。 |
protected void |
saveMessages(javax.servlet.http.HttpServletRequest request,
ActionMessages messages)
なんらかのメッセージが必要な場合、 (messages="true"が設定されていれば) <html:errors>タグが利用できるように、 指定されたメッセージキーを適切なリクエスト属性に保存します。 |
protected void |
saveToken(javax.servlet.http.HttpServletRequest request)
ユーザの現在のセッションに新しいトランザクショントークンを保存します。 |
protected void |
setLocale(javax.servlet.http.HttpServletRequest request,
java.util.Locale locale)
ユーザの現在選択されているロケールを設定します。 |
void |
setServlet(ActionServlet servlet)
( servletがnullでない場合)このActionに関連づけられているコントローラサーブレットのインスタンスをセットします。 |
protected java.lang.String |
toHex(byte[] buffer)
推奨されていません。 このメソッドはStruts1.1以降のリリースでは削除されるでしょう。 |
| クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| フィールドの詳細 |
public static final java.lang.String ACTION_SERVLET_KEY
ActionServletインスタンスが格納されているコンテキスト属性のキーです。
public static final java.lang.String APPLICATION_KEY
Globals.MODULE_KEYに置き換えられました。
ModuleConfigデータ構造が格納されるコンテキスト属性のキーのベース部分です。
実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス(先頭の"/"文字を含みます)が付加されます。
コントローラサーブレットによって処理される各リクエストについて、
現在処理しているリクエストURIによって選択されたモジュールに関する
ModuleConfigオブジェクトはリクエスト属性としてもこのキーで公開されます。
public static final java.lang.String DATA_SOURCE_KEY
Globals.DATA_SOURCE_KEYに置き換えられました。
{Replaced by Globals.DATA_SOURCE_KEY}
javax.sql.DataSourceを実装している必要があります)が格納されているコンテキスト属性のキーです。
public static final java.lang.String ERROR_KEY
Globals.ERROR_KEYに置き換えられました。
org.apache.struts.action.ActionErrorsオブジェクトを格納すべきリクエスト属性のキーです。
public static final java.lang.String EXCEPTION_KEY
Globals.EXCEPTION_KEYに置き換えられました。
Throwableを格納するリクエスト属性のキーです。この値は実際には何がうまくいかなかったのかということに関してより詳細な情報を提供するためにエラーページで使用できます。
public static final java.lang.String FORM_BEANS_KEY
org.apache.struts.action.ActionFormBeansコレクションが通常格納されているコンテキスト属性のキーです。
public static final java.lang.String FORWARDS_KEY
org.apache.struts.action.ActionForwardsコレクションが通常格納されているコンテキスト属性のキーです。
public static final java.lang.String LOCALE_KEY
Globals.LOCALE_KEYに置き換えられました。
java.util.Localeがあればそれが格納されているセッション属性のキーです。
この属性が見つからない場合、国際化されたメッセージを検索する際にはシステムのデフォルトのロケールが使用されます。
この属性を利用する場合、典型的にはこの属性はユーザのログイン処理の際にセットされます。
public static final java.lang.String MAPPING_KEY
Globals.MAPPING_KEYに置き換えられました。
org.apache.struts.ActionMappingのインスタンスが渡されるリクエスト属性のキーです。
public static final java.lang.String MAPPINGS_KEY
org.apache.struts.action.ActionMappingsのコレクションが通常格納されているコンテキスト属性のキーです。
public static final java.lang.String MESSAGE_KEY
Globals.MESSAGE_KEYに置き換えられました。
org.apache.struts.action.ActionMessagesオブジェクトを格納すべきリクエスト属性のキーです。
public static final java.lang.String MESSAGES_KEY
モジュールのMessageResourcesが格納されるコンテキスト属性のキーのベース部分です。
実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス(先頭の"/"文字を含みます)が付加されます。
コントローラサーブレットによって処理される各リクエストについて、
現在処理しているリクエストURIによって選択されたモジュールに関する
ModuleConfigオブジェクトはリクエスト属性としてもこのキーで公開されます。
public static final java.lang.String MULTIPART_KEY
public static final java.lang.String PLUG_INS_KEY
Globals.PLUG_INS_KEYに置き換えられました。
PlugInインスタンスの配列が格納されるコンテキスト属性のキーのベース部分です。
実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス(先頭の"/"文字を含みます)が付加されます。
public static final java.lang.String REQUEST_PROCESSOR_KEY
RequestProcessorインスタンスが格納されるコンテキスト属性のキーのベース部分です。
実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス(先頭の"/"文字を含みます)が付加されます。
public static final java.lang.String SERVLET_KEY
/action/*)もしくは拡張子マップ(extension mapped)パターン(*.do)のどちらかです。
public static final java.lang.String TRANSACTION_TOKEN_KEY
private static TokenProcessor token
protected static java.util.Locale defaultLocale
protected ActionServlet servlet
| コンストラクタの詳細 |
public Action()
| メソッドの詳細 |
public ActionServlet getServlet()
public void setServlet(ActionServlet servlet)
servletがnullでない場合)このActionに関連づけられているコントローラサーブレットのインスタンスをセットします。または(servletがnullである場合)このActionに関連づけられているリソースを解放します。
servlet - もしあれば、新しいコントローラサーブレット
public ActionForward execute(ActionMapping mapping,
ActionForm form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
throws java.lang.Exception
ActionForwardインスタンスもしくは、
レスポンスが既に完成している場合はnullを返します。
デフォルトの実装では、このメソッドのHTTPバージョンにフォワードします。
mapping - このインスタンスを選択するために使用したActionMapping
form - 存在するならば、このリクエストのためのActionForm Bean
request - 処理している非HTTPリクエスト
response - 処理している非HTTPレスポンス
java.lang.Exception - アプリケーションのビジネスロジックが例外をスローした場合
public ActionForward execute(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception
ActionForwardインスタンスもしくは、
レスポンスが既に完成している場合はnullを返します。
mapping - このインスタンスを選択するために使用したActionMapping
form - 存在するならば、このリクエストのためのActionForm Bean
request - 処理しているHTTPリクエスト
response - 処理しているHTTPレスポンス
java.lang.Exception - アプリケーションのビジネスロジックが例外をスローした場合
public ActionForward perform(ActionMapping mapping,
ActionForm form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
throws java.io.IOException,
javax.servlet.ServletException
execute()メソッドを使用して下さい。
ActionForwardインスタンスもしくは、
レスポンスが既に完成している場合はnullを返します。
デフォルトの実装では、このメソッドのHTTPバージョンにフォワードします。
mapping - このインスタンスを選択するために使用したActionMapping
form - 存在するならば、このリクエストのためのActionForm Bean
request - 処理している非HTTPリクエスト
response - 処理している非HTTPレスポンス
java.io.IOException - 入出力エラーが発生した
javax.servlet.ServletException - Servlet例外が発生した
public ActionForward perform(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.io.IOException,
javax.servlet.ServletException
execute()メソッドを使用して下さい。
ActionForwardインスタンスもしくは、
レスポンスが既に完成している場合はnullを返します。
mapping - このインスタンスを選択するために使用したアクションマッピング
form - 存在するならば、このリクエストのためのアクションフォームBean
request - 処理しているHTTPリクエスト
response - 生成中のHTTPレスポンス
java.io.IOException - 入出力エラーが発生した
javax.servlet.ServletException - Servlet例外が発生した
protected java.lang.String generateToken(javax.servlet.http.HttpServletRequest request)
request - 処理しているサーブレットリクエスト
protected javax.sql.DataSource getDataSource(javax.servlet.http.HttpServletRequest request)
request - 処理しているサーブレットリクエスト
protected javax.sql.DataSource getDataSource(javax.servlet.http.HttpServletRequest request,
java.lang.String key)
request - 処理しているサーブレットリクエスト
key - 要求されているまとまりに対応する、
<message-resources>要素の中で指定されているキー
protected java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request)
request - 処理しているサーブレットリクエスト
protected MessageResources getResources()
protected MessageResources getResources(javax.servlet.http.HttpServletRequest request)
request - 処理しているサーブレットリクエスト
protected MessageResources getResources(javax.servlet.http.HttpServletRequest request,
java.lang.String key)
request - 処理しているサーブレットリクエスト
key - 要求されているメッセージのまとまりに対応する、
<message-resources>要素の中で指定されているキー
protected boolean isCancelled(javax.servlet.http.HttpServletRequest request)
現在のフォームのキャンセルボタンが押されていれば
trueを返します。
このメソッドは
リクエスト属性Globals.CANCEL_KEY
が設定されているかどうかをチェックします。
この属性は通常、
現在のリクエストにおいて
CancelTag
が生成したキャンセルボタンをユーザが押した時に設定されます。
trueの場合、コントローラサーブレットは
ActionFormのvalidate()
メソッドによるバリデーションをスキップします。
request - 処理しているサーブレットリクエスト
CancelTagprotected boolean isTokenValid(javax.servlet.http.HttpServletRequest request)
trueを返します。
次のいずれかの場合はfalseを返します:
request - 処理しているサーブレットリクエスト
protected boolean isTokenValid(javax.servlet.http.HttpServletRequest request,
boolean reset)
trueを返します。
次のいずれかの場合はfalseを返します:
request - 処理しているサーブレットリクエスト
reset - チェックの後にトークンをリセットするべきか?
protected void resetToken(javax.servlet.http.HttpServletRequest request)
request - 処理しているサーブレットリクエスト
protected void saveErrors(javax.servlet.http.HttpServletRequest request,
ActionErrors errors)
request - 処理しているサーブレットリクエスト
errors - エラーメッセージオブジェクト
protected void saveMessages(javax.servlet.http.HttpServletRequest request,
ActionMessages messages)
request - 処理しているサーブレットリクエスト
{The servlet request we are processing}messages - メッセージオブジェクト
{Messages object}protected void saveToken(javax.servlet.http.HttpServletRequest request)
request - 処理しているサーブレットリクエスト
protected void setLocale(javax.servlet.http.HttpServletRequest request,
java.util.Locale locale)
request - 処理しているリクエスト
locale - 設定される、ユーザの現在選択されているロケール。
サーバのデフォルトのロケールを選択する場合はnull
protected java.lang.String toHex(byte[] buffer)
buffer - 変換するbyteの配列
|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||