org.apache.struts.config

Interface ConfigHelperInterface

public interface 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.

Since: Struts 1.1

Version: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

Method Summary
String	getAction(String path) Return the URL for the specified ActionMapping, otherwise return `null`.
ActionForm	getActionForm()
ActionForward	getActionForward(String name) Return the forwarding associated with the specified logical name, if any; otherwise return `null`.
ActionMapping	getActionMapping(String path) Return the mapping associated with the specified request path, if any; otherwise return `null`.
String	getActionMappingName(String action) Return the form action converted into an action mapping path.
String	getActionMappingURL(String action) Return the form action converted into a server-relative URL.
ActionMessages	getActionMessages() The `org.apache.struts.action.ActionFormBeans` collection for this application.
String	getBaseRef() Renders the reference for a HTML element
DataSource	getDataSource()
String	getEncodeURL(String url) Return the url encoded to maintain the user session, if any.
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(String name) Return the form bean definition associated with the specified logical name, if any; otherwise return `null`.
String	getLink(String name) Return the path for the specified forward, otherwise return `null`.
ActionMapping	getMapping() The `org.apache.struts.ActionMapping` instance for this request.
String	getMessage(String key) Return the localized message for the specified key, otherwise return `null`.
String	getMessage(String key, 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.
String	getOrigRef() Renders the reference for a HTML element
String	getServletMapping() The path-mapped pattern (`/action/`) or extension mapped pattern ((`.do`) used to determine our Action URIs in this application.
String	getToken() The transaction token stored in this session, if it is used.
boolean	isMessage(String key) Return true if a message string for the specified message key is present for the user's Locale.

Method Detail

getAction

public String getAction(String path)

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

Parameters: path Name given to local or global forward.

getActionForm

public ActionForm getActionForm()

getActionForward

public ActionForward getActionForward(String name)

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

Parameters: name Logical name of the requested forwarding

getActionMapping

public ActionMapping getActionMapping(String path)

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

Parameters: path Request path for which a mapping is requested

getActionMappingName

public String getActionMappingName(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.

:FIXME: Bad assumption =:o)