We have seen two programs with include() and forward() methods of RequestDispatcher. In both the programs, getRequestDispatcher(String path) of ServletRequest is used to obtain an object of RequestDispatcher. Infact, RequestDispatcher object can be obtained in another way also – using javax.servlet.ServletContext. The same getRequestDispatcher(String path) method exist in ServletContext also. That is, the same method getRequestDispatcher(String path) exists in both the interfaces of ServletRequest and ServletContext. The method returns an object of RequestDispatcher.
Let us see the signature as defined in API of ServletRequest:
- RequestDispatcher getRequestDispatcher(java.lang.String path):
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher. The difference between this method and ServletContext#getRequestDispatcher is that this method can take a relative path.
Signature as defined in API of ServletContext:
- RequestDispatcher getRequestDispatcher(java.lang.String path):
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.
The pathname must begin with a "/" and is interpreted as relative to the current context root. Use getContext to obtain a RequestDispatcher for resources in foreign contexts. This method returns null if the ServletContext cannot return a RequestDispatcher.
Following table gives the differences of using getRequestDispatcher(String path) method to obtain an object of RequestDispatcher.
| Property | ServletRequest | ServletContext |
|---|---|---|
| Context | Cannot work outside the present Servlet context. | Capable to use foreign Servlet context also. Can use getContext() to obtain RequestDispatcher of other contexts. |
| Access Location | getRequestDispatcher() of ServletRequest is useful to refer the servlets available in the same Web application. | getRequestDispatcher() of ServletContext is useful to refer servlets available on other Web applications on different Web server also. |
| Scope | Stored in page level. | Scope is application level. |
| Relative position | request.getRequestDispatcher("url") means the dispatch is relative to the current HTTP request. That is, it locates the resource relative to the request path | getServletContext().getRequestDispatcher("url") means the dispatch is relative to the root of the current context. |
| Accessibility | Used to call a Servlet or JSP within the current application available, that too, on the same Web server. | Used to call a Servlet or JSP exiting on another Web server. |
| Example Code | request.getRequestDispatcher("/S2"); where S2 is the alias name of the Servlet available on the same server and on the same Web application. | getServletContext().getRequestDispatcher("/india/S2"); where india is the current context root(in all our earlier Servlet programs). |
=============For Extra Reading on related Topics===============