org.apache.struts.action
クラス ActionServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.apache.struts.action.ActionServlet

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

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ActionServlet

extends javax.servlet.http.HttpServlet

ActionServletは、 モデル2としてよく知られるWEBアプリケーションのための 「モデル-ビュー-コントローラ」(MVC)デザインパターンの中の「コントローラ」を実現します。 この命名の起源はJavaServerPages仕様の0.92の記述であり、 (他に適当な名前が無いため)それ以来ずっと続いています。

モデル2アプリケーションのアーキテクチャは概ね次の通りです:

• 一般に、ビジネスロジックを一切含まないJSPによってユーザインタフェースが生成されます。 JSPはMVCアーキテクチャの「ビュー」コンポーネントを実現します。
• 処理対象のビジネスロジックを要求するユーザインタフェースの中のフォームやハイパーリンクは、 コントローラサーブレットに割り当てられたリクエストURIに向けて送信します。
• これを処理するサーブレットクラスのインスタンスは一つだけであり、 ユーザ〜アプリケーション間の対話状態の変化に関する全てのリクエストを受け付けて処理します。 このコンポーネントは、MVCアーキテクチャにおける「コントローラ」を実現します。
• コントローラサーブレットは、 リクエストされたビジネスロジックを処理するためのアクションクラスを選択しそれを起動します。
• アクションクラスは、アプリケーション〜ユーザ間の対話状態を操作します。 典型例は、(どれぐらいの期間必要かによって)requestあるいはsession属性として保存されている JavaBeansを生成したり変更することです。 これらのJavaBeansは、MVCアーキテクチャの「モデル」コンポーネントを実現します。
• アクションクラスはユーザインタフェース用の遷移先のページを直接生成するのではなく、 サーブレットAPIのRequestDispatcher.forward()を使って適切なJSPへ制御を渡します。 このJSPがユーザインタフェース用の遷移先のページを生成します。

ActionServletは、各HTTPリクエストに対する以下のようなロジックを実装しています。 このクラスを継承したサブクラスを作成していくつか(場合によっては全て)の機能をオーバーライドすることで、 独自の処理を実装できます。

• アクションを選択するための文字列をリクエストURIから抽出します。
• この文字列をもとに、 対応するアクションクラス(このクラスはActionインタフェースをimplementsしている) のクラス名を決定します。
• そのクラスへの最初のリクエストがあると、 インスタンスを生成するとともに将来に備えてキャッシュします。
• 場合によっては、このクラスに対応するActionForm beanのプロパティを設定します。
• このアクションクラスのperform()メソッドを呼び出し、 参照をマッピングに移し、 (マッピング自身の全ての専用のプロパティと同じように、 ActionServletとServletContext配下の提供されるアクセスによって) サーブレットコンテナによってリクエストとレスポンスがコントローラに渡されます。
• このアクションクラスのperform()メソッドを呼び出し、 以下の参照を渡します：
  • 使用されたマッピング （これにより、マッピング自身の専用プロパティはもちろん、 ActionServletとServletContextへのアクセスも提供します。）
  • サーブレットコンテナによってコントローラに渡されたリクエストとレスポンス

標準のActionServletは、 Webアプリケーション用の配置記述ファイル(/WEB-INF/web.xml) によって規定された以下のサーブレット初期化パラメータをもとに初期化されます。 このサーブレットのサブクラスでは、追加の初期化パラメータを自由に定義出来ます。

• application - 基底クラスを含むアプリケーションのクラス名です。[なし]
• bufferSize - ファイルアップロードを処理する際に使用する入力バッファのサイズです。[4096]
• config - 設定情報を持ったXMLファイルに対する相対パスです。 [/WEB-INF/struts-config.xml]
• content - 全てのレスポンスで設定するコンテントタイプとエンコーディングです。 フォワードされたサーブレットとJSPでは上書きされます。[text/html]
• debug - このサーブレットに対するデバッグレベルです。 どの程度の情報を出力すべきかを制御します。[0]
• detail - initMapping()の中で利用するDigesterに対するデバッグレベルです。 サーブレットログの代わりにSystem.outにログ出力します。[0]
• factory - MessageResourcesオブジェクトを生成する際に使われる MessageResourcesFactoryのクラス名です。 [org.apache.struts.util.PropertyMessageResourcesFactory]
• formBean - [org.apache.struts.action.ActionFormBean]クラスを使うための ActionFormBeanの実装クラス名です。
• forward - [org.apache.struts.action.ActionForward]クラスを使うための ActionForwardの実装クラス名です。
  以下の二つの便利なクラスが利用可能です。
  • org.apache.struts.action.ForwardingActionForward - redirectプロパティを(ActionForwardのデフォルト値と同じ)false にデフォルト設定するorg.apache.struts.action.ActionForwardのサブクラスです。
  • org.apache.struts.action.RedirectingActionForward - redirectプロパティをtrue にデフォルト設定するorg.apache.struts.action.ActionForwardのサブクラスです。
• locale - trueに設定し、ユーザセッションが存在し、 かつロケールオブジェクトが存在しない場合、 (通常Action.LOCALE_KEYで識別されるキーを持つ) ユーザセッションの中の適切なjava.util.Localeオブジェクトを保持します。[true]
• mapping - [org.apache.struts.action.ActionMapping]を利用するためにそれを実装したクラスの名前です。 利用可能な便利なクラスは次の通りです:
  • org.apache.struts.action.RequestActionMapping - org.apache.struts.action.ActionMappingのサブクラスであり、 scopeプロパティを"request"にデフォルト設定します。
  • org.apache.struts.action.SessionActionMapping - org.apache.struts.action.ActionMappingのサブクラスであり、 scopeプロパティを"session"にデフォルト設定します。 (ActionMappingのデフォルト値と同じです)
• maxFileSize - フィルアップロードの際に許される最大サイズです(バイト)。[250M] 次の表現はそれぞれ数値に変換されます。
  • K キロバイト
  • M メガバイト
  • G ギガバイト
• multipartClass - ファイルアップロードの処理に使用されるMultiplartRequestHandlerの実装クラスの修飾名です。 [org.apache.struts.upload.DiskMultipartRequestHandler]
• nocache - trueに設定されると、 生成あるいはフォワードする全てのレスポンスのブラウザキャッシュを打ち消すよう、 当初のレスポンスに対してHTTPヘッダを追加します。[false]
• null - trueに設定されると、 不明なメッセージキーが使用された場合にはnullを返すようにアプリケーションリソースを設定します。 falseの場合、目障りなメッセージキーを含み、 エラーメッセージが返されます。[true]
• tempDir - ファイルアップロード処理の際に使用される一時的な作業ディレクトリです。 [サーブレットコンテキストの属性としてwebアプリケーションに提供される作業ディレクトリ]
• validate - 設定ファイルの新しい書式を使用するかどうかを指定します。[true]
• validating - 設定ファイルの処理に際して、検証済みXML解析を使用するかどうかを指定します(使用することを強く推奨)。 [true]

[訳注: これは田中良浩が翻訳しました。 日本語訳に対するコメントがあれば、 report@jajakarta.orgに送って下さい。]

バージョン:

$Revision: 1.2 $ $Date: 2003/03/22 07:55:10 $

作成者:

Craig R. McClanahan

関連項目:

直列化された形式

翻訳者:

田中 良浩 [日本語訳のコメントは、report@jajakarta.orgに送ってください。]

フィールドの概要

protected FastHashMap	actions 生成・初期化されたActionインスタンスを、 その完全修飾クラス名をキーにして格納した集合です。
protected MessageResources	application このアプリケーションに関する(メッセージ)リソースです。
protected int	bufferSize クライアントからのファイルアップロードで使用するバッファのバイト数です。
protected java.lang.String	config 設定ファイル(struts-config.xml)のコンテキストからの相対パスです。
protected java.lang.String	content 各レスポンスに設定されるコンテントタイプとキャラクタエンコーディングのデフォルト値です。
protected FastHashMap	dataSources このアプリケーション用に設定されたJDBCデータソースです(もしあれば)。
protected int	debug このサーブレットのデバッグレベルです。
protected java.util.Locale	defaultLocale このサーバのデフォルトロケールです。
protected java.lang.String	factoryClass アプリケーションメッセージのリソースバンドルのための MessageResourcesFactoryクラスの名前です。
protected java.lang.String	formBeanClass ActionFormBeanの実装クラス名です。
protected ActionFormBeans	formBeans 当コントローラのActionFormBean全てを集めたものです。
protected java.lang.String	forwardClass ActionForwardの実装クラス名です。
protected ActionForwards	forwards 当コントローラのActionForward全てを集めたものです。
protected MessageResources	internal 内部的に使用するメッセージリソースです。
protected java.lang.String	internalName 内部的に使用するリソースの基本クラス名です。
protected boolean	locale まだ存在しない場合、リクエストのHTTPヘッダに基づいて java.util.Localeを生成すべきかどうかを指定します。
protected java.lang.String	mappingClass ActionMappingの実装クラス名です。
protected ActionMappings	mappings このWebアプリケーションのためのマッピング全てを、 パスをキーにして集めたものです。
protected java.lang.String	maxFileSize クライアントからのアップロードで許可する最大サイズです。
protected java.lang.String	multipartClass リクエストでのマルチパートフォームを扱うためのMultipartRequestHandlerクラスの名前です。
protected boolean	nocache レスポンスにno-cachingヘッダを含めるかどうかを指定します。
protected java.lang.String[]	registrations 使用すべき設定ファイルのDTDのバージョンを表すための、 公開された識別子と対応するリソース名の対からなる集合です。
protected java.lang.String	servletMapping Webアプリケーションの配置記述子(デプロイメント デスクリプタ)で設定されたURLパターンです。
protected java.lang.String	servletName Webアプリケーションの配置記述子(デプロイメント デスクリプタ) で登録されているサーブレット名です。
protected java.lang.String	tempDir DiskMultipartRequestHandlerが、 マルチパート実装のために一時ファイルを保存するディレクトリです。
protected boolean	validate 設定ファイルの新しいフォーマットを使うかどうかを指定します。
protected boolean	validating 設定ファイルを読む際に、 検証用XMLパーサを使うかどうかを指定します。

クラス javax.servlet.http.HttpServlet から継承したフィールド

コンストラクタの概要

ActionServlet()

メソッドの概要

void	addDataSource(java.lang.String key, javax.sql.DataSource dataSource) 当アプリケーションが使用するデータソースオブジェクトを追加します。
void	addFormBean(ActionFormBean formBean) 当サーブレット用に設定された集合にフォームbeanの定義を登録します。
void	addForward(ActionForward forward) 当サーブレット用に設定されたセットに遷移先を登録します。
void	addMapping(ActionMapping mapping) 当サーブレット用に設定されたセットにマッピングを登録します。
void	addServletMapping(java.lang.String servletName, java.lang.String urlPattern) Webアプリケーションの配置記述子にある、 当サーブレット用のサーブレットマッピングを設定します。
void	destroy() このコントローラサーブレットを速やかに停止し、 初期化時に確保されたあらゆるリソースを開放します。
protected void	destroyActions() 生成した全てのアクションインスタンスを速やかに停止します。
protected void	destroyApplication() 生成した全てのアクションインスタンスを速やかに停止します。
protected void	destroyDataSources() 当アプリケーションに関連するデータソースが存在する場合、 その使用を速やかに停止します。
protected void	destroyInternal() 内部的なMessageResourcesの使用を速やかに停止します。
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) HTTPの"GET"リクエストを処理します。
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) HTTPの"POST"リクエストを処理します。
javax.sql.DataSource	findDataSource(java.lang.String key) 当アプリケーションに関連付けられたJDBCデータソースが存在する場合、それを返します。
ActionFormBean	findFormBean(java.lang.String name) 指定された論理名に関連付けられたフォームbeanの定義が存在する場合それを返します。
ActionForward	findForward(java.lang.String name) 指定された論理名に紐付く遷移先が存在する場合それを返します。
ActionMapping	findMapping(java.lang.String path) 指定されたリクエストパスに紐付くマッピングが存在する場合それを返します。
int	getBufferSize() ファイルアップロードで使用するバッファサイズを取得します。
int	getDebug() 当サーブレットのデバッグの詳細レベルを返します。
java.lang.String	getFormBeanClass() ActionFormBeanオブジェクトを生成するためのJavaクラス名を返します。
java.lang.String	getForwardClass() ActionForwardオブジェクトを生成するためのJavaクラス名を返します。
java.lang.String	getMappingClass() ActionMappingオブジェクトを生成するためのJavaクラス名を返します。
java.lang.String	getMaxFileSize() 最大ファイルサイズを返します。
java.lang.String	getMultipartClass() MultipartRequestHandlerを実装したクラス名を返します。
MessageResources	getResources() 当Webアプリケーション用のアプリケーションリソースが存在する場合、それを返します。
java.lang.String	getTempDir() フォームファイルを保存する一時ディレクトリを返します。
void	init() このサーブレットを初期化します。
protected void	initActions() 生成済みのActionインスタンス全てを初期化します。
protected void	initApplication() 当アプリケーションのMessageResourcesバンドルが存在すればそれを初期化します。
protected void	initDataSources() 当アプリケーションに関連するデータソースが存在する場合、 それらを初期化します。
protected void	initDebug() 当アプリケーションの詳細デバッグレベルを初期化します。
protected Digester	initDigester(int detail) 新しい設定ファイルフォーマットを使用するダイジェスタを生成し、 それを返します。
protected Digester	initDigesterOld(int detail) 古い設定ファイルフォーマットを使用するダイジェスタを生成し、 それを返します。
protected void	initInternal() 内部的なMessageResourcesバンドルを初期化します。
protected void	initMapping() 当アプリケーションのマッピング情報を初期化します。
protected void	initOther() まだ処理されていないその他の設定パラメータを初期化します。
protected void	initServlet() 当コントローラサーブレットの処理配下にあるサーブレットマッピングを初期化します。
protected void	initUpload() アップロードパラメータであるbufferSize・multipartClass・maxFileSize・tempDirを初期化します。
void	log(java.lang.String message, int level) 当サーブレットに設定されている現在のデバッグレベル以上の値が指定された場合、 指定されたメッセージをログ出力します。
protected void	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) HTTPリクエストを処理します。
protected Action	processActionCreate(ActionMapping mapping, javax.servlet.http.HttpServletRequest request) リクエストを処理するためのアクションインスタンスを生成あるいは復元します。
protected ActionForm	processActionForm(ActionMapping mapping, javax.servlet.http.HttpServletRequest request) 指定されたマッピングに関連するActionFormbeanを復元して返します。
protected void	processActionForward(ActionForward forward, ActionMapping mapping, ActionForm formInstance, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) ActionがActionForwardインスタンスを返す場合、 指定されたメカニズムによって指定の送信先に遷移します。
protected ActionForward	processActionPerform(Action action, ActionMapping mapping, ActionForm formInstance, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) リクエストを処理すべきアクションインスタンスを問い合わせます。
protected void	processContent(javax.servlet.http.HttpServletResponse response) 全てのレスポンスに対するデフォルトのコンテントタイプを任意のキャラクタエンコーディングで設定します。
protected boolean	processForward(ActionMapping mapping, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) マッピングが要求する遷移先が存在する場合、遷移処理を実行します。
protected boolean	processInclude(ActionMapping mapping, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) マッピングが要求するインクルード対象が存在する場合、インクルード処理を実行します。
protected void	processLocale(javax.servlet.http.HttpServletRequest request) ロケールオブジェクトが見つからない場合、 ユーザにとっての適切なjava.util.Localeを自動的に求め、 セッションに保存します。
protected ActionMapping	processMapping(java.lang.String path, javax.servlet.http.HttpServletRequest request) 指定されたパスに対する適切なActionMappingを判別して返します。
protected void	processNoCache(javax.servlet.http.HttpServletResponse response) 要求があった場合、ブラウザがキャッシュしないようにHTTPヘッダを設定します。
protected java.lang.String	processPath(javax.servlet.http.HttpServletRequest request) ActionMappingを選択するために使用する(リクエストURIの)パスを返します。
protected void	processPopulate(ActionForm formInstance, ActionMapping mapping, javax.servlet.http.HttpServletRequest request) リクエストに含まれるパラメータを元に、指定されたActionFormのプロパティを設定します。
protected boolean	processPreprocess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) アプリケーションで定義した前処理の実行を支援するための、 オーバーライドされる前提の汎用目的の前処理フックです。
protected boolean	processValidate(ActionMapping mapping, ActionForm formInstance, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 指定されたActionFormのvalidate()メソッドを呼び出し、 エラーがあれば入力フォームに逆遷移します。
void	reload() 当コントローラサーブレット用の設定ファイルを再ロードします。
void	removeFormBean(ActionFormBean formBean) フォームbeanの定義を当サーブレットから削除します。
void	removeForward(ActionForward forward) 遷移先の定義を当サーブレットから削除します。
void	removeMapping(ActionMapping mapping) マッピングを当サーブレットから削除します。
void	setBufferSize(int bufferSize) ファイルアップロードで使用するバッファサイズを設定します。
void	setFormBeanClass(java.lang.String formBeanClass) ActionFormBeanオブジェクトを生成するためのJavaクラス名を設定します。
void	setForwardClass(java.lang.String forwardClass) ActionForwardオブジェクトを生成するためのJavaクラス名を設定します。
void	setMappingClass(java.lang.String mappingClass) ActionMappingオブジェクトを生成するためのJavaクラス名を設定します。
void	setMaxFileSize(java.lang.String maxFileSize) クライアントからのアップロードで許可する最大サイズを設定します。
void	setMultipartClass(java.lang.String multipartClass) MultipartRequestHandlerを実装したクラス名を設定します。
void	setTempDir(java.lang.String tempDir) MultipartRequestHandlerがディスクに書き込むファイルを保存するディレクトリを設定します。

クラス javax.servlet.http.HttpServlet から継承したメソッド

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

クラス javax.servlet.GenericServlet から継承したメソッド

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

actions

protected FastHashMap actions

生成・初期化されたActionインスタンスを、 その完全修飾クラス名をキーにして格納した集合です。

application

protected MessageResources application

このアプリケーションに関する(メッセージ)リソースです。(存在する場合のみ)

config

protected java.lang.String config

設定ファイル(struts-config.xml)のコンテキストからの相対パスです。
[/WEB-INF/struts-config.xml]

content

protected java.lang.String content

各レスポンスに設定されるコンテントタイプとキャラクタエンコーディングのデフォルト値です。 (forwarded-toリソースによってオーバーライドされるかもしれません)
[text/html]

dataSources

protected FastHashMap dataSources

このアプリケーション用に設定されたJDBCデータソースです(もしあれば)。
サーブレットコンテキストに保存される際の属性名をキーとします。

debug

protected int debug

このサーブレットのデバッグレベルです。[0]

defaultLocale

protected final java.util.Locale defaultLocale

このサーバのデフォルトロケールです。

factoryClass

protected java.lang.String factoryClass

アプリケーションメッセージのリソースバンドルのための MessageResourcesFactoryクラスの名前です。[null]

formBeanClass

protected java.lang.String formBeanClass

ActionFormBeanの実装クラス名です。[org.apache.struts.action.ActionFormBean]

formBeans

protected ActionFormBeans formBeans

当コントローラのActionFormBean全てを集めたものです。

forwardClass

protected java.lang.String forwardClass

ActionForwardの実装クラス名です。[org.apache.struts.action.ActionForward]

forwards

protected ActionForwards forwards

当コントローラのActionForward全てを集めたものです。

internal

protected MessageResources internal

内部的に使用するメッセージリソースです。

internalName

protected java.lang.String internalName

内部的に使用するリソースの基本クラス名です。[org.apache.struts.action.ActionResources]

locale

protected boolean locale

まだ存在しない場合、リクエストのHTTPヘッダに基づいて java.util.Localeを生成すべきかどうかを指定します。[true]

mappingClass

protected java.lang.String mappingClass

ActionMappingの実装クラス名です。[org.apache.struts.action.ActionMapping]

mappings

protected ActionMappings mappings

このWebアプリケーションのためのマッピング全てを、 パスをキーにして集めたものです。

nocache

protected boolean nocache

レスポンスにno-cachingヘッダを含めるかどうかを指定します。[false]

registrations

protected java.lang.String[] registrations

使用すべき設定ファイルのDTDのバージョンを表すための、 公開された識別子と対応するリソース名の対からなる集合です。
このリストの数は、必ず偶数であること!

servletMapping

protected java.lang.String servletMapping

Webアプリケーションの配置記述子(デプロイメント デスクリプタ)で設定されたURLパターンです。

servletName

protected java.lang.String servletName

Webアプリケーションの配置記述子(デプロイメント デスクリプタ) で登録されているサーブレット名です。[null]

validate

protected boolean validate

設定ファイルの新しいフォーマットを使うかどうかを指定します。[true]

validating

protected boolean validating

設定ファイルを読む際に、 検証用XMLパーサを使うかどうかを指定します。[true]

bufferSize

protected int bufferSize

クライアントからのファイルアップロードで使用するバッファのバイト数です。[4096]

maxFileSize

protected java.lang.String maxFileSize

クライアントからのアップロードで許可する最大サイズです。 Kはキロバイト、Mはメガバイト、Gはギガバイトを表します。 記号がない場合はバイトとみなします。[250M]

multipartClass

protected java.lang.String multipartClass

リクエストでのマルチパートフォームを扱うためのMultipartRequestHandlerクラスの名前です。 この変数はグローバルなデフォルト値で、 ハンドラはマッピングエントリを個々に設定することもできます。
[org.apache.struts.upload.DiskMultipartRequestHandler]

tempDir

protected java.lang.String tempDir

DiskMultipartRequestHandlerが、 マルチパート実装のために一時ファイルを保存するディレクトリです。[null]

コンストラクタの詳細

ActionServlet

public ActionServlet()

メソッドの詳細

destroy

public void destroy()

このコントローラサーブレットを速やかに停止し、 初期化時に確保されたあらゆるリソースを開放します。

init

public void init()
          throws javax.servlet.ServletException

このサーブレットを初期化します。 各処理はメソッドに分解されているので、 かなり細かいレベルの機能ごとにオーバーライドできます。

例外:

javax.servlet.ServletException - 正しく初期化できなかった場合

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.io.IOException,
                  javax.servlet.ServletException

HTTPの"GET"リクエストを処理します。

パラメータ:

request - 処理対象のサーブレットリクエスト

response - 処理対象のサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットでの例外が発生した場合

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException

HTTPの"POST"リクエストを処理します。

パラメータ:

request - 処理対象のサーブレットリクエスト

response - 処理対象のサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットで例外が発生した場合

addDataSource

public void addDataSource(java.lang.String key,
                          javax.sql.DataSource dataSource)

当アプリケーションが使用するデータソースオブジェクトを追加します。

パラメータ:

key - 保存するデータソースのためのサーブレットコンテキスト属性のキー
デフォルトはnull

dataSource - 使用するデータソース

addFormBean

public void addFormBean(ActionFormBean formBean)

当サーブレット用に設定された集合にフォームbeanの定義を登録します。

パラメータ:

formBean - 追加するフォームbeanの定義

addForward

public void addForward(ActionForward forward)

当サーブレット用に設定されたセットに遷移先を登録します。

パラメータ:

forward - 追加する遷移先

addMapping

public void addMapping(ActionMapping mapping)

当サーブレット用に設定されたセットにマッピングを登録します。

パラメータ:

mapping - 追加するマッピング

addServletMapping

public void addServletMapping(java.lang.String servletName,
                              java.lang.String urlPattern)

Webアプリケーションの配置記述子にある、 当サーブレット用のサーブレットマッピングを設定します。

パラメータ:

servletName - 割り当て(マップ)されているサーブレットの名前

urlPattern - 当サーブレットに割り当てられているURLパターン

findDataSource

public javax.sql.DataSource findDataSource(java.lang.String key)

当アプリケーションに関連付けられたJDBCデータソースが存在する場合、それを返します。

パラメータ:

key - 保存されているデータソース用のサーブレットコンテキスト属性のキー
デフォルトはnull

findFormBean

public ActionFormBean findFormBean(java.lang.String name)

指定された論理名に関連付けられたフォームbeanの定義が存在する場合それを返します。 存在しない場合はnullを返します。

パラメータ:

name - 取得したいフォームbean定義の論理名

findForward

public ActionForward findForward(java.lang.String name)

指定された論理名に紐付く遷移先が存在する場合それを返します。 存在しない場合はnullを返します。

パラメータ:

name - 取得したい遷移先の論理名

findMapping

public ActionMapping findMapping(java.lang.String path)

指定されたリクエストパスに紐付くマッピングが存在する場合それを返します。 存在しない場合はnullを返します。

パラメータ:

path - 取得したいマッピングのリクエストパス

getBufferSize

public int getBufferSize()

ファイルアップロードで使用するバッファサイズを取得します。 (入力ストリームから一度に受信するデータのかたまり(チャンク)の大きさです)

戻り値:

バイトで表したバッファサイズ

getDebug

public int getDebug()

当サーブレットのデバッグの詳細レベルを返します。

getFormBeanClass

public java.lang.String getFormBeanClass()

ActionFormBeanオブジェクトを生成するためのJavaクラス名を返します。

getForwardClass

public java.lang.String getForwardClass()

ActionForwardオブジェクトを生成するためのJavaクラス名を返します。

getMappingClass

public java.lang.String getMappingClass()

ActionMappingオブジェクトを生成するためのJavaクラス名を返します。

getMaxFileSize

public java.lang.String getMaxFileSize()

最大ファイルサイズを返します。
使用する数値フォーマットの情報は、 setMaxFileSizeを参照して下さい。

getMultipartClass

public java.lang.String getMultipartClass()

MultipartRequestHandlerを実装したクラス名を返します。

戻り値:

MultipartRequestHandlerを実装したクラスの修飾クラス名

getResources

public MessageResources getResources()

当Webアプリケーション用のアプリケーションリソースが存在する場合、それを返します。

getTempDir

public java.lang.String getTempDir()

フォームファイルを保存する一時ディレクトリを返します。

戻り値:

一時ディレクトリのパスを表すためのプラットフォームに依存する文字列

log

public void log(java.lang.String message,
                int level)

当サーブレットに設定されている現在のデバッグレベル以上の値が指定された場合、 指定されたメッセージをログ出力します。そうでなければこのメッセージを無視します。

パラメータ:

message - ログ出力するメッセージ

level - このメッセージのデバッグレベル

reload

public void reload()
            throws java.io.IOException,
                   javax.servlet.ServletException

当コントローラサーブレット用の設定ファイルを再ロードします。

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットで例外が発生した場合

removeFormBean

public void removeFormBean(ActionFormBean formBean)

フォームbeanの定義を当サーブレットから削除します。

パラメータ:

formBean - 登録を削除したいフォームbeanの定義

removeForward

public void removeForward(ActionForward forward)

遷移先の定義を当サーブレットから削除します。

パラメータ:

forward - 登録を削除したい遷移先の定義

removeMapping

public void removeMapping(ActionMapping mapping)

マッピングを当サーブレットから削除します。

パラメータ:

mapping - 登録を削除したいマッピング

setBufferSize

public void setBufferSize(int bufferSize)

ファイルアップロードで使用するバッファサイズを設定します。 (入力ストリームから一度に受信するデータのかたまり(チャンク)の大きさです)

パラメータ:

bufferSize - バイトで表したバッファサイズ

setFormBeanClass

public void setFormBeanClass(java.lang.String formBeanClass)

ActionFormBeanオブジェクトを生成するためのJavaクラス名を設定します。

パラメータ:

formBeanClass - 新しいクラス名

setForwardClass

public void setForwardClass(java.lang.String forwardClass)

ActionForwardオブジェクトを生成するためのJavaクラス名を設定します。

パラメータ:

forwardClass - 新しいクラス名

setMappingClass

public void setMappingClass(java.lang.String mappingClass)

ActionMappingオブジェクトを生成するためのJavaクラス名を設定します。

パラメータ:

mappingClass - 新しいクラス名

setMaxFileSize

public void setMaxFileSize(java.lang.String maxFileSize)

クライアントからのアップロードで許可する最大サイズを設定します。 Kはキロバイト、Mはメガバイト、Gはギガバイトを表します。 記号がない場合はバイトとみなします。 例えば、最大ファイルサイズを500メガバイトに指定したい場合、 setMaxFileSize("500M")と呼び出して下さい。

パラメータ:

maxFileSize - 最大ファイルサイズを表す文字列

setMultipartClass

public void setMultipartClass(java.lang.String multipartClass)

MultipartRequestHandlerを実装したクラス名を設定します。

パラメータ:

multipartClass - MultipartRequestHandlerを実装したクラスの修飾クラス名

setTempDir

public void setTempDir(java.lang.String tempDir)

MultipartRequestHandlerがディスクに書き込むファイルを保存するディレクトリを設定します。

パラメータ:

tempDir - 一時ディレクトリのパスを表すためのプラットフォームに依存する文字列

destroyActions

protected void destroyActions()

生成した全てのアクションインスタンスを速やかに停止します。

destroyApplication

protected void destroyApplication()

生成した全てのアクションインスタンスを速やかに停止します。

destroyDataSources

protected void destroyDataSources()

当アプリケーションに関連するデータソースが存在する場合、 その使用を速やかに停止します。

destroyInternal

protected void destroyInternal()

内部的なMessageResourcesの使用を速やかに停止します。

initActions

protected void initActions()

生成済みのActionインスタンス全てを初期化します。

initApplication

protected void initApplication()
                        throws javax.servlet.ServletException

当アプリケーションのMessageResourcesバンドルが存在すればそれを初期化します。

例外:

javax.servlet.ServletException - リソースを初期化できなかった場合

initDataSources

protected void initDataSources()
                        throws javax.servlet.ServletException

当アプリケーションに関連するデータソースが存在する場合、 それらを初期化します。

例外:

javax.servlet.ServletException - 初期化中にエラーが発生した場合

initDebug

protected void initDebug()
                  throws javax.servlet.ServletException

当アプリケーションの詳細デバッグレベルを初期化します。

例外:

javax.servlet.ServletException - リソースの初期化に失敗した場合

initDigester

protected Digester initDigester(int detail)

新しい設定ファイルフォーマットを使用するダイジェスタを生成し、 それを返します。

initDigesterOld

protected Digester initDigesterOld(int detail)

古い設定ファイルフォーマットを使用するダイジェスタを生成し、 それを返します。

initInternal

protected void initInternal()
                     throws javax.servlet.ServletException

内部的なMessageResourcesバンドルを初期化します。

例外:

javax.servlet.ServletException - リソースの初期化に失敗した場合

initMapping

protected void initMapping()
                    throws java.io.IOException,
                           javax.servlet.ServletException

当アプリケーションのマッピング情報を初期化します。

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - リソースの初期化に失敗した場合

initOther

protected void initOther()
                  throws javax.servlet.ServletException

まだ処理されていないその他の設定パラメータを初期化します。

例外:

javax.servlet.ServletException - リソースの初期化に失敗した場合

initServlet

protected void initServlet()
                    throws javax.servlet.ServletException

当コントローラサーブレットの処理配下にあるサーブレットマッピングを初期化します。 送信対象とする正しい送信先のURLを生成するために、 &html:form>タグを使用します、

例外:

javax.servlet.ServletException

initUpload

protected void initUpload()
                   throws javax.servlet.ServletException

アップロードパラメータであるbufferSize・multipartClass・maxFileSize・tempDirを初期化します。

例外:

javax.servlet.ServletException - 不正なパラメータがあった場合

process

protected void process(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.io.IOException,
                       javax.servlet.ServletException

HTTPリクエストを処理します。

パラメータ:

request - 処理対象のサーブレットリクエスト

response - 生成するサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットの例外が発生した場合

processActionCreate

protected Action processActionCreate(ActionMapping mapping,
                                     javax.servlet.http.HttpServletRequest request)

リクエストを処理するためのアクションインスタンスを生成あるいは復元します。 生成に失敗した場合はnullを返します。

パラメータ:

mapping - 処理対象のActionMapping

request - 処理対象のサーブレットリクエスト

processActionForm

protected ActionForm processActionForm(ActionMapping mapping,
                                       javax.servlet.http.HttpServletRequest request)

指定されたマッピングに関連するActionFormbeanを復元して返します。 紐付くフォームbeanが無い場合はnullを返します。

パラメータ:

mapping - 処理対象のActionMapping

request - 処理対象のサーブレットリクエスト

processActionForward

protected void processActionForward(ActionForward forward,
                                    ActionMapping mapping,
                                    ActionForm formInstance,
                                    javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws java.io.IOException,
                                    javax.servlet.ServletException

ActionがActionForwardインスタンスを返す場合、 指定されたメカニズムによって指定の送信先に遷移します。

パラメータ:

forward - アクションによって返されたアクションフォワード

mapping - 処理対象のアクションマッピング

formInstance - 処理対象のアクションフォーム

request - 処理対象のサーブレットリクエスト

response - 生成するサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットの例外が発生した場合

processActionPerform

protected ActionForward processActionPerform(Action action,
                                             ActionMapping mapping,
                                             ActionForm formInstance,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.io.IOException,
                                             javax.servlet.ServletException

リクエストを処理すべきアクションインスタンスを問い合わせます。 呼び出されたActionが返すActionForward インスタンスが存在する場合それを返します。

パラメータ:

action - リクエストを処理するアクション

mapping - 処理対象のアクションマッピング

formInstance - 処理対象のアクションフォーム

request - 処理対象のサーブレットリクエスト

response - 生成するサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットの例外が発生した場合

processContent

protected void processContent(javax.servlet.http.HttpServletResponse response)

全てのレスポンスに対するデフォルトのコンテントタイプを任意のキャラクタエンコーディングで設定します。 この値は、遷移先のサーブレットあるいはJSPによって書き換えられる可能性があります。

パラメータ:

response - 処理対象のサーブレットレスポンス

processForward

protected boolean processForward(ActionMapping mapping,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws java.io.IOException,
                                 javax.servlet.ServletException

マッピングが要求する遷移先が存在する場合、遷移処理を実行します。 リクエスト処理が継続されるべき場合 (例えば、アクションクラスによって処理される場合)はtrueを、 既にこのリクエストの処理を完了している場合はfalseを返します。

パラメータ:

mapping - 処理対象のアクションマッピング

request - 処理対象のサーブレットリクエスト

response - 処理対象のサーブレットレスポンス

例外:

java.io.IOException - 含まれるリソースが例外を投げた場合

javax.servlet.ServletException - 含まれるリソースが例外を投げた場合

processInclude

protected boolean processInclude(ActionMapping mapping,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws java.io.IOException,
                                 javax.servlet.ServletException

マッピングが要求するインクルード対象が存在する場合、インクルード処理を実行します。
リクエスト処理が継続されるべき場合 (例えば、アクションクラスによって処理される場合)はtrueを、 既に処理中のリクエストがある場合はfalseを返します。

パラメータ:

mapping - 処理対象のアクションマッピング

request - 処理対象のサーブレットリクエスト

response - 処理対象のサーブレットレスポンス

例外:

java.io.IOException - 含まれるリソースが例外を投げた場合

javax.servlet.ServletException - 含まれるリソースが例外を投げた場合

processLocale

protected void processLocale(javax.servlet.http.HttpServletRequest request)

ロケールオブジェクトが見つからない場合、 ユーザにとっての適切なjava.util.Localeを自動的に求め、 セッションに保存します。

パラメータ:

request - 処理対象のサーブレットリクエスト

processMapping

protected ActionMapping processMapping(java.lang.String path,
                                       javax.servlet.http.HttpServletRequest request)

指定されたパスに対する適切なActionMappingを判別して返します。 マッピングが見つからない場合はnullを返します。 リクエストパラメータや他のプロパティに基づく利用可能なマッピング (例えばパーミッションの確認など)を決める必要がある場合、 requestパラメータを利用できます。 しかしこれはデフォルトの実装では行なわれていません。

パラメータ:

path - マッピングの選択に使うパス

request - 処理対象のサーブレットリクエスト

processNoCache

protected void processNoCache(javax.servlet.http.HttpServletResponse response)
                       throws java.io.IOException,
                              javax.servlet.ServletException

要求があった場合、ブラウザがキャッシュしないようにHTTPヘッダを設定します。

パラメータ:

response - 生成するサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットの例外が発生した場合

processPath

protected java.lang.String processPath(javax.servlet.http.HttpServletRequest request)

ActionMappingを選択するために使用する(リクエストURIの)パスを返します。 パスが見つからない場合はnullを返します。

パラメータ:

request - 処理対象のサーブレットリクエスト

processPreprocess

protected boolean processPreprocess(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws java.io.IOException,
                                    javax.servlet.ServletException

アプリケーションで定義した前処理の実行を支援するための、 オーバーライドされる前提の汎用目的の前処理フックです。 このフックはリクエストとレスポンスのプロパティを検査・変更(両方あるいはいずれか)でき、 かつ、レスポンスを完了することも可能です。

デフォルトの実装では何も処理しません。

パラメータ:

request - 処理対象のサーブレットリクエスト

response - 生成するサーブレットリクエスト

戻り値:

処理が残っている場合はtrue、 レスポンスが既に作成され、 呼び出したメソッドが速やかに終了すべき場合はfalseを返します。

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットの例外が発生した場合

processPopulate

protected void processPopulate(ActionForm formInstance,
                               ActionMapping mapping,
                               javax.servlet.http.HttpServletRequest request)
                        throws javax.servlet.ServletException

リクエストに含まれるパラメータを元に、指定されたActionFormのプロパティを設定します。

パラメータ:

formInstance - 処理対象のアクションフォーム

mapping - 処理対象のアクションマッピング

request - 処理対象のサーブレットリクエスト

例外:

javax.servlet.ServletException - RequestUtils.populate()が例外を投げた場合

processValidate

protected boolean processValidate(ActionMapping mapping,
                                  ActionForm formInstance,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws java.io.IOException,
                                  javax.servlet.ServletException

指定されたActionFormのvalidate()メソッドを呼び出し、 エラーがあれば入力フォームに逆遷移します。 処理を続けられる(そしてActionクラスのperform()メソッドを呼ぶ) 場合はtrueを返し、 入力フォームに制御を移してしまった場合はfalseを返します。

パラメータ:

mapping - 処理対象のアクションマッピング

formInstance - 処理対象のアクションフォーム

request - 処理対象のサーブレットリクエスト

response - 処理対象のサーブレットレスポンス

例外:

java.io.IOException - 入出力エラーが発生した場合

javax.servlet.ServletException - サーブレットの例外が発生した場合