Java Doc for ResponseBase.java in  » Web-Server » Rimfaxe-Web-Server » org » apache » catalina » connector » 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 » Web Server » Rimfaxe Web Server » org.apache.catalina.connector 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.catalina.connector.ResponseBase

All known Subclasses:   org.apache.catalina.connector.HttpResponseBase,
ResponseBase
abstract public class ResponseBase implements Response,ServletResponse(Code)
Convenience base implementation of the Response interface, which can be used for the Response implementation required by most Connectors. Only the connector-specific methods need to be implemented.
author:
   Craig R. McClanahan
author:
   Remy Maucherat
version:
   $Revision: 1.25 $ $Date: 2002/03/18 07:15:39 $


Field Summary
protected  booleanappCommitted
    
protected  byte[]buffer
     The buffer through which all of our output bytes are passed.
protected  intbufferCount
     The number of data bytes currently in the buffer.
protected  booleancommitted
    
protected  Connectorconnector
     The Connector through which this Response is returned.
protected  intcontentCount
     The actual number of bytes written to this Response.
protected  intcontentLength
     The content length associated with this Response.
protected  StringcontentType
     The content type associated with this Response.
protected  Contextcontext
     The Context within which this Response is being produced.
protected  Stringencoding
     The character encoding associated with this Response.
protected  booleanerror
     Error flag.
protected  ResponseFacadefacade
     The facade associated with this response.
protected  booleanincluded
    
final protected static  Stringinfo
     Descriptive information about this Response implementation.
protected  Localelocale
     The Locale associated with this Response.
protected  OutputStreamoutput
     The output stream associated with this Response.
protected  Requestrequest
     The Request with which this Response is associated.
protected static  StringManagersm
     The string manager for this package.
protected  ServletOutputStreamstream
     The ServletOutputStream that has been returned by getOutputStream(), if any.
protected  booleansuspended
    
protected  PrintWriterwriter
     The PrintWriter that has been returned by getWriter(), if any.


Method Summary
public  ServletOutputStreamcreateOutputStream()
     Create and return a ServletOutputStream to write the content associated with this Response.
public  voidfinishResponse()
     Perform whatever actions are required to flush and close the output stream or writer, in a single operation.
public  voidflushBuffer()
     Flush the buffer and commit this response.
public  intgetBufferSize()
     Return the actual buffer size used for this Response.
public  StringgetCharacterEncoding()
     Return the character encoding used for this Response.
public  ConnectorgetConnector()
     Return the Connector through which this Response will be transmitted.
public  intgetContentCount()
     Return the number of bytes actually written to the output stream.
public  intgetContentLength()
     Return the content length that was set or calculated for this Response.
public  StringgetContentType()
     Return the content type that was set or calculated for this response, or null if no content type was set.
public  ContextgetContext()
     Return the Context with which this Response is associated.
public  booleangetIncluded()
     Return the "processing inside an include" flag.
public  StringgetInfo()
     Return descriptive information about this Response implementation and the corresponding version number, in the format <description>/<version>.
public  LocalegetLocale()
     Return the Locale assigned to this response.
public  ServletOutputStreamgetOutputStream()
     Return the servlet output stream associated with this Response.
public  PrintWritergetReporter()
     Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.
public  RequestgetRequest()
     Return the Request with which this Response is associated.
public  ServletResponsegetResponse()
     Return the ServletResponse for which this object is the facade.
public  OutputStreamgetStream()
     Return the output stream associated with this Response.
public  PrintWritergetWriter()
     Return the writer associated with this Response.
public  booleanisAppCommitted()
     Application commit flag accessor.
public  booleanisCommitted()
    
public  booleanisError()
     Error flag accessor.
public  booleanisSuspended()
     Suspended flag accessor.
public  voidrecycle()
     Release all object references, and initialize instance variables, in preparation for reuse of this object.
public  voidreset()
     Clear any content written to the buffer.
public  voidresetBuffer()
     Reset the data buffer but not any status or header information.
public  voidsetAppCommitted(boolean appCommitted)
     Set the application commit flag.
public  voidsetBufferSize(int size)
     Set the buffer size to be used for this Response.
public  voidsetConnector(Connector connector)
     Set the Connector through which this Response will be transmitted.
public  voidsetContentLength(int length)
     Set the content length (in bytes) for this Response.
public  voidsetContentType(String type)
     Set the content type for this Response.
public  voidsetContext(Context context)
     Set the Context with which this Response is associated.
public  voidsetError()
     Set the error flag.
public  voidsetIncluded(boolean included)
     Set the "processing inside an include" flag.
public  voidsetLocale(Locale locale)
     Set the Locale that is appropriate for this response, including setting the appropriate character encoding.
public  voidsetRequest(Request request)
     Set the Request with which this Response is associated.
public  voidsetStream(OutputStream stream)
     Set the output stream associated with this Response.
public  voidsetSuspended(boolean suspended)
     Set the suspended flag.
public  voidwrite(int b)
     Write the specified byte to our output stream, flushing if necessary.
public  voidwrite(byte b)
     Write b.length bytes from the specified byte array to our output stream.
public  voidwrite(byte b, int off, int len)
     Write len bytes from the specified byte array, starting at the specified offset, to our output stream.

Field Detail
appCommitted
protected boolean appCommitted(Code)
Has this response been committed by the application yet?



buffer
protected byte[] buffer(Code)
The buffer through which all of our output bytes are passed.



bufferCount
protected int bufferCount(Code)
The number of data bytes currently in the buffer.



committed
protected boolean committed(Code)
Has this response been committed yet?



connector
protected Connector connector(Code)
The Connector through which this Response is returned.



contentCount
protected int contentCount(Code)
The actual number of bytes written to this Response.



contentLength
protected int contentLength(Code)
The content length associated with this Response.



contentType
protected String contentType(Code)
The content type associated with this Response.



context
protected Context context(Code)
The Context within which this Response is being produced.



encoding
protected String encoding(Code)
The character encoding associated with this Response.



error
protected boolean error(Code)
Error flag. True if the response is an error report.



facade
protected ResponseFacade facade(Code)
The facade associated with this response.



included
protected boolean included(Code)
Are we currently processing inside a RequestDispatcher.include()?



info
final protected static String info(Code)
Descriptive information about this Response implementation.



locale
protected Locale locale(Code)
The Locale associated with this Response.



output
protected OutputStream output(Code)
The output stream associated with this Response.



request
protected Request request(Code)
The Request with which this Response is associated.



sm
protected static StringManager sm(Code)
The string manager for this package.



stream
protected ServletOutputStream stream(Code)
The ServletOutputStream that has been returned by getOutputStream(), if any.



suspended
protected boolean suspended(Code)
Has this response output been suspended?



writer
protected PrintWriter writer(Code)
The PrintWriter that has been returned by getWriter(), if any.





Method Detail
createOutputStream
public ServletOutputStream createOutputStream() throws IOException(Code)
Create and return a ServletOutputStream to write the content associated with this Response.
exception:
  IOException - if an input/output error occurs



finishResponse
public void finishResponse() throws IOException(Code)
Perform whatever actions are required to flush and close the output stream or writer, in a single operation.
exception:
  IOException - if an input/output error occurs



flushBuffer
public void flushBuffer() throws IOException(Code)
Flush the buffer and commit this response.
exception:
  IOException - if an input/output error occurs



getBufferSize
public int getBufferSize()(Code)
Return the actual buffer size used for this Response.



getCharacterEncoding
public String getCharacterEncoding()(Code)
Return the character encoding used for this Response.



getConnector
public Connector getConnector()(Code)
Return the Connector through which this Response will be transmitted.



getContentCount
public int getContentCount()(Code)
Return the number of bytes actually written to the output stream.



getContentLength
public int getContentLength()(Code)
Return the content length that was set or calculated for this Response.



getContentType
public String getContentType()(Code)
Return the content type that was set or calculated for this response, or null if no content type was set.



getContext
public Context getContext()(Code)
Return the Context with which this Response is associated.



getIncluded
public boolean getIncluded()(Code)
Return the "processing inside an include" flag.



getInfo
public String getInfo()(Code)
Return descriptive information about this Response implementation and the corresponding version number, in the format <description>/<version>.



getLocale
public Locale getLocale()(Code)
Return the Locale assigned to this response.



getOutputStream
public ServletOutputStream getOutputStream() throws IOException(Code)
Return the servlet output stream associated with this Response.
exception:
  IllegalStateException - if getWriter hasalready been called for this response
exception:
  IOException - if an input/output error occurs



getReporter
public PrintWriter getReporter()(Code)
Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.



getRequest
public Request getRequest()(Code)
Return the Request with which this Response is associated.



getResponse
public ServletResponse getResponse()(Code)
Return the ServletResponse for which this object is the facade.



getStream
public OutputStream getStream()(Code)
Return the output stream associated with this Response.



getWriter
public PrintWriter getWriter() throws IOException(Code)
Return the writer associated with this Response.
exception:
  IllegalStateException - if getOutputStream hasalready been called for this response
exception:
  IOException - if an input/output error occurs



isAppCommitted
public boolean isAppCommitted()(Code)
Application commit flag accessor.



isCommitted
public boolean isCommitted()(Code)
Has the output of this response already been committed?



isError
public boolean isError()(Code)
Error flag accessor.



isSuspended
public boolean isSuspended()(Code)
Suspended flag accessor.



recycle
public void recycle()(Code)
Release all object references, and initialize instance variables, in preparation for reuse of this object.



reset
public void reset()(Code)
Clear any content written to the buffer.
exception:
  IllegalStateException - if this response has alreadybeen committed



resetBuffer
public void resetBuffer()(Code)
Reset the data buffer but not any status or header information.
exception:
  IllegalStateException - if the response has alreadybeen committed



setAppCommitted
public void setAppCommitted(boolean appCommitted)(Code)
Set the application commit flag.



setBufferSize
public void setBufferSize(int size)(Code)
Set the buffer size to be used for this Response.
Parameters:
  size - The new buffer size
exception:
  IllegalStateException - if this method is called afteroutput has been committed for this response



setConnector
public void setConnector(Connector connector)(Code)
Set the Connector through which this Response will be transmitted.
Parameters:
  connector - The new connector



setContentLength
public void setContentLength(int length)(Code)
Set the content length (in bytes) for this Response.
Parameters:
  length - The new content length



setContentType
public void setContentType(String type)(Code)
Set the content type for this Response.
Parameters:
  type - The new content type



setContext
public void setContext(Context context)(Code)
Set the Context with which this Response is associated. This should be called as soon as the appropriate Context is identified.
Parameters:
  context - The associated Context



setError
public void setError()(Code)
Set the error flag.



setIncluded
public void setIncluded(boolean included)(Code)
Set the "processing inside an include" flag.
Parameters:
  included - true if we are currently inside aRequestDispatcher.include(), else false



setLocale
public void setLocale(Locale locale)(Code)
Set the Locale that is appropriate for this response, including setting the appropriate character encoding.
Parameters:
  locale - The new locale



setRequest
public void setRequest(Request request)(Code)
Set the Request with which this Response is associated.
Parameters:
  request - The new associated request



setStream
public void setStream(OutputStream stream)(Code)
Set the output stream associated with this Response.
Parameters:
  stream - The new output stream



setSuspended
public void setSuspended(boolean suspended)(Code)
Set the suspended flag.



write
public void write(int b) throws IOException(Code)
Write the specified byte to our output stream, flushing if necessary.
Parameters:
  b - The byte to be written
exception:
  IOException - if an input/output error occurs



write
public void write(byte b) throws IOException(Code)
Write b.length bytes from the specified byte array to our output stream. Flush the output stream as necessary.
Parameters:
  b - The byte array to be written
exception:
  IOException - if an input/output error occurs



write
public void write(byte b, int off, int len) throws IOException(Code)
Write len bytes from the specified byte array, starting at the specified offset, to our output stream. Flush the output stream as necessary.
Parameters:
  b - The byte array containing the bytes to be written
Parameters:
  off - Zero-relative starting offset of the bytes to be written
Parameters:
  len - The number of bytes to be written
exception:
  IOException - if an input/output 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.