|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--org.apache.struts.config.ConfigHelper
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.
| Field Summary | |
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. |
| Constructor Summary | |
ConfigHelper()
|
|
ConfigHelper(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
|
| Method Summary | |
java.lang.String |
action(java.lang.String path)
Wrapper for getAction(String) |
java.lang.String |
errorOutput()
Wrapper for getErrorMarkup() |
java.lang.String |
errorOutput(java.lang.String property)
Wrapper for getErrorMarkup(String) |
java.util.Iterator |
errors()
Wrapper for getErrors() |
java.util.Iterator |
errors(java.lang.String property)
Wrapper for getErrors(String) |
boolean |
errorsEmpty()
Wrapper for getErrorEmpty() |
int |
errorSize()
Alias for getErrorSize() |
int |
errorSize(java.lang.String property)
Wrapper for getErrorSize(String) |
java.lang.String |
getAction(java.lang.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(java.lang.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(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. |
ActionMappings |
getActionMappings()
The context attributes key under which our org.apache.struts.action.ActionMappings collection
is normally stored, unless overridden when initializing our
ActionServlet. |
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 |
javax.sql.DataSource |
getDataSource()
The strong>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.String |
getErrorOutput()
Wrapper for getErrorMarkup(null) |
java.lang.String |
getErrorOutput(java.lang.String property)
Returns the errors.header, any errors, and the errors.footer. |
java.util.Iterator |
getErrors()
Return the error messages |
java.util.Iterator |
getErrors(java.lang.String property)
Return an ActionError for a property |
boolean |
getErrorsEmpty()
Return true if there are no errors queued |
int |
getErrorSize()
Return the number of error messages. |
int |
getErrorSize(java.lang.String property)
Return the number of error messages. |
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. |
java.util.Locale |
getLocale()
The java.util.Locale for the user, if any. |
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 |
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. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
private javax.servlet.ServletContext application
private javax.servlet.http.HttpSession session
private javax.servlet.http.HttpServletRequest request
private javax.servlet.http.HttpServletResponse response
private ActionForward forward
| Constructor Detail |
public ConfigHelper()
public ConfigHelper(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
| Method Detail |
public void setApplication(javax.servlet.ServletContext application)
public void setSession(javax.servlet.http.HttpSession session)
public void setRequest(javax.servlet.http.HttpServletRequest request)
public void setResponse(javax.servlet.http.HttpServletResponse response)
public void setForward(ActionForward forward)
public void setResources(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
application - - The associated ServletContext.request - - The associated HTTP request.response - - The associated HTTP response.public javax.sql.DataSource getDataSource()
javax.sql.DataSource),
if one is configured for this application.
getDataSource in interface ConfigHelperInterfacepublic ActionMessages getActionMessages()
ConfigHelperInterfaceorg.apache.struts.action.ActionFormBeans collection
for this application.
getActionMessages in interface ConfigHelperInterfacepublic ActionFormBeans getActionFormBeans()
org.apache.struts.action.ActionFormBeans collection
for this application.
getActionFormBeans in interface ConfigHelperInterfacepublic ActionForwards getActionForwards()
org.apache.struts.action.ActionForwards collection
for this application.
getActionForwards in interface ConfigHelperInterfacepublic ActionMappings getActionMappings()
org.apache.struts.action.ActionMappings collection
is normally stored, unless overridden when initializing our
ActionServlet.
getActionMappings in interface ConfigHelperInterfacepublic MessageResources getMessageResources()
getMessageResources in interface ConfigHelperInterfacepublic java.lang.String getServletMapping()
/action/*) or
extension mapped pattern ((*.do)
used to determine our Action URIs in this application.
getServletMapping in interface ConfigHelperInterfacepublic java.util.Locale getLocale()
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.
getLocale in interface ConfigHelperInterfacepublic java.lang.String getToken()
getToken in interface ConfigHelperInterfacepublic ActionErrors getActionErrors()
org.apache.struts.action.ActionErrors object,
for this request.
getActionErrors in interface ConfigHelperInterfacepublic java.lang.Throwable getException()
getException in interface ConfigHelperInterfacepublic MultipartRequestWrapper getMultipartRequestWrapper()
getMultipartRequestWrapper in interface ConfigHelperInterfacepublic ActionMapping getMapping()
org.apache.struts.ActionMapping
instance for this request.
getMapping in interface ConfigHelperInterfacepublic boolean isMessage(java.lang.String key)
isMessage in interface ConfigHelperInterfacekey - Message keypublic ActionForm getActionForm()
getActionForm in interface ConfigHelperInterfacepublic ActionFormBean getFormBean(java.lang.String name)
null.
getFormBean in interface ConfigHelperInterfacename - Logical name of the requested form bean definitionpublic ActionForward getActionForward(java.lang.String name)
null.
getActionForward in interface ConfigHelperInterfacename - Logical name of the requested forwardingpublic ActionMapping getActionMapping(java.lang.String path)
null.
getActionMapping in interface ConfigHelperInterfacepath - Request path for which a mapping is requestedpublic java.lang.String getActionMappingName(java.lang.String action)
action property is manipulated as follows in
computing the name of the requested mapping:
getActionMappingName in interface ConfigHelperInterfacepublic java.lang.String getActionMappingURL(java.lang.String action)
getActionMappingURL in interface ConfigHelperInterfacepublic java.lang.String getEncodeURL(java.lang.String url)
getEncodeURL in interface ConfigHelperInterfacepublic java.lang.String getOrigRef()
getOrigRef in interface ConfigHelperInterfacepublic java.lang.String getBaseRef()
getBaseRef in interface ConfigHelperInterfacepublic java.lang.String getLink(java.lang.String name)
null.
getLink in interface ConfigHelperInterfacename - Name given to local or global forward.public java.lang.String getMessage(java.lang.String key)
null.
getMessage in interface ConfigHelperInterfacekey - Message key
public java.lang.String getMessage(java.lang.String key,
java.lang.Object[] args)
getMessage in interface ConfigHelperInterfacekey - Message key to be looked up and returnedargs - Replacement parameters for this messagepublic java.lang.String getAction(java.lang.String path)
null.
getAction in interface ConfigHelperInterfacepath - Name given to local or global forward.public int getErrorSize()
getErrorSize in interface ConfigHelperInterfacepublic boolean getErrorsEmpty()
getErrorsEmpty in interface ConfigHelperInterfacepublic java.util.Iterator getErrors()
getErrors in interface ConfigHelperInterfacepublic java.util.Iterator getErrors(java.lang.String property)
getErrors in interface ConfigHelperInterfaceproperty - Property namepublic int getErrorSize(java.lang.String property)
getErrorSize in interface ConfigHelperInterfaceproperty - Property namepublic java.lang.String getErrorOutput(java.lang.String property)
getErrorOutput in interface ConfigHelperInterfaceproperty - Property namepublic java.lang.String getErrorOutput()
getErrorOutput in interface ConfigHelperInterfacepublic java.lang.String link(java.lang.String name)
name - Name given to local or global forward.public java.lang.String message(java.lang.String key)
key - Message key
public java.lang.String message(java.lang.String key,
java.lang.Object[] args)
key - Message key to be looked up and returnedargs - Replacement parameters for this messagepublic java.lang.String action(java.lang.String path)
path - Name given to local or global forward.public int errorSize()
public boolean errorsEmpty()
public java.util.Iterator errors()
public java.util.Iterator errors(java.lang.String property)
public int errorSize(java.lang.String property)
property - Property namepublic java.lang.String errorOutput(java.lang.String property)
public java.lang.String errorOutput()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||