|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
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()
|
java.lang.String |
getEncodeURL(java.lang.String url)
Return the url encoded to maintain the user session, if any. |
java.lang.String |
getErrorOutput()
Returns the errors.header, any errors, and the errors.footer. |
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. |
Method Detail |
public javax.sql.DataSource getDataSource()
public ActionMessages getActionMessages()
org.apache.struts.action.ActionFormBeans
collection
for this application.
public ActionFormBeans getActionFormBeans()
org.apache.struts.action.ActionFormBeans
collection
for this application.
public ActionForwards getActionForwards()
org.apache.struts.action.ActionForwards
collection
for this application.
public ActionMappings getActionMappings()
org.apache.struts.action.ActionMappings
collection
is normally stored, unless overridden when initializing our
ActionServlet.
public MessageResources getMessageResources()
public java.lang.String getServletMapping()
/action/*
) or
extension mapped pattern ((*.do
)
used to determine our Action URIs in this application.
public 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
.
public java.lang.String getToken()
public ActionErrors getActionErrors()
org.apache.struts.action.ActionErrors
object,
for this request.
public java.lang.Throwable getException()
public MultipartRequestWrapper getMultipartRequestWrapper()
public ActionMapping getMapping()
org.apache.struts.ActionMapping
instance for this request.
public boolean isMessage(java.lang.String key)
key
- Message keypublic ActionForm getActionForm()
public ActionFormBean getFormBean(java.lang.String name)
null
.
name
- Logical name of the requested form bean definitionpublic ActionForward getActionForward(java.lang.String name)
null
.
name
- Logical name of the requested forwardingpublic ActionMapping getActionMapping(java.lang.String path)
null
.
path
- 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:
public java.lang.String getActionMappingURL(java.lang.String action)
public java.lang.String getEncodeURL(java.lang.String url)
public java.lang.String getOrigRef()
public java.lang.String getBaseRef()
public java.lang.String getLink(java.lang.String name)
null
.
name
- Name given to local or global forward.public java.lang.String getMessage(java.lang.String key)
null
.
key
- Message keypublic java.lang.String getMessage(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 getAction(java.lang.String path)
null
.
path
- Name given to local or global forward.public int getErrorSize()
public boolean getErrorsEmpty()
public java.util.Iterator getErrors()
public java.lang.String getErrorOutput()
public int getErrorSize(java.lang.String property)
property
- Property namepublic java.lang.String getErrorOutput(java.lang.String property)
property
- Property namepublic java.util.Iterator getErrors(java.lang.String property)
property
- Property name
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |