Java Doc for Request.java in  » Sevlet-Container » tomcat-catalina » org » apache » catalina » 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.catalina 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.catalina.Request

Request
public interface Request (Code)
A Request is the Catalina-internal facade for a ServletRequest that is to be processed, in order to produce the corresponding Response.
author:
   Craig R. McClanahan
version:
   $Revision: 1.7 $ $Date: 2004/02/27 14:58:39 $




Method Summary
public  ServletInputStreamcreateInputStream()
     Create and return a ServletInputStream to read the content associated with this Request.
public  voidfinishRequest()
     Perform whatever actions are required to flush and close the input stream or reader, in a single operation.
public  StringgetAuthorization()
     Return the authorization credentials sent with this request.
public  ConnectorgetConnector()
     Return the Connector through which this Request was received.
public  ContextgetContext()
     Return the Context within which this Request is being processed.
public  FilterChaingetFilterChain()
     Get filter chain associated with the request.
public  HostgetHost()
     Return the Host within which this Request is being processed.
public  StringgetInfo()
     Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>.
public  ObjectgetNote(String name)
     Return the object bound with the specified name to the internal notes for this request, or null if no such binding exists.
public  IteratorgetNoteNames()
     Return an Iterator containing the String names of all notes bindings that exist for this request.
public  ServletRequestgetRequest()
     Return the ServletRequest for which this object is the facade.
public  ResponsegetResponse()
     Return the Response with which this Request is associated.
public  SocketgetSocket()
     Return the Socket (if any) through which this Request was received.
public  InputStreamgetStream()
     Return the input stream associated with this Request.
public  ValveContextgetValveContext()
     Get valve context.
public  WrappergetWrapper()
     Return the Wrapper within which this Request is being processed.
public  voidrecycle()
     Release all object references, and initialize instance variables, in preparation for reuse of this object.
public  voidremoveNote(String name)
     Remove any object bound to the specified name in the internal notes for this request.
public  voidsetAuthorization(String authorization)
     Set the authorization credentials sent with this request.
public  voidsetConnector(Connector connector)
     Set the Connector through which this Request was received.
public  voidsetContentLength(int length)
     Set the content length associated with this Request.
public  voidsetContentType(String type)
     Set the content type (and optionally the character encoding) associated with this Request.
public  voidsetContext(Context context)
     Set the Context within which this Request is being processed.
public  voidsetFilterChain(FilterChain filterChain)
     Set filter chain associated with the request.
public  voidsetHost(Host host)
     Set the Host within which this Request is being processed.
public  voidsetNote(String name, Object value)
     Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.
public  voidsetProtocol(String protocol)
     Set the protocol name and version associated with this Request.
public  voidsetRemoteAddr(String remote)
     Set the remote IP address associated with this Request.
public  voidsetResponse(Response response)
     Set the Response with which this Request is associated.
public  voidsetScheme(String scheme)
     Set the name of the scheme associated with this request.
public  voidsetSecure(boolean secure)
     Set the value to be returned by isSecure() for this Request.
public  voidsetServerName(String name)
     Set the name of the server (virtual host) to process this request.
public  voidsetServerPort(int port)
     Set the port number of the server to process this request.
public  voidsetSocket(Socket socket)
     Set the Socket (if any) through which this Request was received.
public  voidsetStream(InputStream stream)
     Set the input stream associated with this Request.
public  voidsetValveContext(ValveContext valveContext)
     Set valve context.
public  voidsetWrapper(Wrapper wrapper)
     Set the Wrapper within which this Request is being processed.



Method Detail
createInputStream
public ServletInputStream createInputStream() throws IOException(Code)
Create and return a ServletInputStream to read the content associated with this Request.
exception:
  IOException - if an input/output error occurs



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



getAuthorization
public String getAuthorization()(Code)
Return the authorization credentials sent with this request.



getConnector
public Connector getConnector()(Code)
Return the Connector through which this Request was received.



getContext
public Context getContext()(Code)
Return the Context within which this Request is being processed.



getFilterChain
public FilterChain getFilterChain()(Code)
Get filter chain associated with the request.



getHost
public Host getHost()(Code)
Return the Host within which this Request is being processed.



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



getNote
public Object getNote(String name)(Code)
Return the object bound with the specified name to the internal notes for this request, or null if no such binding exists.
Parameters:
  name - Name of the note to be returned



getNoteNames
public Iterator getNoteNames()(Code)
Return an Iterator containing the String names of all notes bindings that exist for this request.



getRequest
public ServletRequest getRequest()(Code)
Return the ServletRequest for which this object is the facade.



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



getSocket
public Socket getSocket()(Code)
Return the Socket (if any) through which this Request was received. This should only be used to access underlying state information about this Socket, such as the SSLSession associated with an SSLSocket.



getStream
public InputStream getStream()(Code)
Return the input stream associated with this Request.



getValveContext
public ValveContext getValveContext()(Code)
Get valve context.



getWrapper
public Wrapper getWrapper()(Code)
Return the Wrapper within which this Request is being processed.



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



removeNote
public void removeNote(String name)(Code)
Remove any object bound to the specified name in the internal notes for this request.
Parameters:
  name - Name of the note to be removed



setAuthorization
public void setAuthorization(String authorization)(Code)
Set the authorization credentials sent with this request.
Parameters:
  authorization - The new authorization credentials



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 associated with this Request.
Parameters:
  length - The new content length



setContentType
public void setContentType(String type)(Code)
Set the content type (and optionally the character encoding) associated with this Request. For example, text/html; charset=ISO-8859-4.
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



setFilterChain
public void setFilterChain(FilterChain filterChain)(Code)
Set filter chain associated with the request.
Parameters:
  filterChain - new filter chain



setHost
public void setHost(Host host)(Code)
Set the Host within which this Request is being processed. This must be called as soon as the appropriate Host is identified, and before the Request is passed to a context.
Parameters:
  host - The newly associated Host



setNote
public void setNote(String name, Object value)(Code)
Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.
Parameters:
  name - Name to which the object should be bound
Parameters:
  value - Object to be bound to the specified name



setProtocol
public void setProtocol(String protocol)(Code)
Set the protocol name and version associated with this Request.
Parameters:
  protocol - Protocol name and version



setRemoteAddr
public void setRemoteAddr(String remote)(Code)
Set the remote IP address associated with this Request. NOTE: This value will be used to resolve the value for getRemoteHost() if that method is called.
Parameters:
  remote - The remote IP address



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



setScheme
public void setScheme(String scheme)(Code)
Set the name of the scheme associated with this request. Typical values are http, https, and ftp.
Parameters:
  scheme - The scheme



setSecure
public void setSecure(boolean secure)(Code)
Set the value to be returned by isSecure() for this Request.
Parameters:
  secure - The new isSecure value



setServerName
public void setServerName(String name)(Code)
Set the name of the server (virtual host) to process this request.
Parameters:
  name - The server name



setServerPort
public void setServerPort(int port)(Code)
Set the port number of the server to process this request.
Parameters:
  port - The server port



setSocket
public void setSocket(Socket socket)(Code)
Set the Socket (if any) through which this Request was received.
Parameters:
  socket - The socket through which this request was received



setStream
public void setStream(InputStream stream)(Code)
Set the input stream associated with this Request.
Parameters:
  stream - The new input stream



setValveContext
public void setValveContext(ValveContext valveContext)(Code)
Set valve context.
Parameters:
  valveContext - New valve context object



setWrapper
public void setWrapper(Wrapper wrapper)(Code)
Set the Wrapper within which this Request is being processed. This must be called as soon as the appropriate Wrapper is identified, and before the Request is ultimately passed to an application servlet.
Parameters:
  wrapper - The newly associated Wrapper



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