Java Doc for ItsNatServletRequestListener.java in  » Ajax » ItsNat » org » itsnat » core » event » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This interface is the ItsNat version of the Servlet.service(ServletRequest,ServletResponse) version. When a client request is received the ItsNat servlet converts and routes this request to the registered ItsNatServletRequestListener objects invoking ItsNatServletRequestListener.processRequest(ItsNatServletRequest,ItsNatServletResponse) . A request listener is registered usually calling org.itsnat.core.DocumentTemplate.addItsNatServletRequestListener(ItsNatServletRequestListener) and optionally calling org.itsnat.core.ItsNatServlet.addItsNatServletRequestListener(ItsNatServletRequestListener) (for uses like filtering etc).

Another different use is as ItsNat referrer request listener if registered with org.itsnat.core.ItsNatDocument.addReferrerItsNatServletRequestListener(ItsNatServletRequestListener) . In this case the listener is called when the framework loads a new target document and the referrer document (the document where the listener was registered) is being unloaded and before the target request listeners are executed (referrer push). Request and response objects are the same objects being sent to the normal target request listeners, target document may be modified, new request attributes may be added etc before ItsNat delegates to the normal target loading process.

If a new document was requested the org.itsnat.core.ItsNatDocument object is already created using the required template, if the request is an AJAX event the document object is already located, in both cases it may be obtained calling org.itsnat.core.ItsNatServletRequest.getItsNatDocument or org.itsnat.core.ItsNatServletResponse.getItsNatDocument . In this scenario there is no need to use the standard output stream ( ServletResponse.getWriter() or ServletResponse.getOutputStream() ) because ItsNat already uses it behind the scenes. Usual request processing involves DOM tree manipulation or custom JavaScript is sent calling org.itsnat.core.ItsNatDocument.addCodeToSend(Object) .

If no new or existing document is requested the request processing is mostly the same as the typical Servlet.service(ServletRequest,ServletResponse) processing including output to standard output stream. This scenario is an opportunity to change the normal ItsNat document request for instance to implement pretty URLs, because the request may be forwarded again to ItsNat calling org.itsnat.core.ItsNatServlet.processRequest(ServletRequestServletResponse) .