|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
java.lang.String |
getAction(java.lang.String path)
Return the URL for the specified ActionMapping, otherwise return null . |
ActionForm |
getActionForm()
|
ActionForward |
getActionForward(java.lang.String name)
Return the forwarding associated with the specified logical name, if any; otherwise return null . |
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. |
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.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 . |
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 |
---|
javax.sql.DataSource getDataSource()
ActionMessages getActionMessages()
org.apache.struts.action.ActionFormBeans
collection
for this application.
MessageResources getMessageResources()
java.lang.String getServletMapping()
/action/*
) or
extension mapped pattern ((*.do
)
used to determine our Action URIs in this application.
java.lang.String getToken()
java.lang.Throwable getException()
MultipartRequestWrapper getMultipartRequestWrapper()
ActionMapping getMapping()
org.apache.struts.ActionMapping
instance for this request.
boolean isMessage(java.lang.String key)
key
- Message keyActionForm getActionForm()
ActionFormBean getFormBean(java.lang.String name)
null
.
name
- Logical name of the requested form bean definitionActionForward getActionForward(java.lang.String name)
null
.
name
- Logical name of the requested forwardingActionMapping getActionMapping(java.lang.String path)
null
.
path
- Request path for which a mapping is requestedjava.lang.String getActionMappingName(java.lang.String action)
action
property is manipulated as follows in
computing the name of the requested mapping:
java.lang.String getActionMappingURL(java.lang.String action)
java.lang.String getEncodeURL(java.lang.String url)
java.lang.String getOrigRef()
java.lang.String getBaseRef()
java.lang.String getLink(java.lang.String name)
null
.
name
- Name given to local or global forward.java.lang.String getMessage(java.lang.String key)
null
.
key
- Message keyjava.lang.String getMessage(java.lang.String key, java.lang.Object[] args)
key
- Message key to be looked up and returnedargs
- Replacement parameters for this messagejava.lang.String getAction(java.lang.String path)
null
.
path
- Name given to local or global forward.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |