org.apache.tomcat.util.http

Class BaseRequest


public class BaseRequest
extends java.lang.Object

A general-purpose object for representing an HTTP request.

Field Summary

static String
SCHEME_HTTP
static String
SCHEME_HTTPS

Method Summary

MessageBytes
authType()
Get the auth type
MessageBytes
authorization()
Get the authorization credentials
MessageBytes
contentType()
Get the content type
Cookies
cookies()
Get cookies.
Object
getAttribute(String name)
Get an attribute on the request
Iterator
getAttributeNames()
Get iterator over attribute names
int
getContentLength()
Get the content length
Object
getNote(int id)
String
getScheme()
Get the scheme
boolean
getSecure()
Get whether the request is secure or not.
int
getServerPort()
Get the server port
MimeHeaders
headers()
Get this request's headers
MessageBytes
instanceId()
Get the host id ( or jvmRoute )
MessageBytes
jvmRoute()
MessageBytes
method()
Get the method.
MessageBytes
protocol()
Get the protocol
MessageBytes
queryString()
Get the query string
void
recycle()
Recycles this object and readies it further use.
MessageBytes
remoteAddr()
Get the remote address
MessageBytes
remoteHost()
Get the remote host
MessageBytes
remoteUser()
Get the remote user
MessageBytes
requestURI()
Get the request uri
MessageBytes
serverName()
Get the server name
void
setAttribute(String name, Object value)
Set an attribute on the request
void
setContentLength(int i)
Set the content length
void
setNote(int id, Object cr)
void
setScheme(String s)
Set the scheme.
void
setSecure(boolean b)
Set whether the request is secure or not.
void
setServerPort(int i)
Set the server port
String
toString()
** SLOW ** for debugging only!

Field Details

SCHEME_HTTP

public static final String SCHEME_HTTP


SCHEME_HTTPS

public static final String SCHEME_HTTPS

Method Details

authType

public MessageBytes authType()
Get the auth type

Returns:
the auth type


authorization

public MessageBytes authorization()
Get the authorization credentials

Returns:
the authorization credentials


contentType

public MessageBytes contentType()
Get the content type

Returns:
the content type


cookies

public Cookies cookies()
Get cookies.

Returns:
request cookies.


getAttribute

public Object getAttribute(String name)
Get an attribute on the request

Parameters:
name - attribute name

Returns:
attribute value


getAttributeNames

public Iterator getAttributeNames()
Get iterator over attribute names

Returns:
iterator over attribute names


getContentLength

public int getContentLength()
Get the content length

Returns:
the content length


getNote

public final Object getNote(int id)


getScheme

public String getScheme()
Get the scheme

Returns:
the scheme


getSecure

public boolean getSecure()
Get whether the request is secure or not.

Returns:
true if the request is secure.


getServerPort

public int getServerPort()
Get the server port

Returns:
the server port


headers

public MimeHeaders headers()
Get this request's headers

Returns:
request headers


instanceId

public MessageBytes instanceId()
Get the host id ( or jvmRoute )

Returns:
the jvm route


jvmRoute

public MessageBytes jvmRoute()


method

public MessageBytes method()
Get the method.

Returns:
the method


protocol

public MessageBytes protocol()
Get the protocol

Returns:
the protocol


queryString

public MessageBytes queryString()
Get the query string

Returns:
the query string


recycle

public void recycle()
Recycles this object and readies it further use.


remoteAddr

public MessageBytes remoteAddr()
Get the remote address

Returns:
the remote address


remoteHost

public MessageBytes remoteHost()
Get the remote host

Returns:
the remote host


remoteUser

public MessageBytes remoteUser()
Get the remote user

Returns:
the remote user


requestURI

public MessageBytes requestURI()
Get the request uri

Returns:
the request uri


serverName

public MessageBytes serverName()
Get the server name

Returns:
the server name


setAttribute

public void setAttribute(String name,
                         Object value)
Set an attribute on the request

Parameters:
name - attribute name
value - attribute value


setContentLength

public void setContentLength(int i)
Set the content length

Parameters:
i - the content length


setNote

public final void setNote(int id,
                          Object cr)


setScheme

public void setScheme(String s)
Set the scheme.

Parameters:
s - the scheme


setSecure

public void setSecure(boolean b)
Set whether the request is secure or not.

Parameters:
b - true if the request is secure.


setServerPort

public void setServerPort(int i)
Set the server port

Parameters:
i - the server port


toString

public String toString()
** SLOW ** for debugging only!


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.