Java Doc for CoyoteResponse.java in  » Sevlet-Container » tomcat-catalina » org » apache » coyote » tomcat5 » 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 » Sevlet Container » tomcat catalina » org.apache.coyote.tomcat5   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.apache.coyote.tomcat5.CoyoteResponse CoyoteResponse public class CoyoteResponse implements HttpResponse,HttpServletResponse(Code) Wrapper object for the Coyote response. author:    Remy Maucherat author:    Craig R. McClanahan version:    $Revision: 1.18.2.1 $ $Date: 2004/08/23 19:22:20 $ Field Summary protected  boolean appCommitted      The application commit flag. protected  Connector connector      Associated Catalina connector. protected  ArrayList cookies      The set of Cookies associated with this Response. protected  Response coyoteResponse      Coyote response. protected  boolean error      The error flag. protected  CoyoteResponseFacade facade      The facade associated with this response. protected  SimpleDateFormat format      The date format we will use for creating date headers. protected  boolean included      The included flag. final protected static  String info      Descriptive information about this Response implementation. protected  OutputBuffer outputBuffer      The associated output buffer. protected  CoyoteOutputStream outputStream      The associated output stream. protected  CharChunk redirectURLCC      Recyclable buffer to hold the redirect URL. protected  CoyoteRequest request      The request with which this response is associated. protected static  StringManager sm      The string manager for this package. protected  UEncoder urlEncoder      URL encoder. protected  boolean usingOutputStream      Using output stream flag. protected  boolean usingWriter      Using writer flag. protected  CoyoteWriter writer      The associated writer. Constructor Summary public   CoyoteResponse()      Method Summary public  void addCookie(Cookie cookie)      Add the specified Cookie to those that will be included with this Response. public  void addDateHeader(String name, long value)      Add the specified date header to the specified value. public  void addHeader(String name, String value)      Add the specified header to the specified value. public  void addIntHeader(String name, int value)      Add the specified integer header to the specified value. public  boolean containsHeader(String name)      public  ServletOutputStream createOutputStream()      Create and return a ServletOutputStream to write the content associated with this Response. public  String encodeRedirectURL(String url)      Encode the session identifier associated with this response into the specified redirect URL, if necessary. public  String encodeRedirectUrl(String url)      Encode the session identifier associated with this response into the specified redirect URL, if necessary. public  String encodeURL(String url)      Encode the session identifier associated with this response into the specified URL, if necessary. public  String encodeUrl(String url)      Encode the session identifier associated with this response into the specified URL, if necessary. public  void finishResponse()      Perform whatever actions are required to flush and close the output stream or writer, in a single operation. public  void flushBuffer()      Flush the buffer and commit this response. public  int getBufferSize()      Return the actual buffer size used for this Response. public  String getCharacterEncoding()      Return the character encoding used for this Response. public  Connector getConnector()      Return the Connector through which this Request was received. public  int getContentCount()      Return the number of bytes actually written to the output stream. public  int getContentLength()      Return the content length that was set or calculated for this Response. public  String getContentType()      Return the content type that was set or calculated for this response, or null if no content type was set. public  Context getContext()      Return the Context within which this Request is being processed. public  Cookie[] getCookies()      Return an array of all cookies set for this response, or a zero-length array if no cookies have been set. public  Response getCoyoteResponse()      Get the Coyote response. public  String getHeader(String name)      Return the value for the specified header, or null if this header has not been set. public  String[] getHeaderNames()      Return an array of all the header names set for this response, or a zero-length array if no headers have been set. public  String[] getHeaderValues(String name)      Return an array of all the header values associated with the specified header name, or an zero-length array if there are no such header values. public  boolean getIncluded()      Return the "processing inside an include" flag. public  String getInfo()      Return descriptive information about this Response implementation and the corresponding version number, in the format <description>/<version>. public  Locale getLocale()      Return the Locale assigned to this response. public  String getMessage()      Return the error message that was set with sendError() for this Response. public  ServletOutputStream getOutputStream()      Return the servlet output stream associated with this Response. public  PrintWriter getReporter()      Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired. Writer which can be used for error reports. public  org.apache.catalina.Request getRequest()      Return the Request with which this Response is associated. public  ServletResponse getResponse()      Return the ServletResponse for which this object is the facade. public  int getStatus()      Return the HTTP status code associated with this Response. public  OutputStream getStream()      Return the output stream associated with this Response. public  PrintWriter getWriter()      Return the writer associated with this Response. public  boolean isAppCommitted()      Application commit flag accessor. public  boolean isCommitted()      protected  boolean isEncodeable(String location)      Return true if the specified URL should be encoded with a session identifier. public  boolean isError()      Error flag accessor. public  boolean isSuspended()      Suspended flag accessor. public  void recycle()      Release all object references, and initialize instance variables, in preparation for reuse of this object. public  void reset()      Clear any content written to the buffer. public  void reset(int status, String message)      Reset this response, and specify the values for the HTTP status code and corresponding message. public  void resetBuffer()      Reset the data buffer but not any status or header information. public  void sendAcknowledgement()      Send an acknowledgment of a request. public  void sendError(int status)      Send an error response with the specified status and a default message. public  void sendError(int status, String message)      Send an error response with the specified status and message. public  void sendRedirect(String location)      Send a temporary redirect to the specified redirect location URL. public  void setAppCommitted(boolean appCommitted)      Set the application commit flag. public  void setBufferSize(int size)      Set the buffer size to be used for this Response. public  void setCharacterEncoding(String charset)      public  void setConnector(Connector connector)      Set the Connector through which this Request was received. public  void setContentLength(int length)      Set the content length (in bytes) for this Response. public  void setContentType(String type)      Set the content type for this Response. public  void setContext(Context context)      Set the Context within which this Request is being processed. public  void setCoyoteResponse(Response coyoteResponse)      Set the Coyote response. public  void setDateHeader(String name, long value)      Set the specified date header to the specified value. public  void setError()      Set the error flag. public  void setHeader(String name, String value)      Set the specified header to the specified value. public  void setIncluded(boolean included)      Set the "processing inside an include" flag. public  void setIntHeader(String name, int value)      Set the specified integer header to the specified value. public  void setLocale(Locale locale)      Set the Locale that is appropriate for this response, including setting the appropriate character encoding. public  void setRequest(org.apache.catalina.Request request)      Set the Request with which this Response is associated. public  void setStatus(int status)      Set the HTTP status to be returned with this response. public  void setStatus(int status, String message)      Set the HTTP status and message to be returned with this response. public  void setStream(OutputStream stream)      Set the output stream associated with this Response. public  void setSuspended(boolean suspended)      Set the suspended flag. Field Detail appCommitted protected boolean appCommitted(Code) The application commit flag. connector protected Connector connector(Code) Associated Catalina connector. cookies protected ArrayList cookies(Code) The set of Cookies associated with this Response. coyoteResponse protected Response coyoteResponse(Code) Coyote response. error protected boolean error(Code) The error flag. facade protected CoyoteResponseFacade facade(Code) The facade associated with this response. format protected SimpleDateFormat format(Code) The date format we will use for creating date headers. included protected boolean included(Code) The included flag. info final protected static String info(Code) Descriptive information about this Response implementation. outputBuffer protected OutputBuffer outputBuffer(Code) The associated output buffer. outputStream protected CoyoteOutputStream outputStream(Code) The associated output stream. redirectURLCC protected CharChunk redirectURLCC(Code) Recyclable buffer to hold the redirect URL. request protected CoyoteRequest request(Code) The request with which this response is associated. sm protected static StringManager sm(Code) The string manager for this package. urlEncoder protected UEncoder urlEncoder(Code) URL encoder. usingOutputStream protected boolean usingOutputStream(Code) Using output stream flag. usingWriter protected boolean usingWriter(Code) Using writer flag. writer protected CoyoteWriter writer(Code) The associated writer. Constructor Detail CoyoteResponse public CoyoteResponse()(Code) Method Detail addCookie public void addCookie(Cookie cookie)(Code) Add the specified Cookie to those that will be included with this Response. Parameters:   cookie - Cookie to be added addDateHeader public void addDateHeader(String name, long value)(Code) Add the specified date header to the specified value. Parameters:   name - Name of the header to set Parameters:   value - Date value to be set addHeader public void addHeader(String name, String value)(Code) Add the specified header to the specified value. Parameters:   name - Name of the header to set Parameters:   value - Value to be set addIntHeader public void addIntHeader(String name, int value)(Code) Add the specified integer header to the specified value. Parameters:   name - Name of the header to set Parameters:   value - Integer value to be set containsHeader public boolean containsHeader(String name)(Code) Has the specified header been set already in this response? Parameters:   name - Name of the header to check 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 encodeRedirectURL public String encodeRedirectURL(String url)(Code) Encode the session identifier associated with this response into the specified redirect URL, if necessary. Parameters:   url - URL to be encoded encodeRedirectUrl public String encodeRedirectUrl(String url)(Code) Encode the session identifier associated with this response into the specified redirect URL, if necessary. Parameters:   url - URL to be encoded encodeURL public String encodeURL(String url)(Code) Encode the session identifier associated with this response into the specified URL, if necessary. Parameters:   url - URL to be encoded encodeUrl public String encodeUrl(String url)(Code) Encode the session identifier associated with this response into the specified URL, if necessary. Parameters:   url - URL to be encoded 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 Request was received. 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 within which this Request is being processed. getCookies public Cookie[] getCookies()(Code) Return an array of all cookies set for this response, or a zero-length array if no cookies have been set. getCoyoteResponse public Response getCoyoteResponse()(Code) Get the Coyote response. getHeader public String getHeader(String name)(Code) Return the value for the specified header, or null if this header has not been set. If more than one value was added for this name, only the first is returned; use getHeaderValues() to retrieve all of them. Parameters:   name - Header name to look up getHeaderNames public String[] getHeaderNames()(Code) Return an array of all the header names set for this response, or a zero-length array if no headers have been set. getHeaderValues public String[] getHeaderValues(String name)(Code) Return an array of all the header values associated with the specified header name, or an zero-length array if there are no such header values. Parameters:   name - Header name to look up 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. getMessage public String getMessage()(Code) Return the error message that was set with sendError() for 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() throws IOException(Code) Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired. Writer which can be used for error reports. If the response isnot an error report returned using sendError or triggered by anunexpected exception thrown during the servlet processing(and only in that case), null will be returned if the response streamhas already been used. exception:   IOException - if an input/output error occurs getRequest public org.apache.catalina.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. getStatus public int getStatus()(Code) Return the HTTP status code associated with this Response. 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? isEncodeable protected boolean isEncodeable(String location)(Code) Return true if the specified URL should be encoded with a session identifier. This will be true if all of the following conditions are met: The request we are responding to asked for a valid session The requested session ID was not received via a cookie The specified URL points back to somewhere within the web application that is responding to this request Parameters:   location - Absolute URL to be validated 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 reset public void reset(int status, String message)(Code) Reset this response, and specify the values for the HTTP status code and corresponding message. exception:   IllegalStateException - if this response has already beencommitted resetBuffer public void resetBuffer()(Code) Reset the data buffer but not any status or header information. exception:   IllegalStateException - if the response has alreadybeen committed sendAcknowledgement public void sendAcknowledgement() throws IOException(Code) Send an acknowledgment of a request. exception:   IOException - if an input/output error occurs sendError public void sendError(int status) throws IOException(Code) Send an error response with the specified status and a default message. Parameters:   status - HTTP status code to send exception:   IllegalStateException - if this response hasalready been committed exception:   IOException - if an input/output error occurs sendError public void sendError(int status, String message) throws IOException(Code) Send an error response with the specified status and message. Parameters:   status - HTTP status code to send Parameters:   message - Corresponding message to send exception:   IllegalStateException - if this response hasalready been committed exception:   IOException - if an input/output error occurs sendRedirect public void sendRedirect(String location) throws IOException(Code) Send a temporary redirect to the specified redirect location URL. Parameters:   location - Location URL to redirect to exception:   IllegalStateException - if this response hasalready been committed exception:   IOException - if an input/output error occurs setAppCommitted public void setAppCommitted(boolean appCommitted)(Code) Set the application commit flag. Parameters:   appCommitted - The new application committed flag value 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 setCharacterEncoding public void setCharacterEncoding(String charset)(Code) setConnector public void setConnector(Connector connector)(Code) Set the Connector through which this Request was received. 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 within which this Request is being processed. This must be called as soon as the appropriate Context is identified, because it identifies the value to be returned by getContextPath(), and thus enables parsing of the request URI. Parameters:   context - The newly associated Context setCoyoteResponse public void setCoyoteResponse(Response coyoteResponse)(Code) Set the Coyote response. Parameters:   response - The Coyote response setDateHeader public void setDateHeader(String name, long value)(Code) Set the specified date header to the specified value. Parameters:   name - Name of the header to set Parameters:   value - Date value to be set setError public void setError()(Code) Set the error flag. setHeader public void setHeader(String name, String value)(Code) Set the specified header to the specified value. Parameters:   name - Name of the header to set Parameters:   value - Value to be set 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 setIntHeader public void setIntHeader(String name, int value)(Code) Set the specified integer header to the specified value. Parameters:   name - Name of the header to set Parameters:   value - Integer value to be set 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(org.apache.catalina.Request request)(Code) Set the Request with which this Response is associated. Parameters:   request - The new associated request setStatus public void setStatus(int status)(Code) Set the HTTP status to be returned with this response. Parameters:   status - The new HTTP status setStatus public void setStatus(int status, String message)(Code) Set the HTTP status and message to be returned with this response. Parameters:   status - The new HTTP status Parameters:   message - The associated text message 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. Parameters:   suspended - The new suspended flag value 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)