org.apache.openejb.server.httpd
Interface HttpRequest

All Superinterfaces:
Serializable
All Known Implementing Classes:
HttpRequestImpl, ServletRequestAdapter

public interface HttpRequest
extends Serializable

An interface to take care of HTTP Requests. It parses headers, content, form and url parameters.


Nested Class Summary
static class HttpRequest.Method
          Request methods
 
Field Summary
static String HEADER_ACCEPT
          the Accept header
static String HEADER_ACCEPT_ENCODING
          the Accept-Encoding header
static String HEADER_ACCEPT_LANGUAGE
          the Accept-Language header
static String HEADER_CACHE_CONTROL
          the Cache-Control header
static String HEADER_CONNECTION
          the Connection header
static String HEADER_CONTENT_LENGTH
          the Content-Length header
static String HEADER_CONTENT_TYPE
          the Content-Type header
static String HEADER_COOKIE
          the Cookie header
static String HEADER_HOST
          the Host header
static String HEADER_SET_COOKIE
          the Set-Cookie header
static String HEADER_USER_AGENT
          the User-Agent header
static String SERVLET_CONTEXT
          If the https server implementation is based on Servlets, the real ServletContext will be registered in the request attributes using this name.
static String SERVLET_REQUEST
          If the https server implementation is based on Servlets, the real HttpServletRequest will be registered in the request attributes using this name.
static String SERVLET_RESPONSE
          If the https server implementation is based on Servlets, the real HttpServletResponse will be registered in the request attributes using this name.
 
Method Summary
 Object getAttribute(String name)
           
 int getContentLength()
           
 String getContentType()
           
 String getHeader(String name)
          Gets a header based the header name passed in.
 InputStream getInputStream()
           
 HttpRequest.Method getMethod()
          Gets an integer value of the request method.
 String getParameter(String name)
          Gets a form or URL query parameter based on the name passed in.
 Map getParameters()
          Gets all the form and URL query parameters
 String getRemoteAddr()
           
 HttpSession getSession()
          Returns the current session associated with this request, or if the request does not have a session, creates one.
 HttpSession getSession(boolean create)
          Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.
 URI getURI()
          Gets the URI for the current URL page.
 void setAttribute(String name, Object value)
           
 

Field Detail

HEADER_ACCEPT

static final String HEADER_ACCEPT
the Accept header

See Also:
Constant Field Values

HEADER_ACCEPT_ENCODING

static final String HEADER_ACCEPT_ENCODING
the Accept-Encoding header

See Also:
Constant Field Values

HEADER_ACCEPT_LANGUAGE

static final String HEADER_ACCEPT_LANGUAGE
the Accept-Language header

See Also:
Constant Field Values

HEADER_CONTENT_TYPE

static final String HEADER_CONTENT_TYPE
the Content-Type header

See Also:
Constant Field Values

HEADER_CONTENT_LENGTH

static final String HEADER_CONTENT_LENGTH
the Content-Length header

See Also:
Constant Field Values

HEADER_CONNECTION

static final String HEADER_CONNECTION
the Connection header

See Also:
Constant Field Values

HEADER_CACHE_CONTROL

static final String HEADER_CACHE_CONTROL
the Cache-Control header

See Also:
Constant Field Values

HEADER_HOST

static final String HEADER_HOST
the Host header

See Also:
Constant Field Values

HEADER_USER_AGENT

static final String HEADER_USER_AGENT
the User-Agent header

See Also:
Constant Field Values

HEADER_SET_COOKIE

static final String HEADER_SET_COOKIE
the Set-Cookie header

See Also:
Constant Field Values

HEADER_COOKIE

static final String HEADER_COOKIE
the Cookie header

See Also:
Constant Field Values

SERVLET_REQUEST

static final String SERVLET_REQUEST
If the https server implementation is based on Servlets, the real HttpServletRequest will be registered in the request attributes using this name.


SERVLET_RESPONSE

static final String SERVLET_RESPONSE
If the https server implementation is based on Servlets, the real HttpServletResponse will be registered in the request attributes using this name.


SERVLET_CONTEXT

static final String SERVLET_CONTEXT
If the https server implementation is based on Servlets, the real ServletContext will be registered in the request attributes using this name. Note: a ServletContext may not be registered even if HttpServletRequest and HttpServletResponse objects are registered.

Method Detail

getParameter

String getParameter(String name)
Gets a form or URL query parameter based on the name passed in.

Parameters:
name -

getParameters

Map getParameters()
Gets all the form and URL query parameters

Returns:
All the form and URL query parameters

getSession

HttpSession getSession(boolean create)
Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.

If create is false and the request has no valid HttpSession, this method returns null.

Parameters:
create - true to create a new session for this request if necessary; false to return null if there's no current session
Returns:
the HttpSession associated with this request or null if create is false and the request has no valid session
See Also:
getSession()

getSession

HttpSession getSession()
Returns the current session associated with this request, or if the request does not have a session, creates one.

Returns:
the HttpSession associated with this request
See Also:
getSession(boolean)

getHeader

String getHeader(String name)
Gets a header based the header name passed in.

Parameters:
name - The name of the header to get
Returns:
The value of the header

getMethod

HttpRequest.Method getMethod()
Gets an integer value of the request method.

Returns:
The integer value of the method

getURI

URI getURI()
Gets the URI for the current URL page.

Returns:
The URI

getContentLength

int getContentLength()

getContentType

String getContentType()

getInputStream

InputStream getInputStream()
                           throws IOException
Throws:
IOException

getAttribute

Object getAttribute(String name)

setAttribute

void setAttribute(String name,
                  Object value)

getRemoteAddr

String getRemoteAddr()


Copyright © 1999-2013 The Apache OpenEJB development community. All Rights Reserved.