Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.struts.config

Interface ConfigHelperInterface

Known Implementing Classes:
ConfigHelper
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.

Version:
$Revision: 1.5 $ $Date: 2003/01/05 00:40:04 $

Authors:
Ted Husted
Luis Arias

Since:
1.1

Method Summary

String
getAction(String path)
Return the URL for the specified ActionMapping, otherwise return null.
ActionErrors
getActionErrors()
The org.apache.struts.action.ActionErrors object, for this request.
ActionForm
getActionForm()
ActionFormBeans
getActionFormBeans()
The org.apache.struts.action.ActionFormBeans collection for this application.
ActionForward
getActionForward(String name)
Return the forwarding associated with the specified logical name, if any; otherwise return null.
ActionForwards
getActionForwards()
The org.apache.struts.action.ActionForwards collection for this application.
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.
ActionMappings
getActionMappings()
The context attributes key under which our org.apache.struts.action.ActionMappings collection is normally stored, unless overridden when initializing our ActionServlet.
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.
String
getErrorOutput()
Returns the errors.header, any errors, and the errors.footer.
String
getErrorOutput(String property)
Returns the errors.header, any errors, and the errors.footer.
int
getErrorSize()
Return the number of error messages.
int
getErrorSize(String property)
Return the number of error messages.
Iterator
getErrors()
Return the error messages
Iterator
getErrors(String property)
Return an ActionError for a property
boolean
getErrorsEmpty()
Return true if there are no errors queued
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.
Locale
getLocale()
The java.util.Locale for the user, if any.
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, 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 Details

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.

getActionErrors

public ActionErrors getActionErrors()
The org.apache.struts.action.ActionErrors object, for this request.

getActionForm

public ActionForm getActionForm()

getActionFormBeans

public ActionFormBeans getActionFormBeans()
The org.apache.struts.action.ActionFormBeans collection for this application.

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

getActionForwards

public ActionForwards getActionForwards()
The org.apache.struts.action.ActionForwards collection for this application.

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)

getActionMappingURL

public String getActionMappingURL(String action)
Return the form action converted into a server-relative URL.

getActionMappings

public ActionMappings getActionMappings()
The context attributes key under which our org.apache.struts.action.ActionMappings collection is normally stored, unless overridden when initializing our ActionServlet.

getActionMessages

public ActionMessages getActionMessages()
The org.apache.struts.action.ActionFormBeans collection for this application.

getBaseRef

public String getBaseRef()
Renders the reference for a HTML element

getDataSource

public DataSource getDataSource()

getEncodeURL

public String getEncodeURL(String url)
Return the url encoded to maintain the user session, if any.

getErrorOutput

public String getErrorOutput()
Returns the errors.header, any errors, and the errors.footer.

getErrorOutput

public String getErrorOutput(String property)
Returns the errors.header, any errors, and the errors.footer.

Parameters:
property - Property name

getErrorSize

public int getErrorSize()
Return the number of error messages.

getErrorSize

public int getErrorSize(String property)
Return the number of error messages.

Parameters:
property - Property name

getErrors

public Iterator getErrors()
Return the error messages

getErrors

public Iterator getErrors(String property)
Return an ActionError for a property

Parameters:
property - Property name

getErrorsEmpty

public boolean getErrorsEmpty()
Return true if there are no errors queued

getException

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.

getFormBean

public ActionFormBean getFormBean(String name)
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)
Return the path for the specified forward, otherwise return null.

Parameters:
name - Name given to local or global forward.

getLocale

public Locale getLocale()
The java.util.Locale for the user, if any. If a default locale object is not in the user's session, the system default locale is returned. If used, the user locale is typically set during login processing under the key Globals.LOCALE_KEY.

getMapping

public ActionMapping getMapping()
The org.apache.struts.ActionMapping instance for this request.

getMessage

public String getMessage(String key)
Return the localized message for the specified key, otherwise return null.

Parameters:
key - Message key

getMessage

public String getMessage(String key,
                         args[] )
Look up and return a message string, based on the specified parameters.

Parameters:
key - Message key to be looked up and returned

getMessageResources

public MessageResources getMessageResources()
The application resources for this application.

getMultipartRequestWrapper

public MultipartRequestWrapper getMultipartRequestWrapper()
The multipart object for this request.

getOrigRef

public String getOrigRef()
Renders the reference for a HTML element

getServletMapping

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

getToken

public String getToken()
The transaction token stored in this session, if it is used.

isMessage

public boolean isMessage(String key)
Return true if a message string for the specified message key is present for the user's Locale.

Parameters:
key - Message key

Overview Package Class Use Tree Index Deprecated About
Copyright B) 2000-2005 - Apache Software Foundation