| java.lang.Object
 org.apache.struts.config.ConfigHelper
| ConfigHelper | | public class ConfigHelper implements ConfigHelperInterface(Code) | | 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.
version:
$Rev: 471754 $ $Date: 2005-05-14 02:09:06 -0400 (Sat, 14 May 2005)
version:
$
since:
Struts 1.1 |
| Method Summary | |
| public String | action(String path)
| | public String | getAction(String path)
Return the URL for the specified ActionMapping, otherwise return
null. | | public ActionForm | getActionForm()
| | public ActionForward | getActionForward(String name)
Return the forwarding associated with the specified logical name,
if any; otherwise return null. | | public ActionMapping | getActionMapping(String path)
Return the mapping associated with the specified request path, if
any; otherwise return null. | | public String | getActionMappingName(String action)
Return the form action converted into an action mapping path. | | public String | getActionMappingURL(String action)
Return the form action converted into a server-relative URL. | | public ActionMessages | getActionMessages()
| | public String | getBaseRef()
Renders the reference for a HTML element. | | public String | getEncodeURL(String url)
Return the url encoded to maintain the user session, if any. | | public Throwable | getException()
The runtime JspException that may be been thrown by a Struts tag
extension, or compatible presentation extension, and placed in the
request. | | public ActionFormBean | getFormBean(String name)
Return the form bean definition associated with the specified
logical name, if any; otherwise return null. | | public String | getLink(String name)
Return the path for the specified forward, otherwise return
null. | | public ActionMapping | getMapping()
The org.apache.struts.ActionMapping instance for this
request. | | public String | getMessage(String key)
Return the localized message for the specified key, otherwise
return null. | | public String | getMessage(String key, Object[] args)
Look up and return a message string, based on the specified
parameters. | | public MessageResources | getMessageResources()
The application resources for this application. | | public MultipartRequestWrapper | getMultipartRequestWrapper()
The multipart object for this request. | | public String | getOrigRef()
| | public String | getServletMapping()
The path-mapped pattern (/action/*) or extension
mapped pattern ((*.do) used to determine our Action URIs
in this application. | | public String | getToken()
The transaction token stored in this session, if it is used. | | public boolean | isMessage(String key)
Return true if a message string for the specified message key is
present for the user's Locale. | | public String | link(String name)
| | public String | message(String key)
| | public String | message(String key, Object[] args)
| | public void | setApplication(ServletContext application)
Set the application associated with this instance. | | public void | setForward(ActionForward forward)
Set the forward associated with this instance. | | public void | setRequest(HttpServletRequest request)
Set the request associated with this object. | | public void | setResources(ServletContext application, HttpServletRequest request, HttpServletResponse response)
Set the application and request for this object instance. | | public void | setResponse(HttpServletResponse response)
Set the response associated with this isntance. | | public void | setSession(HttpSession session)
Set the session associated with this instance. |
| ConfigHelper | | public ConfigHelper()(Code) | | |
| action | | public String action(String path)(Code) | | Wrapper for getAction(String)
Parameters:
path - Name given to local or global forward. |
| getAction | | public String getAction(String path)(Code) | | Return the URL for the specified ActionMapping, otherwise return
null.
Parameters:
path - Name given to local or global forward. |
| getActionForward | | public ActionForward getActionForward(String name)(Code) | | 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)(Code) | | 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)(Code) | | 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.
|
| getActionMappingURL | | public String getActionMappingURL(String action)(Code) | | Return the form action converted into a server-relative URL.
|
| getBaseRef | | public String getBaseRef()(Code) | | Renders the reference for a HTML element.
|
| getEncodeURL | | public String getEncodeURL(String url)(Code) | | Return the url encoded to maintain the user session, if any.
|
| getException | | public Throwable getException()(Code) | | The runtime JspException that may be been thrown by a Struts tag
extension, or compatible presentation extension, and placed in the
request.
|
| getFormBean | | public ActionFormBean getFormBean(String name)(Code) | | Return the form bean definition associated with the specified
logical name, if any; otherwise return null.
Parameters:
name - Logical name of the requested form bean definition |
| getLink | | public String getLink(String name)(Code) | | Return the path for the specified forward, otherwise return
null.
Parameters:
name - Name given to local or global forward. |
| getMapping | | public ActionMapping getMapping()(Code) | | The org.apache.struts.ActionMapping instance for this
request.
|
| getMessage | | public String getMessage(String key)(Code) | | Return the localized message for the specified key, otherwise
return null.
Parameters:
key - Message key |
| getMessage | | public String getMessage(String key, Object[] args)(Code) | | Look up and return a message string, based on the specified
parameters.
Parameters:
key - Message key to be looked up and returned
Parameters:
args - Replacement parameters for this message |
| getMessageResources | | public MessageResources getMessageResources()(Code) | | The application resources for this application.
|
| getOrigRef | | public String getOrigRef()(Code) | | Renders the reference for a HTML element
|
| getServletMapping | | public String getServletMapping()(Code) | | The path-mapped pattern (/action/*) or extension
mapped pattern ((*.do) used to determine our Action URIs
in this application.
|
| getToken | | public String getToken()(Code) | | The transaction token stored in this session, if it is used.
|
| isMessage | | public boolean isMessage(String key)(Code) | | Return true if a message string for the specified message key is
present for the user's Locale.
Parameters:
key - Message key |
| link | | public String link(String name)(Code) | | Wrapper for getLink(String)
Parameters:
name - Name given to local or global forward. |
| message | | public String message(String key)(Code) | | Wrapper for getMessage(String)
Parameters:
key - Message key |
| message | | public String message(String key, Object[] args)(Code) | | Wrapper for getMessage(String,Object[])
Parameters:
key - Message key to be looked up and returned
Parameters:
args - Replacement parameters for this message |
| setApplication | | public void setApplication(ServletContext application)(Code) | | Set the application associated with this instance.
[servlet.getServletContext()]
|
| setForward | | public void setForward(ActionForward forward)(Code) | | Set the forward associated with this instance.
|
| setRequest | | public void setRequest(HttpServletRequest request)(Code) | | Set the request associated with this object. Session object is also
set or cleared.
|
| setResources | | public void setResources(ServletContext application, HttpServletRequest request, HttpServletResponse response)(Code) | | 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.
Parameters:
application - - The associated ServletContext.
Parameters:
request - - The associated HTTP request.
Parameters:
response - - The associated HTTP response. |
| setResponse | | public void setResponse(HttpServletResponse response)(Code) | | Set the response associated with this isntance. Session object is
also set or cleared.
|
| setSession | | public void setSession(HttpSession session)(Code) | | Set the session associated with this instance.
|
|
|