Java Doc for MultipartResponse.java in  » Groupware » hipergate » com » oreilly » servlet » 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 » Groupware » hipergate » com.oreilly.servlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.oreilly.servlet.MultipartResponse

MultipartResponse
public class MultipartResponse (Code)
A utility class to generate multipart/x-mixed-replace responses, the kind of responses that implement server push. Note that Microsoft Internet Explorer does not understand this sort of response.

To use this class, first construct a new MultipartResponse passing to its constructor the servlet's response parameter. MultipartResponse uses the response object to fetch the servlet's output stream and to set the response's content type.

Then, for each page of content, begin by calling startResponse() passing in the content type for that page. Send the content for the page by writing to the output stream as usual. A call to endResponse() ends the page and flushes the content so the client can see it. At this point a sleep() or other delay can be added until the next page is ready for sending.

The call to endResponse() is optional. The startResponse() method knows whether the last response has been ended, and ends it itself if necessary. However, it's wise to call endResponse() if there's to be a delay between the time one response ends and the next begins. It lets the client display the latest response during the time it waits for the next one.

Finally, after each response page has been sent, a call to the finish() method finishes the multipart response and sends a code telling the client there will be no more responses.

For example:

 MultipartResponse multi = new MultipartResponse(res);
  
 multi.startResponse("text/plain");
 out.println("On your mark");
 multi.endResponse();
  
 try { Thread.sleep(1000); } catch (InterruptedException e) { }
  
 multi.startResponse("text/plain");
 out.println("Get set");
 multi.endResponse();
  
 try { Thread.sleep(1000); } catch (InterruptedException e) { }
  
 multi.startResponse("image/gif");
 ServletUtils.returnFile(req.getRealPath("/images/go.gif"), out);
  
 multi.finish();
 

See Also:   ServletUtils
author:
   Jason Hunter, Copyright © 1998
version:
   1.0, 98/09/18


Field Summary
 booleanendedLastResponse
    
 ServletOutputStreamout
    
 HttpServletResponseres
    

Constructor Summary
public  MultipartResponse(HttpServletResponse response)
     Constructs a new MultipartResponse to send content to the given servlet response.

Method Summary
public  voidendResponse()
     Ends a single response.
public  voidfinish()
     Finishes the multipart response.
public  voidstartResponse(String contentType)
     Begins a single response with the specified content type.

Field Detail
endedLastResponse
boolean endedLastResponse(Code)



out
ServletOutputStream out(Code)



res
HttpServletResponse res(Code)




Constructor Detail
MultipartResponse
public MultipartResponse(HttpServletResponse response) throws IOException(Code)
Constructs a new MultipartResponse to send content to the given servlet response.
Parameters:
  response - the servlet response
exception:
  IOException - if an I/O error occurs




Method Detail
endResponse
public void endResponse() throws IOException(Code)
Ends a single response. Flushes the output.
exception:
  IOException - if an I/O error occurs



finish
public void finish() throws IOException(Code)
Finishes the multipart response. Sends a code telling the client there will be no more responses and flushes the output.
exception:
  IOException - if an I/O error occurs



startResponse
public void startResponse(String contentType) throws IOException(Code)
Begins a single response with the specified content type. This method knows whether the last response has been ended, and ends it itself if necessary.
Parameters:
  contentType - the content type of this response part
exception:
  IOException - if an I/O error occurs



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.