|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.struts2.dispatcher.Dispatcher
public class Dispatcher
A utility class the actual dispatcher delegates most of its tasks to. Each instance of the primary dispatcher holds an instance of this dispatcher to be shared for all requests.
FilterDispatcher| Nested Class Summary | |
|---|---|
static class |
Dispatcher.Locator
Provide an accessor class for static XWork utility. |
| Constructor Summary | |
|---|---|
Dispatcher(javax.servlet.ServletContext servletContext,
java.util.Map<java.lang.String,java.lang.String> initParams)
Create the Dispatcher instance for a given ServletContext and set of initialization parameters. |
|
| Method Summary | |
|---|---|
static void |
addDispatcherListener(DispatcherListener listener)
Add a dispatcher lifecycle listener. |
void |
cleanup()
Releases all instances bound to this dispatcher instance. |
void |
cleanUpRequest(javax.servlet.http.HttpServletRequest request)
Removes all the files created by MultiPartRequestWrapper. |
protected ConfigurationManager |
createConfigurationManager(java.lang.String name)
|
java.util.Map<java.lang.String,java.lang.Object> |
createContextMap(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping,
javax.servlet.ServletContext context)
Create a context map containing all the wrapped request objects |
java.util.HashMap<java.lang.String,java.lang.Object> |
createContextMap(java.util.Map requestMap,
java.util.Map parameterMap,
java.util.Map sessionMap,
java.util.Map applicationMap,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext servletContext)
Merge all application and servlet attributes into a single HashMap to represent the entire Action context. |
protected XmlConfigurationProvider |
createStrutsXmlConfigurationProvider(java.lang.String filename,
boolean errorIfMissing,
javax.servlet.ServletContext ctx)
|
protected XmlConfigurationProvider |
createXmlConfigurationProvider(java.lang.String filename,
boolean errorIfMissing)
|
ConfigurationManager |
getConfigurationManager()
Expose the ConfigurationManager instance. |
Container |
getContainer()
Expose the dependency injection container. |
static Dispatcher |
getInstance()
Provide the dispatcher instance for the current thread. |
void |
init()
Load configurations, including both XML and zero-configuration strategies, and update optional settings, including whether to reload configurations and resource files. |
void |
prepare(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Prepare a request, including setting the encoding and locale. |
static void |
removeDispatcherListener(DispatcherListener listener)
Remove a specific dispatcher lifecycle listener. |
void |
sendError(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext ctx,
int code,
java.lang.Exception e)
Send an HTTP error response code. |
void |
serviceAction(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext context,
ActionMapping mapping)
Load Action class for mapping and invoke the appropriate Action method, or go directly to the Result. |
void |
setConfigurationManager(ConfigurationManager mgr)
Modify the ConfigurationManager instance |
void |
setDefaultEncoding(java.lang.String val)
Modify state of StrutsConstants.STRUTS_I18N_ENCODING setting. |
void |
setDefaultLocale(java.lang.String val)
Modify state of StrutsConstants.STRUTS_LOCALE setting. |
void |
setDevMode(java.lang.String mode)
Modify state of StrutsConstants.STRUTS_DEVMODE setting. |
static void |
setInstance(Dispatcher instance)
Store the dispatcher instance for this thread. |
void |
setMultipartHandler(java.lang.String val)
|
void |
setMultipartSaveDir(java.lang.String val)
Modify state of StrutsConstants.STRUTS_MULTIPART_SAVEDIR setting. |
void |
setValueStackFactory(ValueStackFactory valueStackFactory)
|
javax.servlet.http.HttpServletRequest |
wrapRequest(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext servletContext)
Wrap and return the given request or return the original request object. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Dispatcher(javax.servlet.ServletContext servletContext,
java.util.Map<java.lang.String,java.lang.String> initParams)
servletContext - Our servlet contextinitParams - The set of initialization parameters| Method Detail |
|---|
public static Dispatcher getInstance()
public static void setInstance(Dispatcher instance)
instance - The instancepublic static void addDispatcherListener(DispatcherListener listener)
listener - The listener to addpublic static void removeDispatcherListener(DispatcherListener listener)
listener - The listenerpublic void setDevMode(java.lang.String mode)
mode - New settingpublic void setDefaultLocale(java.lang.String val)
val - New settingpublic void setDefaultEncoding(java.lang.String val)
val - New settingpublic void setMultipartSaveDir(java.lang.String val)
val - New settingpublic void setMultipartHandler(java.lang.String val)
public void setValueStackFactory(ValueStackFactory valueStackFactory)
public void cleanup()
protected XmlConfigurationProvider createXmlConfigurationProvider(java.lang.String filename,
boolean errorIfMissing)
protected XmlConfigurationProvider createStrutsXmlConfigurationProvider(java.lang.String filename,
boolean errorIfMissing,
javax.servlet.ServletContext ctx)
public void init()
protected ConfigurationManager createConfigurationManager(java.lang.String name)
public void serviceAction(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext context,
ActionMapping mapping)
throws javax.servlet.ServletException
sendError(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext, int, java.lang.Exception) method,
using the 404 return code.
All other errors are reported by throwing a ServletException.
request - the HttpServletRequest objectresponse - the HttpServletResponse objectmapping - the action mapping objectcontext - Our ServletContext object
javax.servlet.ServletException - when an unknown error occurs (not a 404, but typically something that
would end up as a 5xx by the servlet container)
public java.util.Map<java.lang.String,java.lang.Object> createContextMap(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping,
javax.servlet.ServletContext context)
request - The servlet requestresponse - The servlet responsemapping - The action mappingcontext - The servlet context
public java.util.HashMap<java.lang.String,java.lang.Object> createContextMap(java.util.Map requestMap,
java.util.Map parameterMap,
java.util.Map sessionMap,
java.util.Map applicationMap,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext servletContext)
requestMap - a Map of all request attributes.parameterMap - a Map of all request parameters.sessionMap - a Map of all session attributes.applicationMap - a Map of all servlet context attributes.request - the HttpServletRequest object.response - the HttpServletResponse object.servletContext - the ServletContextmapping object.
public void prepare(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
request - The requestresponse - The response
public javax.servlet.http.HttpServletRequest wrapRequest(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext servletContext)
throws java.io.IOException
MultiPartRequestWrapper is
flexible - look first to that object before overriding this method to handle multipart data.
request - the HttpServletRequest object.servletContext - Our ServletContext object
java.io.IOException - on any error.MultiPartRequestWrapper
public void cleanUpRequest(javax.servlet.http.HttpServletRequest request)
throws java.io.IOException
request - the HttpServletRequest object.
java.io.IOException - on any error.MultiPartRequestWrapper
public void sendError(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext ctx,
int code,
java.lang.Exception e)
request - the HttpServletRequest object.response - the HttpServletResponse object.code - the HttpServletResponse error code (see HttpServletResponse for possible error codes).e - the Exception that is reported.ctx - the ServletContext object.public ConfigurationManager getConfigurationManager()
public void setConfigurationManager(ConfigurationManager mgr)
mgr - The configuration managerpublic Container getContainer()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||