Java Doc for RemoteServiceServlet.java in  » Ajax » GWT » com » google » gwt » user » server » rpc » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Ajax » GWT » com.google.gwt.user.server.rpc 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.servlet.http.HttpServlet
   com.google.gwt.user.server.rpc.RemoteServiceServlet

All known Subclasses:   test.ServletMappingTestServiceImpl3,  com.google.gwt.user.server.rpc.ObjectGraphTestServiceImpl,  com.google.gwt.sample.dynatable.server.SchoolCalendarServiceImpl,  com.google.gwt.user.server.rpc.EnumsTestServiceImpl,  com.google.gwt.sample.simplerpc.server.SimpleRPCServiceImpl,  com.google.gwt.user.server.rpc.ValueTypesTestServiceImpl,  test.ServletMappingTestServiceImpl1,  com.google.gwt.user.server.rpc.CustomFieldSerializerTestServiceImpl,  com.google.gwt.junit.viewer.server.ReportServerImpl,  com.google.gwt.user.server.rpc.CollectionsTestServiceImpl,  com.google.gwt.user.server.rpc.RemoteServiceServletTestServiceImplBase,  com.google.gwt.junit.server.JUnitHostImpl,  com.google.gwt.user.server.rpc.UnicodeEscapingServiceImpl,  com.google.gwt.user.server.rpc.InheritanceTestServiceImpl,  test.ServletMappingTestServiceImpl2,
RemoteServiceServlet
public class RemoteServiceServlet extends HttpServlet implements SerializationPolicyProvider(Code)
The servlet base class for your RPC service implementations that automatically deserializes incoming requests from the client and serializes outgoing responses for client/server RPCs.



Constructor Summary
public  RemoteServiceServlet()
     The default constructor.

Method Summary
protected  SerializationPolicydoGetSerializationPolicy(HttpServletRequest request, String moduleBaseURL, String strongName)
     Gets the SerializationPolicy for given module base URL and strong name if there is one.
final public  voiddoPost(HttpServletRequest request, HttpServletResponse response)
     Standard HttpServlet method: handle the POST.
protected  voiddoUnexpectedFailure(Throwable e)
     Override this method to control what should happen when an exception escapes the RemoteServiceServlet.processCall(String) method.
final public  SerializationPolicygetSerializationPolicy(String moduleBaseURL, String strongName)
    
final protected  HttpServletRequestgetThreadLocalRequest()
     Gets the HttpServletRequest object for the current call.
final protected  HttpServletResponsegetThreadLocalResponse()
     Gets the HttpServletResponse object for the current call.
protected  voidonAfterResponseSerialized(String serializedResponse)
     Override this method to examine the serialized response that will be returned to the client.
protected  voidonBeforeRequestDeserialized(String serializedRequest)
     Override this method to examine the serialized version of the request payload before it is deserialized into objects.
public  StringprocessCall(String payload)
     Process a call originating from the given request.
protected  booleanshouldCompressResponse(HttpServletRequest request, HttpServletResponse response, String responsePayload)
     Determines whether the response to a given servlet request should or should not be GZIP compressed.


Constructor Detail
RemoteServiceServlet
public RemoteServiceServlet()(Code)
The default constructor.




Method Detail
doGetSerializationPolicy
protected SerializationPolicy doGetSerializationPolicy(HttpServletRequest request, String moduleBaseURL, String strongName)(Code)
Gets the SerializationPolicy for given module base URL and strong name if there is one. Override this method to provide a SerializationPolicy using an alternative approach.
Parameters:
  request - the HTTP request being serviced
Parameters:
  moduleBaseURL - as specified in the incoming payload
Parameters:
  strongName - a strong name that uniquely identifies a serializationpolicy file a SerializationPolicy for the given module base URL andstrong name, or null if there is none



doPost
final public void doPost(HttpServletRequest request, HttpServletResponse response)(Code)
Standard HttpServlet method: handle the POST. This doPost method swallows ALL exceptions, logs them in the ServletContext, and returns a GENERIC_FAILURE_MSG response with status code 500.



doUnexpectedFailure
protected void doUnexpectedFailure(Throwable e)(Code)
Override this method to control what should happen when an exception escapes the RemoteServiceServlet.processCall(String) method. The default implementation will log the failure and send a generic failure response to the client.

An "expected failure" is an exception thrown by a service method that is declared in the signature of the service method. These exceptions are serialized back to the client, and are not passed to this method. This method is called only for exceptions or errors that are not part of the service method's signature, or that result from SecurityExceptions, SerializationExceptions, or other failures within the RPC framework.

Note that if the desired behavior is to both send the GENERIC_FAILURE_MSG response AND to rethrow the exception, then this method should first send the GENERIC_FAILURE_MSG response itself (using getThreadLocalResponse), and then rethrow the exception. Rethrowing the exception will cause it to escape into the servlet container.
Parameters:
  e - the exception which was thrown




getSerializationPolicy
final public SerializationPolicy getSerializationPolicy(String moduleBaseURL, String strongName)(Code)



getThreadLocalRequest
final protected HttpServletRequest getThreadLocalRequest()(Code)
Gets the HttpServletRequest object for the current call. It is stored thread-locally so that simultaneous invocations can have different request objects.



getThreadLocalResponse
final protected HttpServletResponse getThreadLocalResponse()(Code)
Gets the HttpServletResponse object for the current call. It is stored thread-locally so that simultaneous invocations can have different response objects.



onAfterResponseSerialized
protected void onAfterResponseSerialized(String serializedResponse)(Code)
Override this method to examine the serialized response that will be returned to the client. The default implementation does nothing and need not be called by subclasses.



onBeforeRequestDeserialized
protected void onBeforeRequestDeserialized(String serializedRequest)(Code)
Override this method to examine the serialized version of the request payload before it is deserialized into objects. The default implementation does nothing and need not be called by subclasses.



processCall
public String processCall(String payload) throws SerializationException(Code)
Process a call originating from the given request. Uses the RPC.invokeAndEncodeResponse(Objectjava.lang.reflect.MethodObject[]) method to do the actual work.

Subclasses may optionally override this method to handle the payload in any way they desire (by routing the request to a framework component, for instance). The HttpServletRequest and HttpServletResponse can be accessed via the RemoteServiceServlet.getThreadLocalRequest() and RemoteServiceServlet.getThreadLocalResponse() methods.

This is public so that it can be unit tested easily without HTTP.
Parameters:
  payload - the UTF-8 request payload a string which encodes either the method's return, a checkedexception thrown by the method, or anIncompatibleRemoteServiceException
throws:
  SerializationException - if we cannot serialize the response
throws:
  UnexpectedException - if the invocation throws a checked exceptionthat is not declared in the service method's signature
throws:
  RuntimeException - if the service method throws an uncheckedexception (the exception will be the one thrown by the service)



shouldCompressResponse
protected boolean shouldCompressResponse(HttpServletRequest request, HttpServletResponse response, String responsePayload)(Code)
Determines whether the response to a given servlet request should or should not be GZIP compressed. This method is only called in cases where the requestor accepts GZIP encoding.

This implementation currently returns true if the response string's estimated byte length is longer than 256 bytes. Subclasses can override this logic.


Parameters:
  request - the request being served
Parameters:
  response - the response that will be written into
Parameters:
  responsePayload - the payload that is about to be sent to the client true if responsePayload should be GZIP compressed,otherwise false.



Methods inherited from javax.servlet.http.HttpServlet
protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected long getLastModified(HttpServletRequest req)(Code)(Java Doc)
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.