performメソッドを呼び出します。
* {@primary An Action is an adapter between the contents of an incoming
* HTTP request and the corresponding business logic that should be executed to
* process this request. The controller (ActionServlet) will select an
* appropriate Action for each request, create an instance (if necessary),
* and call the perform method.}
*
* コントローラは同時に発生した複数のリクエストに対して同一のインスタンスを共有するため、Actionはスレッドセーフであるようにプログラムすべきです。 * すなわち次の項目に従って設計すべきです。 *
* {@primaryActions must be programmed in a thread-safe manner, because the * controller will share the same instance for multiple simultaneous * requests. This means you should design with the following items in mind: *
} *Actionインスタンスが最初に生成される時、コントローラServletはそのActionが結びつけられるコントローラServletインスタンスを識別するためにnullでない引数とともにsetServlet()を呼び出します。
* コントローラServletがシャットダウン（または再起動）する時、そのActionに割り当てられている使用中のリソースをクリーンアップするためにsetServlet()がnullの引数とともに呼び出されます。
When an Action instance is first created, the controller
* servlet will call setServlet() with a non-null argument to
* identify the controller servlet instance to which this Action is attached.
* When the controller servlet is to be shut down (or restarted), the
* setServlet() method will be called with a null
* argument, which can be used to clean up any allocated resources in use
* by this Action.
ActionServletインスタンスが格納されているコンテキスト属性のキーです。
* {@primary The context attributes key under which our ActionServlet
* instance will be stored.}
* @deprecated 代わりにGlobals.ACTION_SERVLET_KEYを使用して下さい。
* {@primary Use Globals.ACTION_SERVLET_KEY instead.}
* @since Struts 1.1
*/
public static final String ACTION_SERVLET_KEY = Globals.ACTION_SERVLET_KEY;
/**
* ModuleConfigデータ構造が格納されるコンテキスト属性のキーのベース部分です。
* 実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス（先頭の"/"文字を含みます）が付加されます。
The base of the context attributes key under which our
* ModuleConfig data structure will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.
コントローラサーブレットによって処理される各リクエストについて、
* 現在処理しているリクエストURIによって選択されたモジュールに関する
* ModuleConfigオブジェクトはリクエスト属性としてもこのキーで公開されます。
For each request processed by the controller servlet, the
* ModuleConfig object for the module selected by
* the request URI currently being processed will also be exposed under
* this key as a request attribute.
javax.sql.DataSourceを実装している必要があります）が格納されているコンテキスト属性のキーです。
* {@primary The context attributes key under which our default
* configured data source (which must implement
* javax.sql.DataSource) is stored,
* if one is configured for this module.}
* @deprecated {@link org.apache.struts.Globals#DATA_SOURCE_KEY}に置き換えられました。
* {Replaced by {@link org.apache.struts.Globals#DATA_SOURCE_KEY}}
*/
public static final String DATA_SOURCE_KEY = Globals.DATA_SOURCE_KEY;
/**
* 対応するカスタムタグライブラリの要素を使用している場合、アクションがorg.apache.struts.action.ActionErrorsオブジェクトを格納すべきリクエスト属性のキーです。
* {@primary The request attributes key under which your action should store an
* org.apache.struts.action.ActionErrors object, if you
* are using the corresponding custom tag library elements.}
* @deprecated {@link org.apache.struts.Globals#ERROR_KEY}に置き換えられました。
* {@primary Replaced by {@link org.apache.struts.Globals#ERROR_KEY}}
*/
public static final String ERROR_KEY = Globals.ERROR_KEY;
/**
* Strutsのカスタムタグの中で実行時に生じたJspExceptionを報告するために生成されたThrowableを格納するリクエスト属性のキーです。この値は実際には何がうまくいかなかったのかということに関してより詳細な情報を提供するためにエラーページで使用できます。
* {@primary The request attributes key under which Struts custom tags might store a
* Throwable that caused them to report a JspException at
* runtime. This value can be used on an error page to provide more
* detailed information about what really went wrong.}
* @deprecated {@link org.apache.struts.Globals#EXCEPTION_KEY}に置き換えられました。
* {@primary Replaced by {@link org.apache.struts.Globals#EXCEPTION_KEY}}
*/
public static final String EXCEPTION_KEY = Globals.EXCEPTION_KEY;
/**
* ActionServletの初期化により上書きされるまで、
* org.apache.struts.action.ActionFormBeansコレクションが通常格納されているコンテキスト属性のキーです。
* {@primary The context attributes key under which our
* org.apache.struts.action.ActionFormBeans collection
* is normally stored, unless overridden when initializing our
* ActionServlet.}
*
* @deprecated ModuleConfigの中のコレクションに置き換えられました。
* {@primary Replaced by collection in ModuleConfig}
*/
public static final String FORM_BEANS_KEY = Globals.FORM_BEANS_KEY;
/**
* ActionServletの初期化により上書きされるまで、
* org.apache.struts.action.ActionForwardsコレクションが通常格納されているコンテキスト属性のキーです。
* {@primary The context attributes key under which our
* org.apache.struts.action.ActionForwards collection
* is normally stored, unless overridden when initializing our
* ActionServlet.}
*
* @deprecated ModuleConfigの中のコレクションに置き換えられました。
* {@primary Replaced by collection in ModuleConfig.}
*/
public static final String FORWARDS_KEY = Globals.FORWARDS_KEY;
/**
* ユーザが選択したjava.util.Localeがあればそれが格納されているセッション属性のキーです。
* この属性が見つからない場合、国際化されたメッセージを検索する際にはシステムのデフォルトのロケールが使用されます。
* この属性を利用する場合、典型的にはこの属性はユーザのログイン処理の際にセットされます。
* {@primary The session attributes key under which the user's selected
* java.util.Locale is stored, if any. If no such
* attribute is found, the system default locale
* will be used when retrieving internationalized messages. If used, this
* attribute is typically set during user login processing.}
* @deprecated {@link org.apache.struts.Globals#LOCALE_KEY}に置き換えられました。
* {@primary Replaced by {@link org.apache.struts.Globals#LOCALE_KEY}}
*/
public static final String LOCALE_KEY = Globals.LOCALE_KEY;
/**
* org.apache.struts.ActionMappingのインスタンスが渡されるリクエスト属性のキーです。
* {@primary The request attributes key under which our
* org.apache.struts.ActionMapping instance
* is passed.}
* @deprecated {@link org.apache.struts.Globals#MAPPING_KEY}に置き換えられました。
* {@primary Replaced by {@link org.apache.struts.Globals#MAPPING_KEY}}
*/
public static final String MAPPING_KEY = Globals.MAPPING_KEY;
/**
* ActionServletの初期化により上書きされるまで、
* org.apache.struts.action.ActionMappingsのコレクションが通常格納されているコンテキスト属性のキーです。
* {@primary The context attributes key under which our
* org.apache.struts.action.ActionMappings collection
* is normally stored, unless overridden when initializing our
* ActionServlet.}
*
* @deprecated ModuleConfigの中のコレクションに置き換えられました。
* {@primary Replaced by collection in ModuleConfig}
*/
public static final String MAPPINGS_KEY = Globals.MAPPINGS_KEY;
/**
* 対応するカスタムタグライブラリの要素を使用している場合、
* アクションがorg.apache.struts.action.ActionMessagesオブジェクトを格納すべきリクエスト属性のキーです。
* {@primary The request attributes key under which your action should store an
* org.apache.struts.action.ActionMessages object, if you
* are using the corresponding custom tag library elements.}
*
* @since Struts 1.1
* @deprecated {@link org.apache.struts.Globals#MESSAGE_KEY}に置き換えられました。
* {@primary Replaced by {@link org.apache.struts.Globals#MESSAGE_KEY}}
*/
public static final String MESSAGE_KEY = Globals.MESSAGE_KEY;
/**
* モジュールのMessageResourcesが格納されるコンテキスト属性のキーのベース部分です。
* 実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス（先頭の"/"文字を含みます）が付加されます。
The base of the context attributes key under which our
* module MessageResources will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual resources key.
コントローラサーブレットによって処理される各リクエストについて、
* 現在処理しているリクエストURIによって選択されたモジュールに関する
* ModuleConfigオブジェクトはリクエスト属性としてもこのキーで公開されます。
For each request processed by the controller servlet, the
* MessageResources object for the module selected by
* the request URI currently being processed will also be exposed under
* this key as a request attribute.
PlugInインスタンスの配列が格納されるコンテキスト属性のキーのベース部分です。
* 実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス（先頭の"/"文字を含みます）が付加されます。
* {@primary The base of the context attributes key under which an array of
* PlugIn instances will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.
RequestProcessorインスタンスが格納されるコンテキスト属性のキーのベース部分です。
* 実際の属性のキーを作成するために、この末尾に実際のモジュールプリフィクス（先頭の"/"文字を含みます）が付加されます。
The base of the context attributes key under which our
* RequestProcessor instance will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.
/action/*）もしくは拡張子マップ（extension mapped）パターン（*.do）のどちらかです。
* {@primary The context attributes key under which we store the mapping defined
* for our controller serlet, which will be either a path-mapped pattern
* (/action/*) or an extension mapped pattern
* (*.do).}
* @deprecated 代わりにGlobals.SERVLET_KEYを使用して下さい。
* {@primary Use Globals.SERVLET_KEY instead.}
*/
public static final String SERVLET_KEY = Globals.SERVLET_KEY;
/**
* トランザクショントークンが利用されている場合、
* それが格納されているセッション属性のキーです。
* {@primary The session attributes key under which our transaction token is
* stored, if it is used.}
* @deprecated 代わりに Globals.TRANSACTION_TOKEN_KEYを使用して下さい。
* {@primary Use Globals.TRANSACTION_TOKEN_KEY instead.}
*/
public static final String TRANSACTION_TOKEN_KEY =
Globals.TRANSACTION_TOKEN_KEY;
/**
* トークン機能のために使用されるTokenProcessorのインスタンスです。
* {@primary An instance of TokenProcessor to use for token functionality.}
* @TODO この変数をprotectedにしてActionのトークン関連のメソッドを削除するか、
* privateのままにしておいてトークン関連のメソッドが呼び出しを委譲するのを許可するか。
* {@primary We can make this variable protected and remove Action's token methods
* or leave it private and allow the token methods to delegate their calls.}
*/
private static TokenProcessor token = TokenProcessor.getInstance();
// ----------------------------------------------------- Instance Variables
/**
* システムのデフォルトのロケールです。
* {@primary The system default Locale.}
*/
protected static Locale defaultLocale = Locale.getDefault();
/**
* このActionに関連づけられているコントローラサーブレットです。
* {@primary The controller servlet to which we are attached.}
*/
protected ActionServlet servlet = null;
// ------------------------------------------------------------- Properties
/**
* このActionに関連づけられているコントローラサーブレットのインスタンスを返します。
* {@primary Return the controller servlet instance to which we are attached.}
*/
public ActionServlet getServlet() {
return (this.servlet);
}
/**
* （servletがnullでない場合）このActionに関連づけられているコントローラサーブレットのインスタンスをセットします。または（servletがnullである場合）このActionに関連づけられているリソースを解放します。
* {@primary Set the controller servlet instance to which we are attached (if
* servlet is non-null), or release any allocated resources
* (if servlet is null).}
*
* @param servlet もしあれば、新しいコントローラサーブレット
* {@primary The new controller servlet, if any}
*/
public void setServlet(ActionServlet servlet) {
this.servlet = servlet;
}
// --------------------------------------------------------- Public Methods
/**
* 指定された非HTTPリクエストを処理して、
* 対応する非HTTPレスポンスを生成します
* （またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします）。
* 併せてビジネスロジックがスローする例外のハンドリングも提供します。
* コントロールをどこにどうやってフォワードすべきかが記述された
* {@link ActionForward}インスタンスもしくは、
* レスポンスが既に完成している場合はnullを返します。
* {@primary Process the specified non-HTTP request, and create the
* corresponding non-HTTP response (or forward to another web
* component that will create it), with provision for handling
* exceptions thrown by the business logic.
* Return an {@link ActionForward} instance describing where and how
* control should be forwarded, or null if the response has
* already been completed.}
* * デフォルトの実装では、このメソッドのHTTPバージョンにフォワードします。 * {@primary
* The default implementation attempts to forward to the HTTP
* version of this method.}
*
* @param mapping このインスタンスを選択するために使用したActionMapping
* {@primary The ActionMapping used to select this instance}
* @param form 存在するならば、このリクエストのためのActionForm Bean
* {@primary The optional ActionForm bean for this request (if any)}
* @param request 処理している非HTTPリクエスト
* {@primary The non-HTTP request we are processing}
* @param response 処理している非HTTPレスポンス
* {@primary The non-HTTP response we are creating}
*
* @exception Exception アプリケーションのビジネスロジックが例外をスローした場合
* {@primary if the application business logic throws
* an exception}
* @since Struts 1.1
*/
public ActionForward execute(ActionMapping mapping,
ActionForm form,
ServletRequest request,
ServletResponse response)
throws Exception {
// Call the deprecated method for backwards compatibility
return (perform(mapping, form, request, response));
}
/**
* 指定されたHTTPリクエストを処理して、
* 対応するHTTPレスポンスを生成します
* （またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします）。
* 併せてビジネスロジックがスローする例外のハンドリングも提供します。
* コントロールをどこにどうやってフォワードすべきかが記述された
* {@link ActionForward}インスタンスもしくは、
* レスポンスが既に完成している場合はnullを返します。
* {@primary Process the specified HTTP request, and create the corresponding HTTP
* response (or forward to another web component that will create it),
* with provision for handling exceptions thrown by the business logic.
* Return an {@link ActionForward} instance describing where and how
* control should be forwarded, or null if the response
* has already been completed.}
*
* @param mapping このインスタンスを選択するために使用したActionMapping
* {@primary The ActionMapping used to select this instance}
* @param form 存在するならば、このリクエストのためのActionForm Bean
* {@primary The optional ActionForm bean for this request (if any)}
* @param request 処理しているHTTPリクエスト
* {@primary The HTTP request we are processing}
* @param response 処理しているHTTPレスポンス
* {@primary The HTTP response we are creating}
*
* @exception Exception アプリケーションのビジネスロジックが例外をスローした場合
* {@primary if the application business logic throws
* an exception}
* @since Struts 1.1
*/
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception {
// Call the deprecated method for backwards compatibility
return (perform(mapping, form, request, response));
}
/**
* 指定された非HTTPリクエストを処理して、
* 対応する非HTTPレスポンスを生成します
* （またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします）。
* コントロールをどこにどうやってフォワードすべきかが記述された
* {@link ActionForward}インスタンスもしくは、
* レスポンスが既に完成している場合はnullを返します。
* {@primary Process the specified non-HTTP request, and create the corresponding
* non-HTTP response (or forward to another web component that will create
* it). Return an ActionForward instance describing where
* and how control should be forwarded, or null if the
* response has already been completed.}
*
* デフォルトの実装では、このメソッドのHTTPバージョンにフォワードします。 * {@primary
* The default implementation attempts to forward to the HTTP version of
* this method.}
*
* @param mapping このインスタンスを選択するために使用したActionMapping
* {@primary The ActionMapping used to select this instance}
* @param form 存在するならば、このリクエストのためのActionForm Bean
* {@primary The optional ActionForm bean for this request (if any)}
* @param request 処理している非HTTPリクエスト
* {@primary The non-HTTP request we are processing}
* @param response 処理している非HTTPレスポンス
* {@primary The non-HTTP response we are creating}
*
* @exception IOException 入出力エラーが発生した
* @exception ServletException Servlet例外が発生した
* {@primary if an input/output error occurs}
* {@primary if a servlet exception occurs}
*
* @deprecated 代わりにexecute()メソッドを使用して下さい。
* {@primary Use the execute() method instead}
*/
public ActionForward perform(ActionMapping mapping,
ActionForm form,
ServletRequest request,
ServletResponse response)
throws IOException, ServletException {
try {
return (perform(mapping, form,
(HttpServletRequest) request,
(HttpServletResponse) response));
} catch (ClassCastException e) {
return (null);
}
}
/**
* 指定されたHTTPリクエストを処理して、
* 対応するHTTPレスポンスを生成します
* （もしくはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします）。
* コントロールをどこにどうやってフォワードするかが記述された
* ActionForwardインスタンスもしくは、
* レスポンスが既に完成している場合はnullを返します。
* {@primary Process the specified HTTP request, and create the corresponding HTTP
* response (or forward to another web component that will create it).
* Return an ActionForward instance describing where and how
* control should be forwarded, or null if the response has
* already been completed.}
*
* @param mapping このインスタンスを選択するために使用したアクションマッピング
* {@primary The ActionMapping used to select this instance}
* @param form 存在するならば、このリクエストのためのアクションフォームBean
* {@primary The optional ActionForm bean for this request (if any)}
* @param request 処理しているHTTPリクエスト
* {@primary The HTTP request we are processing}
* @param response 生成中のHTTPレスポンス
* {@primary The HTTP response we are creating}
*
* @exception IOException 入出力エラーが発生した
* {@primary if an input/output error occurs}
* @exception ServletException Servlet例外が発生した
* {@primary if a servlet exception occurs}
*
* @deprecated 代わりにexecute()メソッドを使用して下さい。
* {@primary Use the execute() method instead}
*/
public ActionForward perform(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
return (null); // Override this method to provide functionality
}
// ---------------------------------------------------- Protected Methods
/**
* 1つのトランザクションに対してリクエストが1つだけであるようにするために使用する、
* 新しいトランザクショントークンを生成します。
* {@primary Generate a new transaction token, to be used for enforcing a single
* request for a particular transaction.}
*
* @param request 処理しているサーブレットリクエスト
* {@primary The request we are processing}
*/
protected String generateToken(HttpServletRequest request) {
return token.generateToken(request);
}
/**
* 現在のモジュールのデフォルトのデータソースを返します。
* {@primary Return the default data source for the current module.}
*
* @param request 処理しているサーブレットリクエスト
* {@primary The servlet request we are processing}
*
* @since Struts 1.1
*/
protected DataSource getDataSource(HttpServletRequest request) {
return (getDataSource(request, Globals.DATA_SOURCE_KEY));
}
/**
* 現在のモジュールの指定されたデータソースを返します。
* {@primary Return the specified data source for the current module.}
*
* @param request 処理しているサーブレットリクエスト
* {@primary The servlet request we are processing}
* @param key 要求されているまとまりに対応する、
* <message-resources>要素の中で指定されているキー
* {@annotation このコメントはおかしいです。おそらくgetMessageResourcesからコメントをCopy&Pasteしてきたものと思われます。}
* {@primary The key specified in the
* <message-resources> element for the
* requested bundle}
*
* @since Struts 1.1
*/
protected DataSource getDataSource(HttpServletRequest request, String key) {
// Identify the current module
ServletContext context = getServlet().getServletContext();
ModuleConfig moduleConfig = RequestUtils.getModuleConfig(request,context);
// Return the requested data source instance
return ((DataSource) context.getAttribute(key + moduleConfig.getPrefix()));
}
/**
* ユーザの現在選択されているロケールを返します。
* {@primary Return the user's currently selected Locale.}
*
* @param request 処理しているサーブレットリクエスト
* {@primary The request we are processing}
*/
protected Locale getLocale(HttpServletRequest request) {
HttpSession session = request.getSession();
Locale locale = (Locale) session.getAttribute(Globals.LOCALE_KEY);
if (locale == null) {
locale = defaultLocale;
}
return (locale);
}
/**
* デフォルトモジュールのメッセージリソースを返します。
* {@primary Return the message resources for the default module.}
*
* @deprecated このメソッドはデフォルトモジュールのリソースを返すだけです。
* 現在のモジュールのリソースを取得するには
* getResources(HttpServletRequest)を使用して下さい。
* {@primary This method can only return the resources for the default
* module. Use getResources(HttpServletRequest) to get the
* resources for the current module.}
*/
protected MessageResources getResources() {
return ((MessageResources)
servlet.getServletContext().getAttribute(Globals.MESSAGES_KEY));
}
/**
* 現在のモジュールのメッセージリソースを返します。
* {@primary Return the default message resources for the current module.}
*
* @param request 処理しているサーブレットリクエスト
* {@primary The servlet request we are processing}
* @since Struts 1.1
*/
protected MessageResources getResources(HttpServletRequest request) {
return ((MessageResources) request.getAttribute(Globals.MESSAGES_KEY));
}
/**
* 現在のモジュールの指定されたメッセージリソースを返します。
* {@primary Return the specified message resources for the current module.}
*
* @param request 処理しているサーブレットリクエスト
* {@primary The servlet request we are processing}
* @param key 要求されているメッセージのまとまりに対応する、
* <message-resources>要素の中で指定されているキー
* {@primary The key specified in the
* <message-resources> element for the
* requested bundle}
*
* @since Struts 1.1
*/
protected MessageResources getResources(HttpServletRequest request,
String key) {
// Identify the current module
ServletContext context = getServlet().getServletContext();
ModuleConfig moduleConfig = RequestUtils.getModuleConfig(request,context);
// Return the requested message resources instance
return ((MessageResources) context.getAttribute
(key + moduleConfig.getPrefix()));
}
/**
*
現在のフォームのキャンセルボタンが押されていれば
* trueを返します。
* このメソッドは
* リクエスト属性Globals.CANCEL_KEY
* が設定されているかどうかをチェックします。
* この属性は通常、
* 現在のリクエストにおいて
* CancelTag
* が生成したキャンセルボタンをユーザが押した時に設定されます。
* trueの場合、コントローラサーブレットは
* ActionFormのvalidate()
* メソッドによるバリデーションをスキップします。
Returns true if the current form's cancel button was
* pressed. This method will check if the Globals.CANCEL_KEY
* request attribute has been set, which normally occurs if the cancel
* button generated by CancelTag was pressed by the user
* in the current request. If true, validation performed
* by an ActionForm's validate() method
* will have been skipped by the controller servlet.
trueを返します。
* 次のいずれかの場合はfalseを返します：
* true if there is a transaction token stored in
* the user's current session, and the value submitted as a request
* parameter with this action matches it. Returns false
* under any of the following circumstances:
* trueを返します。
* 次のいずれかの場合はfalseを返します：
* true if there is a transaction token stored in
* the user's current session, and the value submitted as a request
* parameter with this action matches it. Returns false
*