Apache Struts API Documentation: Class ConfigHelper

org.apache.struts.config Class ConfigHelper

java.lang.Object
  |
  +--org.apache.struts.config.ConfigHelper

All Implemented Interfaces:

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.

Since:

Struts 1.1

Version:

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

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.

Parameters:

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.

Specified by:

getDataSource in interface ConfigHelperInterface

getActionMessages

public ActionMessages getActionMessages()

Description copied from interface: ConfigHelperInterface

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

Specified by:

getActionMessages in interface ConfigHelperInterface

getMessageResources

public MessageResources getMessageResources()

The application resources for this application.

Specified by:

getMessageResources in interface ConfigHelperInterface

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.

Specified by:

getServletMapping in interface ConfigHelperInterface

getToken

public java.lang.String getToken()

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

Specified by:

getToken in interface ConfigHelperInterface

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.

Specified by:

getException in interface ConfigHelperInterface

getMultipartRequestWrapper

public MultipartRequestWrapper getMultipartRequestWrapper()

The multipart object for this request.

Specified by:

getMultipartRequestWrapper in interface ConfigHelperInterface

getMapping

public ActionMapping getMapping()

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

Specified by:

getMapping in interface ConfigHelperInterface

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.

Specified by:

isMessage in interface ConfigHelperInterface

Parameters:

key - Message key

getActionForm

public ActionForm getActionForm()

Specified by:

getActionForm in interface ConfigHelperInterface

getFormBean

public ActionFormBean getFormBean(java.lang.String name)

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

Specified by:

getFormBean in interface ConfigHelperInterface

Parameters:

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.

Specified by:

getActionForward in interface ConfigHelperInterface

Parameters:

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.

Specified by:

getActionMapping in interface ConfigHelperInterface

Parameters:

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.

Specified by:

getActionMappingName in interface ConfigHelperInterface

getActionMappingURL

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

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

Specified by:

getActionMappingURL in interface ConfigHelperInterface

getEncodeURL

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

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

Specified by:

getEncodeURL in interface ConfigHelperInterface

getOrigRef

public java.lang.String getOrigRef()

Renders the reference for a HTML element

Specified by:

getOrigRef in interface ConfigHelperInterface

getBaseRef

public java.lang.String getBaseRef()

Renders the reference for a HTML element.

Specified by:

getBaseRef in interface ConfigHelperInterface

getLink

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

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

Specified by:

getLink in interface ConfigHelperInterface

Parameters:

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.

Specified by:

getMessage in interface ConfigHelperInterface

Parameters:

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.

Specified by:

getMessage in interface ConfigHelperInterface

Parameters:

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.

Specified by:

getAction in interface ConfigHelperInterface

Parameters:

path - Name given to local or global forward.

link

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

Wrapper for getLink(String)

Parameters:

name - Name given to local or global forward.

message

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

Wrapper for getMessage(String)

Parameters:

key - Message key

message

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

Wrapper for getMessage(String,Object[])

Parameters:

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)

Parameters:

path - Name given to local or global forward.