org.apache.struts.config
クラス ConfigHelper

java.lang.Object
  org.apache.struts.config.ConfigHelper

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

ConfigHelperInterface

public class ConfigHelper

extends java.lang.Object

implements ConfigHelperInterface

NOTE: THIS CLASS IS UNDER ACTIVE DEVELOPMENT. THE CURRENT CODE IS WRITTEN FOR CLARITY NOT EFFICIENCY. NOT EVERY API FUNCTION HAS BEEN IMPLEMENTED YET. A helper object to expose the Struts shared resources, which are be stored in the application, session, or request contexts, as appropriate. An instance should be created for each request processed. The methods which return resources from the request or session contexts are not thread-safe. Provided for use by other servlets in the application so they can easily access the Struts shared resources. The resources are stored under attributes in the application, session, or request contexts. The ActionConfig methods simply return the resources from under the context and key used by the Struts ActionServlet when the resources are created.

導入されたバージョン:

Struts 1.1

バージョン:

$Revision: 1.1 $ $Date: 2004/10/20 03:26:41 $

フィールドの概要

private javax.servlet.ServletContext	application The application associated with this instance.
private ActionForward	forward The forward associated with this instance.
private javax.servlet.http.HttpServletRequest	request The request associated with this instance.
private javax.servlet.http.HttpServletResponse	response The response associated with this instance.
private javax.servlet.http.HttpSession	session The session associated with this instance.

コンストラクタの概要

ConfigHelper()

ConfigHelper(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

メソッドの概要

java.lang.String	action(java.lang.String path) Wrapper for getAction(String)
java.lang.String	getAction(java.lang.String path) Return the URL for the specified ActionMapping, otherwise return null.
ActionForm	getActionForm()
ActionForward	getActionForward(java.lang.String name) Return the forwarding associated with the specified logical name, if any; otherwise return null.
ActionMapping	getActionMapping(java.lang.String path) Return the mapping associated with the specified request path, if any; otherwise return null.
java.lang.String	getActionMappingName(java.lang.String action) Return the form action converted into an action mapping path.
java.lang.String	getActionMappingURL(java.lang.String action) Return the form action converted into a server-relative URL.
ActionMessages	getActionMessages() The org.apache.struts.action.ActionFormBeans collection for this application.
java.lang.String	getBaseRef() Renders the reference for a HTML element.
javax.sql.DataSource	getDataSource() The default configured data source (which must implement javax.sql.DataSource), if one is configured for this application.
java.lang.String	getEncodeURL(java.lang.String url) Return the url encoded to maintain the user session, if any.
java.lang.Throwable	getException() The runtime JspException that may be been thrown by a Struts tag extension, or compatible presentation extension, and placed in the request.
ActionFormBean	getFormBean(java.lang.String name) Return the form bean definition associated with the specified logical name, if any; otherwise return null.
java.lang.String	getLink(java.lang.String name) Return the path for the specified forward, otherwise return null.
ActionMapping	getMapping() The org.apache.struts.ActionMapping instance for this request.
java.lang.String	getMessage(java.lang.String key) Return the localized message for the specified key, otherwise return null.
java.lang.String	getMessage(java.lang.String key, java.lang.Object[] args) Look up and return a message string, based on the specified parameters.
MessageResources	getMessageResources() The application resources for this application.
MultipartRequestWrapper	getMultipartRequestWrapper() The multipart object for this request.
java.lang.String	getOrigRef() Renders the reference for a HTML element
java.lang.String	getServletMapping() The path-mapped pattern (/action/*) or extension mapped pattern ((*.do) used to determine our Action URIs in this application.
java.lang.String	getToken() The transaction token stored in this session, if it is used.
boolean	isMessage(java.lang.String key) Return true if a message string for the specified message key is present for the user's Locale.
java.lang.String	link(java.lang.String name) Wrapper for getLink(String)
java.lang.String	message(java.lang.String key) Wrapper for getMessage(String)
java.lang.String	message(java.lang.String key, java.lang.Object[] args) Wrapper for getMessage(String,Object[])
void	setApplication(javax.servlet.ServletContext application) Set the application associated with this instance.
void	setForward(ActionForward forward) Set the forward associated with this instance.
void	setRequest(javax.servlet.http.HttpServletRequest request) Set the request associated with this object.
void	setResources(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Set the application and request for this object instance.
void	setResponse(javax.servlet.http.HttpServletResponse response) Set the response associated with this isntance.
void	setSession(javax.servlet.http.HttpSession session) Set the session associated with this instance.

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

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

フィールドの詳細

application

private javax.servlet.ServletContext application

The application associated with this instance.

session

private javax.servlet.http.HttpSession session

The session associated with this instance.

request

private javax.servlet.http.HttpServletRequest request

The request associated with this instance.

response

private javax.servlet.http.HttpServletResponse response

The response associated with this instance.

forward

private ActionForward forward

The forward associated with this instance.

コンストラクタの詳細

ConfigHelper

public ConfigHelper()

ConfigHelper

public ConfigHelper(javax.servlet.ServletContext application,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)

メソッドの詳細

setApplication

public void setApplication(javax.servlet.ServletContext application)

Set the application associated with this instance. [servlet.getServletContext()]

setSession

public void setSession(javax.servlet.http.HttpSession session)

Set the session associated with this instance.

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Set the request associated with this object. Session object is also set or cleared.

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

Set the response associated with this isntance. Session object is also set or cleared.

setForward

public void setForward(ActionForward forward)

Set the forward associated with this instance.

setResources

public void setResources(javax.servlet.ServletContext application,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)

Set the application and request for this object instance. The ServletContext can be set by any servlet in the application. The request should be the instant request. Most of the other methods retrieve their own objects by reference to the application, request, or session attributes. Do not call other methods without setting these first! This is also called by the convenience constructor.

パラメータ:

application - - The associated ServletContext.

request - - The associated HTTP request.

response - - The associated HTTP response.

getDataSource

public javax.sql.DataSource getDataSource()

The default configured data source (which must implement javax.sql.DataSource), if one is configured for this application.

定義:

インタフェース ConfigHelperInterface 内の getDataSource

getActionMessages

public ActionMessages getActionMessages()

インタフェース ConfigHelperInterface の記述:

The org.apache.struts.action.ActionFormBeans collection for this application.

定義:

インタフェース ConfigHelperInterface 内の getActionMessages

getMessageResources

public MessageResources getMessageResources()

The application resources for this application.

定義:

インタフェース ConfigHelperInterface 内の getMessageResources

getServletMapping

public java.lang.String getServletMapping()

The path-mapped pattern (/action/*) or extension mapped pattern ((*.do) used to determine our Action URIs in this application.

定義:

インタフェース ConfigHelperInterface 内の getServletMapping

getToken

public java.lang.String getToken()

The transaction token stored in this session, if it is used.

定義:

インタフェース ConfigHelperInterface 内の getToken

getException

public java.lang.Throwable getException()

The runtime JspException that may be been thrown by a Struts tag extension, or compatible presentation extension, and placed in the request.

定義:

インタフェース ConfigHelperInterface 内の getException

getMultipartRequestWrapper

public MultipartRequestWrapper getMultipartRequestWrapper()

The multipart object for this request.

定義:

インタフェース ConfigHelperInterface 内の getMultipartRequestWrapper

getMapping

public ActionMapping getMapping()

The org.apache.struts.ActionMapping instance for this request.

定義:

インタフェース ConfigHelperInterface 内の getMapping

isMessage

public boolean isMessage(java.lang.String key)

Return true if a message string for the specified message key is present for the user's Locale.

定義:

インタフェース ConfigHelperInterface 内の isMessage

パラメータ:

key - Message key

getActionForm

public ActionForm getActionForm()

定義:

インタフェース ConfigHelperInterface 内の getActionForm

getFormBean

public ActionFormBean getFormBean(java.lang.String name)

Return the form bean definition associated with the specified logical name, if any; otherwise return null.

定義:

インタフェース ConfigHelperInterface 内の getFormBean

パラメータ:

name - Logical name of the requested form bean definition

getActionForward

public ActionForward getActionForward(java.lang.String name)

Return the forwarding associated with the specified logical name, if any; otherwise return null.

定義:

インタフェース ConfigHelperInterface 内の getActionForward

パラメータ:

name - Logical name of the requested forwarding

getActionMapping

public ActionMapping getActionMapping(java.lang.String path)

Return the mapping associated with the specified request path, if any; otherwise return null.

定義:

インタフェース ConfigHelperInterface 内の getActionMapping

パラメータ:

path - Request path for which a mapping is requested

getActionMappingName

public java.lang.String getActionMappingName(java.lang.String action)

Return the form action converted into an action mapping path. The value of the action property is manipulated as follows in computing the name of the requested mapping:

• Any filename extension is removed (on the theory that extension mapping is being used to select the controller servlet).
• If the resulting value does not start with a slash, then a slash is prepended.

定義:

インタフェース ConfigHelperInterface 内の getActionMappingName

getActionMappingURL

public java.lang.String getActionMappingURL(java.lang.String action)

Return the form action converted into a server-relative URL.

定義:

インタフェース ConfigHelperInterface 内の getActionMappingURL

getEncodeURL

public java.lang.String getEncodeURL(java.lang.String url)

Return the url encoded to maintain the user session, if any.

定義:

インタフェース ConfigHelperInterface 内の getEncodeURL

getOrigRef

public java.lang.String getOrigRef()

Renders the reference for a HTML element

定義:

インタフェース ConfigHelperInterface 内の getOrigRef

getBaseRef

public java.lang.String getBaseRef()

Renders the reference for a HTML element.

定義:

インタフェース ConfigHelperInterface 内の getBaseRef

getLink

public java.lang.String getLink(java.lang.String name)

Return the path for the specified forward, otherwise return null.

定義:

インタフェース ConfigHelperInterface 内の getLink

パラメータ:

name - Name given to local or global forward.

getMessage

public java.lang.String getMessage(java.lang.String key)

Return the localized message for the specified key, otherwise return null.

定義:

インタフェース ConfigHelperInterface 内の getMessage

パラメータ:

key - Message key

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] args)

Look up and return a message string, based on the specified parameters.

定義:

インタフェース ConfigHelperInterface 内の getMessage

パラメータ:

key - Message key to be looked up and returned

args - Replacement parameters for this message

getAction

public java.lang.String getAction(java.lang.String path)

Return the URL for the specified ActionMapping, otherwise return null.

定義:

インタフェース ConfigHelperInterface 内の getAction

パラメータ:

path - Name given to local or global forward.

link

public java.lang.String link(java.lang.String name)

Wrapper for getLink(String)

パラメータ:

name - Name given to local or global forward.

message

public java.lang.String message(java.lang.String key)

Wrapper for getMessage(String)

パラメータ:

key - Message key

message

public java.lang.String message(java.lang.String key,
                                java.lang.Object[] args)

Wrapper for getMessage(String,Object[])

パラメータ:

key - Message key to be looked up and returned

args - Replacement parameters for this message

action

public java.lang.String action(java.lang.String path)

Wrapper for getAction(String)

パラメータ:

path - Name given to local or global forward.