Actionは、受信した
* HTTPリクエストの内容とそのリクエストを処理するために実行されるべきビジネスロジックを適合させます。
* コントローラ(RequestProcessor)は、
* それぞれのリクエストに適切なActionを選択して(必要に応じて)インスタンスを生成し、
* executeメソッドを呼び出します。
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 (RequestProcessor) will select an
* appropriate Action for each request, create an instance (if necessary),
* and call the execute 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インスタンスが最初に生成される時、
* コントローラはそのActionが関連付けられたサーブレットインスタンスを識別するため、
* nullでない引数でsetServletメソッドを呼び出します
* サーブレットをシャットダウン(または再起動)する時、
* Actionに割り当てられている使用中のリソースをすべてクリーンアップするため、
* nullを引数にsetServletメソッドを呼び出します。
When an Action instance is first created, the controller
* will call setServlet with a non-null argument to
* identify the servlet instance to which this Action is attached.
* When the 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.
トークン機能で使用されるTokenProcessorのインスタンス。
An instance of TokenProcessor to use for token functionality.
システムのデフォルトLocale。
* {@primaryThe system default Locale.
} * * @deprecated Locale.getDefaultを直接使ってください。 * Struts 1.2.より後で削除されます。 * {@primary @deprecated Use Locale.getDefault directly. This will be removed after * Struts 1.2.} */ protected static Locale defaultLocale = Locale.getDefault(); // :TODO: Remove after Struts 1.2 /** *関連付けられたサーブレット。
* {@primaryThe servlet to which we are attached.
} */ protected ActionServlet servlet = null; // ------------------------------------------------------------- Properties /** *関連付けられたサーブレットのインスタンスを返します。
* {@primaryReturn the servlet instance to which we are attached.
} */ public ActionServlet getServlet() { return (this.servlet); } /** *(servletがnullでない場合)関連付けられたサーブレットのインスタンスを設定します。
* (servletがnullの場合)関連付けられたサーブレットのインスタンスを解放します。
Set the servlet instance to which we are attached (if
* servlet is non-null), or release any allocated resources
* (if servlet is null).
指定された非HTTPリクエストを処理して、
* 対応する非HTTPレスポンスを生成します。
* (またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします。)
* 併せてビジネスロジックがスローする例外のハンドリングも提供します。
* コントロールをどこに/どうやってフォワードすべきかが記述された{@link ActionForward}インスタンスもしくは、
* レスポンスが既に完了している場合はnullを返します。
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バージョンにフォワードしようとします。
* {@primaryThe default implementation attempts to forward to the HTTP * version of this method.
} * * @param mapping このインスタンスを選択するために使用するActionMapping * {@primary @param mapping The ActionMapping used to select this instance} * @param form このリクエストのためのActionForm Bean(もしあれば) * {@primary @param form The optional ActionForm bean for this request (if any)} * @param request 処理中の非HTTPリクエスト * {@primary @param request The non-HTTP request we are processing} * @param response 生成する非HTTPレスポンス * {@primary @param response The non-HTTP response we are creating} * * @exception Exception アプリケーションのビジネスロジックが例外をスローした場合 * {@primary @exception Exception 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 { try { return execute( mapping, form, (HttpServletRequest) request, (HttpServletResponse) response); } catch (ClassCastException e) { return null; } } /** *指定されたHTTPリクエストを処理して、
* 対応するHTTPレスポンスを生成します。
* (またはレスポンスを生成する他のWebコンポーネントにリクエストをフォワードします。)
* 併せてビジネスロジックがスローする例外のハンドリングも提供します。
* コントロールをどこに/どうやってフォワードすべきかが記述された{@link ActionForward}インスタンスもしくは、
* レスポンスが既に完了している場合はnullを返します。
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.
(messages="true"が設定され)メッセージが必要な場合は、 * <html:messages>タグで使用できるように適切なリクエスト属性に指定されたメッセージキーを追加します。 * まだ属性が存在しない場合は、属性を初期化します。 * それ以外の場合は、このリクエスト属性は設定されません。
* {@primary Adds the specified messages keys into the appropriate request * attribute for use by the <html:messages> tag (if * messages="true" is set), if any messages are required. * Initialize the attribute if it has not already been. * Otherwise, ensure that the request attribute is not set.} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @param messages メッセージオブジェクト * {@primary @param messages Messages object} * @since Struts 1.2.1 */ protected void addMessages( HttpServletRequest request, ActionMessages messages) { if (messages == null){ // bad programmer! *slap* return; } // get any existing messages from the request, or make a new one ActionMessages requestMessages = (ActionMessages) request.getAttribute(Globals.MESSAGE_KEY); if (requestMessages == null){ requestMessages = new ActionMessages(); } // add incoming messages requestMessages.add(messages); // if still empty, just wipe it out from the request if (requestMessages.isEmpty()) { request.removeAttribute(Globals.MESSAGE_KEY); return; } // Save the messages request.setAttribute(Globals.MESSAGE_KEY, requestMessages); } /** *メッセージが必要な場合は、 * <html:messages>タグが使用できるように適切なリクエスト属性に指定されたエラーキーを追加します。 * まだ属性が存在しない場合は、属性を初期化します。 * それ以外の場合は、このリクエスト属性は設定されません。
* {@note "attribute for use by the for use by the" は * "attribute for use by the"が正しいです。 Bug#33876} * {@primary Adds the specified errors keys into the appropriate request * attribute for use by the for use by the <html:errors> tag, * if any messages are required. * Initialize the attribute if it has not already been. * Otherwise, ensure that the request attribute is not set.} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @param errors エラーオブジェクト * {@primary @param errors Errors object} * @since Struts 1.2.1 */ protected void addErrors( HttpServletRequest request, ActionMessages errors) { if (errors == null){ // bad programmer! *slap* return; } // get any existing errors from the request, or make a new one ActionMessages requestErrors = (ActionMessages)request.getAttribute(Globals.ERROR_KEY); if (requestErrors == null){ requestErrors = new ActionMessages(); } // add incoming errors requestErrors.add(errors); // if still empty, just wipe it out from the request if (requestErrors.isEmpty()) { request.removeAttribute(Globals.ERROR_KEY); return; } // Save the errors request.setAttribute(Globals.ERROR_KEY, requestErrors); } /** *各トランザクションに対してリクエストを1回だけにするために使用する、 * 新しいトランザクショントークンを生成します。
* {@primaryGenerate a new transaction token, to be used for enforcing a single * request for a particular transaction.
} * * @param request 処理中のリクエスト * {@primary @param request The request we are processing} */ protected String generateToken(HttpServletRequest request) { return token.generateToken(request); } /** *現在のモジュールのデフォルトのデータソースを返します。
* {@primaryReturn the default data source for the current module.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * * @since Struts 1.1 */ protected DataSource getDataSource(HttpServletRequest request) { return (getDataSource(request, Globals.DATA_SOURCE_KEY)); } /** *現在のモジュールの指定されたデータソースを返します。
* {@primaryReturn the specified data source for the current module.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @param key<data-sources>要素内でデータソースを特定するためのキー
* {@note "<message-resources>" は
* "<data-sources>"が正しいと思われます(Bug#33876)が、
* 最新版ではこのメソッドそのものが削除されてしまいました。}
* {@note 原文が誤っているっぽいので大幅に意訳しました。(高橋)}
* {@primary @param key 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 =
ModuleUtils.getInstance().getModuleConfig(request, context);
return (DataSource) context.getAttribute(key + moduleConfig.getPrefix());
}
/**
* 直前のアクションでリクエストに置かれた既存のエラーを全て取り出します。
* Actionの開始時にnew ActionMessages()という形で生成する代わりに、
* このメソッドを呼ぶことができます。
* これにより、saveErrors()メソッドで全ての既存のエラーを消すのを防げます。
new ActionMessages() at the beginning of an Action
* This will prevent saveErrors() from wiping out any existing Errors}
*
* @return リクエストに既に存在するエラー、
* エラーがない場合は新たなActionMessagesオブジェクト
* {@primary @return the Errors that already exist in the request, or a new ActionMessages object if empty.}
* @param request 処理中のサーブレットリクエスト
* {@primary @param request The servlet request we are processing}
* @since Struts 1.2.1
*/
protected ActionMessages getErrors(HttpServletRequest request) {
ActionMessages errors =
(ActionMessages) request.getAttribute(Globals.ERROR_KEY);
if (errors == null) {
errors = new ActionMessages();
}
return errors;
}
/**
* ユーザが現在選択しているLocaleを返します。
* {@primaryReturn the user's currently selected Locale.
} * * @param request 処理中のリクエスト * {@primary @param request The request we are processing} */ protected Locale getLocale(HttpServletRequest request) { return RequestUtils.getUserLocale(request, null); } /** *直前のアクションでリクエストに置かれた既存のメッセージを全て取り出します。
* Actionの開始時にnew ActionMessages()という形で生成する代わりに、
* このメソッドを呼ぶことができます。
* これにより、saveMessages()メソッドで全ての既存のメッセージを消すことを防ぎます。
new ActionMessages() at the beginning of an Action
* This will prevent saveMessages() from wiping out any existing Messages}
*
* @return リクエストに既に存在するメッセージ、
* メッセージがない場合新たなActionMessages
* {@primary @return the Messages that already exist in the request, or a new ActionMessages object if empty.}
* @param request 処理中のリクエスト
* {@primary @param request The servlet request we are processing}
* @since Struts 1.2.1
*/
protected ActionMessages getMessages(HttpServletRequest request) {
ActionMessages messages =
(ActionMessages) request.getAttribute(Globals.MESSAGE_KEY);
if (messages == null) {
messages = new ActionMessages();
}
return messages;
}
/**
* 現在のモジュールのデフォルトのメッセージリソースを返します。
* {@primaryReturn the default message resources for the current module.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @since Struts 1.1 */ protected MessageResources getResources(HttpServletRequest request) { return ((MessageResources) request.getAttribute(Globals.MESSAGES_KEY)); } /** *現在のモジュールの指定されたメッセージリソースを返します。
* {@primaryReturn the specified message resources for the current module.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @param key 要求されているメッセージのまとまりに対応する、 *<message-resources>要素内でメッセージリソースを特定するためのキー
* {@primary @param key 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 =
ModuleUtils.getInstance().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を返します。
Return 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を返します。
false."は、
* "Returns false under any of the following circumstances:"として訳しています。 Bug#33876}
* {@primary Return 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.
ユーザのセッションに保持されているトランザクショントークンをリセットします。 * これは、 * 次に送信されるリクエストではトランザクショントークンをチェックする必要がないことを示します。
* {@primaryReset the saved transaction token in the user's session. This * indicates that transactional token checking will not be needed * on the next request that is submitted.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} */ protected void resetToken(HttpServletRequest request) { token.resetToken(request); } /** *何らかのメッセージが必要な場合、 * <html:errors>タグが利用できるように、 * 適切なリクエスト属性に指定されたエラーメッセージキーを保存します。 * それ以外の場合、 * リクエスト属性が生成されないようにします。
* {@primarySave the specified error messages keys into the appropriate request * attribute for use by the <html:errors> tag, if any messages * are required. Otherwise, ensure that the request attribute is not * created.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @param errors エラーメッセージオブジェクト * {@primary @param errors Error messages object} * @deprecated 代わりにsaveErrors(HttpServletRequest, ActionMessages)を使用して下さい。 * このメソッドはStruts 1.2.より後で削除されます。 * {@primary @deprecated Use saveErrors(HttpServletRequest, ActionMessages) instead. * This will be removed after Struts 1.2.} */ protected void saveErrors(HttpServletRequest request, ActionErrors errors) { this.saveErrors(request,(ActionMessages)errors); // :TODO: Remove after Struts 1.2. } /** *何らかのメッセージが必要な場合、 * <html:errors>タグが利用できるように、 * 適切なリクエスト属性に指定されたエラーメッセージキーを保存します。 * それ以外の場合、 * リクエスト属性が生成されないようにします。
* {@primarySave the specified error messages keys into the appropriate request * attribute for use by the <html:errors> tag, if any messages * are required. Otherwise, ensure that the request attribute is not * created.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} * @param errors エラーメッセージオブジェクト * {@primary @param errors Error messages object} * @since Struts 1.2 */ protected void saveErrors(HttpServletRequest request, ActionMessages errors) { // Remove any error messages attribute if none are required if ((errors == null) || errors.isEmpty()) { request.removeAttribute(Globals.ERROR_KEY); return; } // Save the error messages we need request.setAttribute(Globals.ERROR_KEY, errors); } /** *(messages="true"が設定され)メッセージが必要な場合、 * <html:messages>タグが使用できるように、 * 適切なリクエスト属性の中に指定されたメッセージキーを保存します。 * それ以外の場合、リクエスト属性は設定されません。
* {@primarySave the specified messages keys into the appropriate request * attribute for use by the <html:messages> tag (if * messages="true" is set), if any messages are required. Otherwise, * ensure that the request attribute is not created.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing.} * @param messages 保存するメッセージ *nullまたは空のメッセージの場合、
* リクエスト中に存在する全てのActionMessagesを削除します。
* {@primary @param messages The messages to save. null or empty
* messages removes any existing ActionMessages in the request.}
*
* @since Struts 1.1
*/
protected void saveMessages(
HttpServletRequest request,
ActionMessages messages) {
// Remove any messages attribute if none are required
if ((messages == null) || messages.isEmpty()) {
request.removeAttribute(Globals.MESSAGE_KEY);
return;
}
// Save the messages we need
request.setAttribute(Globals.MESSAGE_KEY, messages);
}
/**
* (messages="true"が設定され)メッセージが必要な場合、 * <html:messages>タグが使用できるように、 * 適切なリクエスト属性の中に指定されたメッセージキーを保存します。 * それ以外の場合、セッション属性は生成されません。
* {@primarySave the specified messages keys into the appropriate session * attribute for use by the <html:messages> tag (if * messages="true" is set), if any messages are required. Otherwise, * ensure that the session attribute is not created.
} * * @param session メッセージを保存するセッション * {@primary @param session The session to save the messages in.} * @param messages 保存するメッセージ *nullまたは空のメッセージの場合、
* リクエスト中に存在する全てのActionMessagesを削除します。
* {@primary @param messages The messages to save. null or empty
* messages removes any existing ActionMessages in the session.}
*
* @since Struts 1.2
*/
protected void saveMessages(
HttpSession session,
ActionMessages messages) {
// Remove any messages attribute if none are required
if ((messages == null) || messages.isEmpty()) {
session.removeAttribute(Globals.MESSAGE_KEY);
return;
}
// Save the messages we need
session.setAttribute(Globals.MESSAGE_KEY, messages);
}
/**
* 必要に応じて新たなセッションを生成し、 * ユーザの現在のセッションに新しいトランザクショントークンを保存します。
* {@primarySave a new transaction token in the user's current session, creating * a new session if necessary.
} * * @param request 処理中のサーブレットリクエスト * {@primary @param request The servlet request we are processing} */ protected void saveToken(HttpServletRequest request) { token.saveToken(request); } /** *HttpSessionにユーザが現在選択したLocaleを設定します。
Set the user's currently selected Locale into their
* HttpSession.