Java Doc for RequestBase.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.RequestBase All known Subclasses:   org.apache.catalina.connector.HttpRequestBase, RequestBase abstract public class RequestBase implements ServletRequest,Request(Code) Convenience base implementation of the Request interface, which can be used for the Request implementation required by most Connectors. Only the connector-specific methods need to be implemented. author:    Craig R. McClanahan version:    $Revision: 1.20 $ $Date: 2002/05/27 13:34:34 $ Field Summary protected  HashMap attributes      The attributes associated with this Request, keyed by attribute name. protected  String authorization      The authorization credentials sent with this Request. protected  String characterEncoding      The character encoding for this Request. protected  Connector connector      The Connector through which this Request was received. protected  int contentLength      The content length associated with this request. protected  String contentType      The content type associated with this request. protected  Context context      The Context within which this Request is being processed. protected static  Locale defaultLocale      The default Locale if none are specified. protected  RequestFacade facade      The facade associated with this request. final protected static  String info      Descriptive information about this Request implementation. protected  InputStream input      The input stream associated with this Request. protected  ArrayList locales      The preferred Locales assocaited with this Request. protected  String protocol      The protocol name and version associated with this Request. protected  BufferedReader reader      The reader that has been returned by getReader, if any. protected  String remoteAddr      The remote address associated with this request. protected  String remoteHost      The fully qualified name of the remote host. protected  Response response      The response with which this request is associated. protected  String scheme      The scheme associated with this Request. protected  boolean secure      protected  String serverName      The server name associated with this Request. protected  int serverPort      The server port associated with this Request. protected static  StringManager sm      The string manager for this package. protected  Socket socket      The socket through which this Request was received. protected  ServletInputStream stream      The ServletInputStream that has been returned by getInputStream(), if any. protected  Wrapper wrapper      The Wrapper within which this Request is being processed. Method Summary public  void addLocale(Locale locale)      Add a Locale to the set of preferred Locales for this Request. public  ServletInputStream createInputStream()      Create and return a ServletInputStream to read the content associated with this Request. public  void finishRequest()      Perform whatever actions are required to flush and close the input stream or reader, in a single operation. public  Object getAttribute(String name)      Return the specified request attribute if it exists; otherwise, return null. public  Enumeration getAttributeNames()      Return the names of all request attributes for this Request, or an empty Enumeration if there are none. public  String getAuthorization()      Return the authorization credentials sent with this request. public  String getCharacterEncoding()      Return the character encoding for this Request. public  Connector getConnector()      Return the Connector through which this Request was received. public  int getContentLength()      Return the content length for this Request. public  String getContentType()      Return the content type for this Request. public  Context getContext()      Return the Context within which this Request is being processed. public  String getInfo()      Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>. public  ServletInputStream getInputStream()      Return the servlet input stream for this Request. public  Locale getLocale()      Return the preferred Locale that the client will accept content in, based on the value for the first Accept-Language header that was encountered. public  Enumeration getLocales()      Return the set of preferred Locales that the client will accept content in, based on the values for any Accept-Language headers that were encountered. public  Object getNote(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  Iterator getNoteNames()      Return an Iterator containing the String names of all notes bindings that exist for this request. abstract public  String getParameter(String name)      Return the value of the specified request parameter, if any; otherwise, return null. abstract public  Map getParameterMap()      Returns a Map of the parameters of this request. abstract public  Enumeration getParameterNames()      Return the names of all defined request parameters for this request. abstract public  String[] getParameterValues(String name)      Return the defined values for the specified request parameter, if any; otherwise, return null. public  String getProtocol()      Return the protocol and version used to make this Request. public  BufferedReader getReader()      Read the Reader wrapping the input stream for this Request. public  String getRealPath(String path)      Return the real path of the specified virtual path. public  String getRemoteAddr()      Return the remote IP address making this Request. public  String getRemoteHost()      Return the remote host name making this Request. public  ServletRequest getRequest()      Return the ServletRequest for which this object is the facade. abstract public  RequestDispatcher getRequestDispatcher(String path)      Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path. public  Response getResponse()      Return the Response with which this Request is associated. public  String getScheme()      Return the scheme used to make this Request. public  String getServerName()      Return the server name responding to this Request. public  int getServerPort()      Return the server port responding to this Request. public  Socket getSocket()      Return the Socket (if any) through which this Request was received. public  InputStream getStream()      Return the input stream associated with this Request. public  Wrapper getWrapper()      Return the Wrapper within which this Request is being processed. public  boolean isSecure()      public  void recycle()      Release all object references, and initialize instance variables, in preparation for reuse of this object. public  void removeAttribute(String name)      Remove the specified request attribute if it exists. public  void removeNote(String name)      Remove any object bound to the specified name in the internal notes for this request. public  void setAttribute(String name, Object value)      Set the specified request attribute to the specified value. public  void setAuthorization(String authorization)      Set the authorization credentials sent with this request. public  void setCharacterEncoding(String enc)      Overrides the name of the character encoding used in the body of this request. public  void setConnector(Connector connector)      Set the Connector through which this Request was received. public  void setContentLength(int length)      Set the content length associated with this Request. public  void setContentType(String type)      Set the content type (and optionally the character encoding) associated with this Request. public  void setContext(Context context)      Set the Context within which this Request is being processed. public  void setNote(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  void setProtocol(String protocol)      Set the protocol name and version associated with this Request. public  void setRemoteAddr(String remoteAddr)      Set the IP address of the remote client associated with this Request. public  void setRemoteHost(String remoteHost)      Set the fully qualified name of the remote client associated with this Request. public  void setResponse(Response response)      Set the Response with which this Request is associated. public  void setScheme(String scheme)      Set the name of the scheme associated with this request. public  void setSecure(boolean secure)      Set the value to be returned by isSecure() for this Request. public  void setServerName(String name)      Set the name of the server (virtual host) to process this request. public  void setServerPort(int port)      Set the port number of the server to process this request. public  void setSocket(Socket socket)      Set the Socket (if any) through which this Request was received. public  void setStream(InputStream input)      Set the input stream associated with this Request. public  void setWrapper(Wrapper wrapper)      Set the Wrapper within which this Request is being processed. Field Detail attributes protected HashMap attributes(Code) The attributes associated with this Request, keyed by attribute name. authorization protected String authorization(Code) The authorization credentials sent with this Request. characterEncoding protected String characterEncoding(Code) The character encoding for this Request. connector protected Connector connector(Code) The Connector through which this Request was received. contentLength protected int contentLength(Code) The content length associated with this request. contentType protected String contentType(Code) The content type associated with this request. context protected Context context(Code) The Context within which this Request is being processed. defaultLocale protected static Locale defaultLocale(Code) The default Locale if none are specified. facade protected RequestFacade facade(Code) The facade associated with this request. info final protected static String info(Code) Descriptive information about this Request implementation. input protected InputStream input(Code) The input stream associated with this Request. locales protected ArrayList locales(Code) The preferred Locales assocaited with this Request. protocol protected String protocol(Code) The protocol name and version associated with this Request. reader protected BufferedReader reader(Code) The reader that has been returned by getReader, if any. remoteAddr protected String remoteAddr(Code) The remote address associated with this request. remoteHost protected String remoteHost(Code) The fully qualified name of the remote host. response protected Response response(Code) The response with which this request is associated. scheme protected String scheme(Code) The scheme associated with this Request. secure protected boolean secure(Code) Was this request received on a secure connection? serverName protected String serverName(Code) The server name associated with this Request. serverPort protected int serverPort(Code) The server port associated with this Request. sm protected static StringManager sm(Code) The string manager for this package. socket protected Socket socket(Code) The socket through which this Request was received. stream protected ServletInputStream stream(Code) The ServletInputStream that has been returned by getInputStream(), if any. wrapper protected Wrapper wrapper(Code) The Wrapper within which this Request is being processed. Method Detail addLocale public void addLocale(Locale locale)(Code) Add a Locale to the set of preferred Locales for this Request. The first added Locale will be the first one returned by getLocales(). Parameters:   locale - The new preferred Locale createInputStream public ServletInputStream createInputStream() throws IOException(Code) Create and return a ServletInputStream to read the content associated with this Request. The default implementation creates an instance of RequestStream associated with this request, but this can be overridden if necessary. 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 getAttribute public Object getAttribute(String name)(Code) Return the specified request attribute if it exists; otherwise, return null. Parameters:   name - Name of the request attribute to return getAttributeNames public Enumeration getAttributeNames()(Code) Return the names of all request attributes for this Request, or an empty Enumeration if there are none. getAuthorization public String getAuthorization()(Code) Return the authorization credentials sent with this request. getCharacterEncoding public String getCharacterEncoding()(Code) Return the character encoding for this Request. getConnector public Connector getConnector()(Code) Return the Connector through which this Request was received. getContentLength public int getContentLength()(Code) Return the content length for this Request. getContentType public String getContentType()(Code) Return the content type for this Request. getContext public Context getContext()(Code) Return the Context 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>. getInputStream public ServletInputStream getInputStream() throws IOException(Code) Return the servlet input stream for this Request. The default implementation returns a servlet input stream created by createInputStream(). exception:   IllegalStateException - if getReader() hasalready been called for this request exception:   IOException - if an input/output error occurs getLocale public Locale getLocale()(Code) Return the preferred Locale that the client will accept content in, based on the value for the first Accept-Language header that was encountered. If the request did not specify a preferred language, the server's default Locale is returned. getLocales public Enumeration getLocales()(Code) Return the set of preferred Locales that the client will accept content in, based on the values for any Accept-Language headers that were encountered. If the request did not specify a preferred language, the server's default Locale is returned. 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. getParameter abstract public String getParameter(String name)(Code) Return the value of the specified request parameter, if any; otherwise, return null. If there is more than one value defined, return only the first one. Parameters:   name - Name of the desired request parameter getParameterMap abstract public Map getParameterMap()(Code) Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data. A Map containing parameter names as keysand parameter values as map values. getParameterNames abstract public Enumeration getParameterNames()(Code) Return the names of all defined request parameters for this request. getParameterValues abstract public String[] getParameterValues(String name)(Code) Return the defined values for the specified request parameter, if any; otherwise, return null. Parameters:   name - Name of the desired request parameter getProtocol public String getProtocol()(Code) Return the protocol and version used to make this Request. getReader public BufferedReader getReader() throws IOException(Code) Read the Reader wrapping the input stream for this Request. The default implementation wraps a BufferedReader around the servlet input stream returned by createInputStream(). exception:   IllegalStateException - if getInputStream()has already been called for this request exception:   IOException - if an input/output error occurs getRealPath public String getRealPath(String path)(Code) Return the real path of the specified virtual path. Parameters:   path - Path to be translated getRemoteAddr public String getRemoteAddr()(Code) Return the remote IP address making this Request. getRemoteHost public String getRemoteHost()(Code) Return the remote host name making this Request. getRequest public ServletRequest getRequest()(Code) Return the ServletRequest for which this object is the facade. This method must be implemented by a subclass. getRequestDispatcher abstract public RequestDispatcher getRequestDispatcher(String path)(Code) Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path. Parameters:   path - Path of the resource to be wrapped getResponse public Response getResponse()(Code) Return the Response with which this Request is associated. getScheme public String getScheme()(Code) Return the scheme used to make this Request. getServerName public String getServerName()(Code) Return the server name responding to this Request. getServerPort public int getServerPort()(Code) Return the server port responding to this Request. 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. getWrapper public Wrapper getWrapper()(Code) Return the Wrapper within which this Request is being processed. isSecure public boolean isSecure()(Code) Was this request received on a secure connection? recycle public void recycle()(Code) Release all object references, and initialize instance variables, in preparation for reuse of this object. removeAttribute public void removeAttribute(String name)(Code) Remove the specified request attribute if it exists. Parameters:   name - Name of the request attribute to remove 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 setAttribute public void setAttribute(String name, Object value)(Code) Set the specified request attribute to the specified value. Parameters:   name - Name of the request attribute to set Parameters:   value - The associated value setAuthorization public void setAuthorization(String authorization)(Code) Set the authorization credentials sent with this request. Parameters:   authorization - The new authorization credentials setCharacterEncoding public void setCharacterEncoding(String enc) throws UnsupportedEncodingException(Code) Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader(). Parameters:   enc - The character encoding to be used exception:   UnsupportedEncodingException - if the specified encodingis not supported since:    Servlet 2.3 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 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 remoteAddr)(Code) Set the IP address of the remote client associated with this Request. Parameters:   remoteAddr - The remote IP address setRemoteHost public void setRemoteHost(String remoteHost)(Code) Set the fully qualified name of the remote client associated with this Request. Parameters:   remoteHost - The remote host name 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 input)(Code) Set the input stream associated with this Request. Parameters:   input - The new input stream 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 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)