Top Description Fields Constructors Methods
org.mortbay.jetty

public Class Request

extends Suspendable
implements HttpServletRequest
Class Inheritance
All Implemented Interfaces
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
Imports
java.io.BufferedReader, .IOException, .InputStream, .InputStreamReader, .UnsupportedEncodingException, java.net.InetAddress, java.nio.ByteBuffer, java.security.Principal, java.util.Collection, .Collections, .Enumeration, .EventListener, .HashMap, .Iterator, .List, .Locale, .Map, javax.servlet.RequestDispatcher, .ServletContext, .ServletInputStream, .ServletRequestAttributeEvent, .ServletRequestAttributeListener, .ServletRequestWrapper, .ServletResponse, javax.servlet.http.Cookie, .HttpServletRequest, .HttpSession, org.mortbay.io.Buffer, .BufferUtil, .EndPoint, org.mortbay.io.nio.DirectNIOBuffer, .IndirectNIOBuffer, .NIOBuffer, org.mortbay.jetty.handler.CompleteHandler, .ContextHandler, .SecurityHandler, .ContextHandler.SContext, org.mortbay.log.Log, org.mortbay.util.Attributes, .AttributesMap, .LazyList, .MultiMap, .StringUtil, .URIUtil, .UrlEncoded, org.mortbay.util.ajax.Continuation

Jetty Request.

Implements javax.servlet.HttpServletRequest from the javax.servlet package.

The standard interface of mostly getters, is extended with setters so that the request is mutable by the handlers that it is passed to. This allows the request object to be as lightweight as possible and not actually implement any significant behaviour. For example

A request instance is created for each HttpConnection accepted by the server and recycled for each HTTP request received via that connection. An effort is made to avoid reparsing headers and cookies that are likely to be the same for requests from the same connection.
Author
gregw

Field Summary

Modifier and TypeField and Description
private static final Collection<E>
private static final int
private static final int
private Attributes
private String
private MultiMap<K>
private String
private ContextHandler.SContext
private String
private Continuation
_continuation

Deprecated as a consequence of Continuation being deprecated.
private CookieCutter
private boolean
private boolean
private EndPoint
private boolean
private int
private String
private MultiMap<K>
private boolean
private String
private int
private String
private String
private String
private BufferedReader
private String
private String
private String
private Object
private String
private boolean
private String
private Map<K, V>
private Map<K, V>
private String
private String
private String
private String
private HttpSession
private SessionManager
private static final int
private long
private Buffer
private HttpURI
private Principal
private UserRealm
Inherited from org.mortbay.jetty.Suspendable:
_connection_initial_resumed_state_timeout_timeoutMs_timeoutTask

Constructor Summary

AccessConstructor and Description
public
public
Request(HttpConnection connection)

Method Summary

Modifier and TypeMethod and Description
public synchronized void
public void
private void
public Object
getAttribute(String
a String specifying the name of the attribute
name
)

Implements javax.servlet.ServletRequest.getAttribute.

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
public Enumeration<E>
getAttributeNames()

Implements javax.servlet.ServletRequest.getAttributeNames.

Returns an Enumeration containing the names of the attributes available to this request.
public Attributes
public String
getAuthType()

Implements javax.servlet.http.HttpServletRequest.getAuthType.

Returns the name of the authentication scheme used to protect the servlet.
public String
getCharacterEncoding()

Implements javax.servlet.ServletRequest.getCharacterEncoding.

Returns the name of the character encoding used in the body of this request.
public HttpConnection

Returns:

Returns the connection.
getConnection
()

public int
getContentLength()

Implements javax.servlet.ServletRequest.getContentLength.

Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE.
public String
getContentType()

Implements javax.servlet.ServletRequest.getContentType.

Returns the MIME type of the body of the request, or null if the type is not known.
public ContextHandler.SContext

Returns:

The current context used for this request, or null if setContext has not yet been called.
getContext
()

public String
getContextPath()

Implements javax.servlet.http.HttpServletRequest.getContextPath.

Returns the portion of the request URI that indicates the context of the request.
public Continuation
getContinuation()

Deprecated
public Continuation
getContinuation(boolean create)

Deprecated
public Cookie[]
getCookies()

Implements javax.servlet.http.HttpServletRequest.getCookies.

Returns an array containing all of the Cookie objects the client sent with this request.
public long
getDateHeader(String
a String specifying the name of the header
name
)

Implements javax.servlet.http.HttpServletRequest.getDateHeader.

Returns the value of the specified request header as a long value that represents a Date object.
public String
getHeader(String
a String specifying the header name
name
)

Implements javax.servlet.http.HttpServletRequest.getHeader.

Returns the value of the specified request header as a String.
public Enumeration<E>
getHeaderNames()

Implements javax.servlet.http.HttpServletRequest.getHeaderNames.

Returns an enumeration of all the header names this request contains.
public Enumeration<E>
getHeaders(String
a String specifying the header name
name
)

Implements javax.servlet.http.HttpServletRequest.getHeaders.

Returns all the values of the specified request header as an Enumeration of String objects.
public int

Returns:

Returns the inputState.
getInputState
()

public ServletInputStream
getInputStream()

Implements javax.servlet.ServletRequest.getInputStream.

Retrieves the body of the request as binary data using a ServletInputStream.
public int
getIntHeader(String
a String specifying the name of a request header
name
)

Implements javax.servlet.http.HttpServletRequest.getIntHeader.

Returns the value of the specified request header as an int.
public String
getLocalAddr()

Implements javax.servlet.ServletRequest.getLocalAddr.

Returns the Internet Protocol (IP) address of the interface on which the request was received.
public Locale
getLocale()

Implements javax.servlet.ServletRequest.getLocale.

Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
public Enumeration<E>
getLocales()

Implements javax.servlet.ServletRequest.getLocales.

Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
public String
getLocalName()

Implements javax.servlet.ServletRequest.getLocalName.

Returns the host name of the Internet Protocol (IP) interface on which the request was received.
public int
getLocalPort()

Implements javax.servlet.ServletRequest.getLocalPort.

Returns the Internet Protocol (IP) port number of the interface on which the request was received.
public String
getMethod()

Implements javax.servlet.http.HttpServletRequest.getMethod.

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
public String
getParameter(String
a String specifying the name of the parameter
name
)

Implements javax.servlet.ServletRequest.getParameter.

Returns the value of a request parameter as a String, or null if the parameter does not exist.
public Map<K, V>
getParameterMap()

Implements javax.servlet.ServletRequest.getParameterMap.

Returns a java.util.Map of the parameters of this request.
public Enumeration<E>
getParameterNames()

Implements javax.servlet.ServletRequest.getParameterNames.

Returns an Enumeration of String objects containing the names of the parameters contained in this request.
public MultiMap<K>

Returns:

Returns the parameters.
getParameters
()

public String[]
getParameterValues(String
a String containing the name of the parameter whose value is requested
name
)

Implements javax.servlet.ServletRequest.getParameterValues.

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
public String
getPathInfo()

Implements javax.servlet.http.HttpServletRequest.getPathInfo.

Returns any extra path information associated with the URL the client sent when it made this request.
public String
getPathTranslated()

Implements javax.servlet.http.HttpServletRequest.getPathTranslated.

Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
public String
getProtocol()

Implements javax.servlet.ServletRequest.getProtocol.

Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
public String
public String
getQueryString()

Implements javax.servlet.http.HttpServletRequest.getQueryString.

Returns the query string that is contained in the request URL after the path.
public BufferedReader
getReader()

Implements javax.servlet.ServletRequest.getReader.

Retrieves the body of the request as character data using a BufferedReader.
public String
getRealPath(String
the path for which the real path is to be returned.
path
)

Implements javax.servlet.ServletRequest.getRealPath.

public String
getRemoteAddr()

Implements javax.servlet.ServletRequest.getRemoteAddr.

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
public String
getRemoteHost()

Implements javax.servlet.ServletRequest.getRemoteHost.

Returns the fully qualified name of the client or the last proxy that sent the request.
public int
getRemotePort()

Implements javax.servlet.ServletRequest.getRemotePort.

Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
public String
getRemoteUser()

Implements javax.servlet.http.HttpServletRequest.getRemoteUser.

Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
public static Request
public RequestDispatcher
getRequestDispatcher(String
a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.
path
)

Implements javax.servlet.ServletRequest.getRequestDispatcher.

Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
public String
getRequestedSessionId()

Implements javax.servlet.http.HttpServletRequest.getRequestedSessionId.

Returns the session ID specified by the client.
public String
getRequestURI()

Implements javax.servlet.http.HttpServletRequest.getRequestURI.

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
public StringBuffer
getRequestURL()

Implements javax.servlet.http.HttpServletRequest.getRequestURL.

Reconstructs the URL the client used to make the request.
public Map<K, V>
public StringBuilder

Returns:

"scheme://host:port"
getRootURL
()

Reconstructs the URL the client used to make the request.

public String
getScheme()

Implements javax.servlet.ServletRequest.getScheme.

Returns the name of the scheme used to make this request, for example, http, https, or ftp.
public String
getServerName()

Implements javax.servlet.ServletRequest.getServerName.

Returns the host name of the server to which the request was sent.
public int
getServerPort()

Implements javax.servlet.ServletRequest.getServerPort.

Returns the port number to which the request was sent.
public ServletContext
getServletContext()

Implements javax.servlet.ServletRequest.getServletContext.

Gets the servlet context to which this ServletRequest was last dispatched.
public String
public String
getServletPath()

Implements javax.servlet.http.HttpServletRequest.getServletPath.

Returns the part of this request's URL that calls the servlet.
public ServletResponse
public HttpSession
getSession()

Implements javax.servlet.http.HttpServletRequest.getSession.

Returns the current session associated with this request, or if the request does not have a session, creates one.
public HttpSession
getSession(boolean
true to create a new session for this request if necessary; false to return null if there's no current session
create
)

Implements javax.servlet.http.HttpServletRequest.getSession.

Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.
public SessionManager

Returns:

Returns the sessionManager.
getSessionManager
()

public long

Returns:

The time that the request was received.
getTimeStamp
()

Get Request TimeStamp

public Buffer

Returns:

The time that the request was received.
getTimeStampBuffer
()

Get Request TimeStamp

public HttpURI

Returns:

Returns the uri.
getUri
()

public Principal
getUserPrincipal()

Implements javax.servlet.http.HttpServletRequest.getUserPrincipal.

Returns a java.security.Principal object containing the name of the current authenticated user.
public UserRealm

Returns:

Returns the userRealm.
getUserRealm
()

public boolean
public boolean
isRequestedSessionIdFromCookie()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie.

Checks whether the requested session ID was conveyed to the server as an HTTP cookie.

public boolean
public boolean
isRequestedSessionIdFromURL()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL.

Checks whether the requested session ID was conveyed to the server as part of the request URL.

public boolean
isRequestedSessionIdValid()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

Checks whether the requested session ID is still valid.
public boolean
isSecure()

Implements javax.servlet.ServletRequest.isSecure.

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
public boolean
isUserInRole(String
a String specifying the name of the role
role
)

Implements javax.servlet.http.HttpServletRequest.isUserInRole.

Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
public HttpSession
protected void
public void
removeAttribute(String
a String specifying the name of the attribute to remove
name
)

Implements javax.servlet.ServletRequest.removeAttribute.

Removes an attribute from this request.
public synchronized void
public void
public void
public void
setAttribute(String
a String specifying the name of the attribute
name
,
Object
the Object to be stored
value
)

Implements javax.servlet.ServletRequest.setAttribute.

Stores an attribute in this request.
public void
public void
setAuthType(String
The authType to set.
authType
)

public void
setCharacterEncoding(String
String containing the name of the character encoding.
encoding
)

Implements javax.servlet.ServletRequest.setCharacterEncoding.

Overrides the name of the character encoding used in the body of this request.
public void
protected void
public void
setContentType(String contentType)

public void
public void
setContextPath(String contextPath)

Sets the "context path" for this request

pack-priv void
setContinuation(Continuation cont)

Deprecated as a consequence of Continuation being deprecated.
public void
setCookies(Cookie[]
The cookies to set.
cookies
)

public void
setHandled(boolean h)

public void
setMethod(String
The method to set.
method
)

public void
setParameters(MultiMap<K>
The parameters to set.
parameters
)

public void
setPathInfo(String
The pathInfo to set.
pathInfo
)

public void
setProtocol(String
The protocol to set.
protocol
)

public void
setQueryEncoding(String queryEncoding)

Set the character encoding used for the query string.

public void
setQueryString(String
The queryString to set.
queryString
)

public void
setRemoteAddr(String
The address to set.
addr
)

public void
setRemoteHost(String
The host to set.
host
)

public void
setRequestedSessionId(String
The requestedSessionId to set.
requestedSessionId
)

public void
setRequestedSessionIdFromCookie(boolean
The requestedSessionIdCookie to set.
requestedSessionIdCookie
)

public void
setRequestURI(String
The requestURI to set.
requestURI
)

public void
setRoleMap(Map<K, V> map)

public void
setScheme(String
The scheme to set.
scheme
)

public void
setServerName(String
The host to set.
host
)

public void
setServerPort(int
The port to set.
port
)

public void
setServletName(String
The servletName to set.
name
)

public void
setServletPath(String
The servletPath to set.
servletPath
)

public void
setSession(HttpSession
The session to set.
session
)

public void
setSessionManager(SessionManager
The sessionManager to set.
sessionManager
)

public void
setTimeStamp(long ts)

public void
setUri(HttpURI
The uri to set.
uri
)

public void
setUserPrincipal(Principal
The userPrincipal to set.
userPrincipal
)

public void
setUserRealm(UserRealm
The userRealm to set.
userRealm
)

public void
public String
toString()

Overrides org.mortbay.jetty.Suspendable.toString.

Returns a string representation of the object.
Inherited from org.mortbay.jetty.Suspendable:
cancelTimeoutexpiregetStatusStringgetTimeouthandlingisCompletingisInitialisResumedisSuspendedisTimeoutresetscheduleDispatchscheduleTimeoutshouldCompleteshouldHandleRequestsuspendunhandling

Field Detail

__defaultLocaleback to summary
private static final Collection<E> __defaultLocale
__NONEback to summary
private static final int __NONE
__READERback to summary
private static final int __READER
_attributesback to summary
private Attributes _attributes
_authTypeback to summary
private String _authType
_baseParametersback to summary
private MultiMap<K> _baseParameters
_characterEncodingback to summary
private String _characterEncoding
_contextback to summary
private ContextHandler.SContext _context
_contextPathback to summary
private String _contextPath
_continuationback to summary
private Continuation _continuation

Deprecated

as a consequence of Continuation being deprecated. See corresponding docs for further information.

_cookiesback to summary
private CookieCutter _cookies
_cookiesExtractedback to summary
private boolean _cookiesExtracted
_dnsback to summary
private boolean _dns
_endpback to summary
private EndPoint _endp
_handledback to summary
private boolean _handled
_inputStateback to summary
private int _inputState
_methodback to summary
private String _method
_parametersback to summary
private MultiMap<K> _parameters
_paramsExtractedback to summary
private boolean _paramsExtracted
_pathInfoback to summary
private String _pathInfo
_portback to summary
private int _port
_protocolback to summary
private String _protocol
_queryEncodingback to summary
private String _queryEncoding
_queryStringback to summary
private String _queryString
_readerback to summary
private BufferedReader _reader
_readerEncodingback to summary
private String _readerEncoding
_remoteAddrback to summary
private String _remoteAddr
_remoteHostback to summary
private String _remoteHost
_requestAttributeListenersback to summary
private Object _requestAttributeListeners
_requestedSessionIdback to summary
private String _requestedSessionId
_requestedSessionIdFromCookieback to summary
private boolean _requestedSessionIdFromCookie
_requestURIback to summary
private String _requestURI
_roleMapback to summary
private Map<K, V> _roleMap
_savedNewSessionsback to summary
private Map<K, V> _savedNewSessions
_schemeback to summary
private String _scheme
_serverNameback to summary
private String _serverName
_servletNameback to summary
private String _servletName
_servletPathback to summary
private String _servletPath
_sessionback to summary
private HttpSession _session
_sessionManagerback to summary
private SessionManager _sessionManager
_STREAMback to summary
private static final int _STREAM
_timeStampback to summary
private long _timeStamp
_timeStampBufferback to summary
private Buffer _timeStampBuffer
_uriback to summary
private HttpURI _uri
_userPrincipalback to summary
private Principal _userPrincipal
_userRealmback to summary
private UserRealm _userRealm

Constructor Detail

Requestback to summary
public Request()
Requestback to summary
public Request(HttpConnection connection)

Method Detail

addEventListenerback to summary
public synchronized void addEventListener(EventListener listener)
completeback to summary
public void complete() throws IOException

Overrides org.mortbay.jetty.Suspendable.complete.

extractParametersback to summary
private void extractParameters()
getAttributeback to summary
public Object getAttribute(String name)

Implements javax.servlet.ServletRequest.getAttribute.

Doc from javax.servlet.ServletRequest.getAttribute.

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programatically using ServletRequest#setAttribute. This allows information to be embedded into a request before a RequestDispatcher call.

Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.

Parameters
name:String

a String specifying the name of the attribute

Returns:Object

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNamesback to summary
public Enumeration<E> getAttributeNames()

Implements javax.servlet.ServletRequest.getAttributeNames.

Doc from javax.servlet.ServletRequest.getAttributeNames.

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Returns:Enumeration<E>

an Enumeration of strings containing the names of the request's attributes

getAttributesback to summary
public Attributes getAttributes()
getAuthTypeback to summary
public String getAuthType()

Implements javax.servlet.http.HttpServletRequest.getAuthType.

Doc from javax.servlet.http.HttpServletRequest.getAuthType.

Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned.

Same as the value of the CGI variable AUTH_TYPE.

Returns:String

one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.

getCharacterEncodingback to summary
public String getCharacterEncoding()

Implements javax.servlet.ServletRequest.getCharacterEncoding.

Doc from javax.servlet.ServletRequest.getCharacterEncoding.

Returns the name of the character encoding used in the body of this request. This method returns null if no request encoding character encoding has been specified. The following methods for specifying the request character encoding are consulted, in decreasing order of priority: per request, per web app (using ServletContext#setRequestCharacterEncoding, deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration).

Returns:String

a String containing the name of the character encoding, or null if the request does not specify a character encoding

getConnectionback to summary
public HttpConnection getConnection()
Returns:HttpConnection

Returns the connection.

getContentLengthback to summary
public int getContentLength()

Implements javax.servlet.ServletRequest.getContentLength.

Doc from javax.servlet.ServletRequest.getContentLength.

Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.

Returns:int

an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.

getContentTypeback to summary
public String getContentType()

Implements javax.servlet.ServletRequest.getContentType.

Doc from javax.servlet.ServletRequest.getContentType.

Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.

Returns:String

a String containing the name of the MIME type of the request, or null if the type is not known

getContextback to summary
public ContextHandler.SContext getContext()
Returns:ContextHandler.SContext

The current context used for this request, or null if setContext has not yet been called.

getContextPathback to summary
public String getContextPath()

Implements javax.servlet.http.HttpServletRequest.getContextPath.

Doc from javax.servlet.http.HttpServletRequest.getContextPath.

Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the javax.servlet.ServletContext#getContextPath() method. The context path returned by javax.servlet.ServletContext#getContextPath() should be considered as the prime or preferred context path of the application.

Returns:String

a String specifying the portion of the request URI that indicates the context of the request

getContinuationback to summary
public Continuation getContinuation()

Deprecated

getContinuationback to summary
public Continuation getContinuation(boolean create)

Deprecated

getCookiesback to summary
public Cookie[] getCookies()

Implements javax.servlet.http.HttpServletRequest.getCookies.

Doc from javax.servlet.http.HttpServletRequest.getCookies.

Returns an array containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.

Returns:Cookie[]

an array of all the Cookies included with this request, or null if the request has no cookies

getDateHeaderback to summary
public long getDateHeader(String name)

Implements javax.servlet.http.HttpServletRequest.getDateHeader.

Doc from javax.servlet.http.HttpServletRequest.getDateHeader.

Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, such as If-Modified-Since.

The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.

If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an IllegalArgumentException.

Parameters
name:String

a String specifying the name of the header

Returns:long

a long value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request

getHeaderback to summary
public String getHeader(String name)

Implements javax.servlet.http.HttpServletRequest.getHeader.

Doc from javax.servlet.http.HttpServletRequest.getHeader.

Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.

Parameters
name:String

a String specifying the header name

Returns:String

a String containing the value of the requested header, or null if the request does not have a header of that name

getHeaderNamesback to summary
public Enumeration<E> getHeaderNames()

Implements javax.servlet.http.HttpServletRequest.getHeaderNames.

Doc from javax.servlet.http.HttpServletRequest.getHeaderNames.

Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.

Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null

Returns:Enumeration<E>

an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, null

getHeadersback to summary
public Enumeration<E> getHeaders(String name)

Implements javax.servlet.http.HttpServletRequest.getHeaders.

Doc from javax.servlet.http.HttpServletRequest.getHeaders.

Returns all the values of the specified request header as an Enumeration of String objects.

Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive. You can use this method with any request header.

Parameters
name:String

a String specifying the header name

Returns:Enumeration<E>

an Enumeration containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null

getInputStateback to summary
public int getInputState()
Returns:int

Returns the inputState.

getInputStreamback to summary
public ServletInputStream getInputStream() throws IOException

Implements javax.servlet.ServletRequest.getInputStream.

Doc from javax.servlet.ServletRequest.getInputStream.

Retrieves the body of the request as binary data using a ServletInputStream. Either this method or getReader may be called to read the body, not both.

Returns:ServletInputStream

a ServletInputStream object containing the body of the request

Exceptions
IOException:
if an input or output exception occurred
getIntHeaderback to summary
public int getIntHeader(String name)

Implements javax.servlet.http.HttpServletRequest.getIntHeader.

Doc from javax.servlet.http.HttpServletRequest.getIntHeader.

Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a NumberFormatException.

The header name is case insensitive.

Parameters
name:String

a String specifying the name of a request header

Returns:int

an integer expressing the value of the request header or -1 if the request doesn't have a header of this name

getLocalAddrback to summary
public String getLocalAddr()

Implements javax.servlet.ServletRequest.getLocalAddr.

Doc from javax.servlet.ServletRequest.getLocalAddr.

Returns the Internet Protocol (IP) address of the interface on which the request was received.

Returns:String

a String containing the IP address on which the request was received.

getLocaleback to summary
public Locale getLocale()

Implements javax.servlet.ServletRequest.getLocale.

Doc from javax.servlet.ServletRequest.getLocale.

Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.

Returns:Locale

the preferred Locale for the client

getLocalesback to summary
public Enumeration<E> getLocales()

Implements javax.servlet.ServletRequest.getLocales.

Doc from javax.servlet.ServletRequest.getLocales.

Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns an Enumeration containing one Locale, the default locale for the server.

Returns:Enumeration<E>

an Enumeration of preferred Locale objects for the client

getLocalNameback to summary
public String getLocalName()

Implements javax.servlet.ServletRequest.getLocalName.

Doc from javax.servlet.ServletRequest.getLocalName.

Returns the host name of the Internet Protocol (IP) interface on which the request was received.

Returns:String

a String containing the host name of the IP on which the request was received.

getLocalPortback to summary
public int getLocalPort()

Implements javax.servlet.ServletRequest.getLocalPort.

Doc from javax.servlet.ServletRequest.getLocalPort.

Returns the Internet Protocol (IP) port number of the interface on which the request was received.

Returns:int

an integer specifying the port number

getMethodback to summary
public String getMethod()

Implements javax.servlet.http.HttpServletRequest.getMethod.

Doc from javax.servlet.http.HttpServletRequest.getMethod.

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.

Returns:String

a String specifying the name of the method with which this request was made

getParameterback to summary
public String getParameter(String name)

Implements javax.servlet.ServletRequest.getParameter.

Doc from javax.servlet.ServletRequest.getParameter.

Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues.

If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via getInputStream or getReader can interfere with the execution of this method.

Parameters
name:String

a String specifying the name of the parameter

Returns:String

a String representing the single value of the parameter

getParameterMapback to summary
public Map<K, V> getParameterMap()

Implements javax.servlet.ServletRequest.getParameterMap.

Doc from javax.servlet.ServletRequest.getParameterMap.

Returns a java.util.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.

Returns:Map<K, V>

an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

getParameterNamesback to summary
public Enumeration<E> getParameterNames()

Implements javax.servlet.ServletRequest.getParameterNames.

Doc from javax.servlet.ServletRequest.getParameterNames.

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Returns:Enumeration<E>

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParametersback to summary
public MultiMap<K> getParameters()
Returns:MultiMap<K>

Returns the parameters.

getParameterValuesback to summary
public String[] getParameterValues(String name)

Implements javax.servlet.ServletRequest.getParameterValues.

Doc from javax.servlet.ServletRequest.getParameterValues.

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

Parameters
name:String

a String containing the name of the parameter whose value is requested

Returns:String[]

an array of String objects containing the parameter's values

getPathInfoback to summary
public String getPathInfo()

Implements javax.servlet.http.HttpServletRequest.getPathInfo.

Doc from javax.servlet.http.HttpServletRequest.getPathInfo.

Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.

This method returns null if there was no extra path information.

Same as the value of the CGI variable PATH_INFO.

Returns:String

a String, decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information

getPathTranslatedback to summary
public String getPathTranslated()

Implements javax.servlet.http.HttpServletRequest.getPathTranslated.

Doc from javax.servlet.http.HttpServletRequest.getPathTranslated.

Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.

If the URL does not have any extra path information, this method returns null or the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string.

Returns:String

a String specifying the real path, or null if the URL does not have any extra path information

getProtocolback to summary
public String getProtocol()

Implements javax.servlet.ServletRequest.getProtocol.

Doc from javax.servlet.ServletRequest.getProtocol.

Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.

Returns:String

a String containing the protocol name and version number

getQueryEncodingback to summary
public String getQueryEncoding()
getQueryStringback to summary
public String getQueryString()

Implements javax.servlet.http.HttpServletRequest.getQueryString.

Doc from javax.servlet.http.HttpServletRequest.getQueryString.

Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.

Returns:String

a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.

getReaderback to summary
public BufferedReader getReader() throws IOException

Implements javax.servlet.ServletRequest.getReader.

Doc from javax.servlet.ServletRequest.getReader.

Retrieves the body of the request as character data using a BufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method or getInputStream may be called to read the body, not both.

Returns:BufferedReader

a BufferedReader containing the body of the request

Exceptions
IOException:
if an input or output exception occurred
getRealPathback to summary
public String getRealPath(String path)

Implements javax.servlet.ServletRequest.getRealPath.

Parameters
path:String

Doc from javax.servlet.ServletRequest.getRealPath.

the path for which the real path is to be returned.

Returns:String

Doc from javax.servlet.ServletRequest.getRealPath.

the real path, or null if the translation cannot be performed.

getRemoteAddrback to summary
public String getRemoteAddr()

Implements javax.servlet.ServletRequest.getRemoteAddr.

Doc from javax.servlet.ServletRequest.getRemoteAddr.

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.

Returns:String

a String containing the IP address of the client that sent the request

getRemoteHostback to summary
public String getRemoteHost()

Implements javax.servlet.ServletRequest.getRemoteHost.

Doc from javax.servlet.ServletRequest.getRemoteHost.

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.

Returns:String

a String containing the fully qualified name of the client

getRemotePortback to summary
public int getRemotePort()

Implements javax.servlet.ServletRequest.getRemotePort.

Doc from javax.servlet.ServletRequest.getRemotePort.

Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.

Returns:int

an integer specifying the port number

getRemoteUserback to summary
public String getRemoteUser()

Implements javax.servlet.http.HttpServletRequest.getRemoteUser.

Doc from javax.servlet.http.HttpServletRequest.getRemoteUser.

Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.

Returns:String

a String specifying the login of the user making this request, or null if the user login is not known

getRequestback to summary
public static Request getRequest(HttpServletRequest request)
getRequestDispatcherback to summary
public RequestDispatcher getRequestDispatcher(String path)

Implements javax.servlet.ServletRequest.getRequestDispatcher.

Doc from javax.servlet.ServletRequest.getRequestDispatcher.

Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher.

The difference between this method and ServletContext#getRequestDispatcher is that this method can take a relative path.

Parameters
path:String

a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.

Returns:RequestDispatcher

a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher

getRequestedSessionIdback to summary
public String getRequestedSessionId()

Implements javax.servlet.http.HttpServletRequest.getRequestedSessionId.

Doc from javax.servlet.http.HttpServletRequest.getRequestedSessionId.

Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returns null.

Returns:String

a String specifying the session ID, or null if the request did not specify a session ID

getRequestURIback to summary
public String getRequestURI()

Implements javax.servlet.http.HttpServletRequest.getRequestURI.

Doc from javax.servlet.http.HttpServletRequest.getRequestURI.

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:

First line of HTTP request Returned Value
POST /some/path.html HTTP/1.1/some/path.html
GET http://foo.bar/a.html HTTP/1.0 /a.html
HEAD /xyz?a=b HTTP/1.1/xyz

To reconstruct an URL with a scheme and host, use HttpUtils#getRequestURL.

Returns:String

a String containing the part of the URL from the protocol name up to the query string

getRequestURLback to summary
public StringBuffer getRequestURL()

Implements javax.servlet.http.HttpServletRequest.getRequestURL.

Doc from javax.servlet.http.HttpServletRequest.getRequestURL.

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

If this request has been forwarded using javax.servlet.RequestDispatcher#forward, the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

This method is useful for creating redirect messages and for reporting errors.

Returns:StringBuffer

a StringBuffer object containing the reconstructed URL

getRoleMapback to summary
public Map<K, V> getRoleMap()
getRootURLback to summary
public StringBuilder getRootURL()

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and, but it does not include a path.

Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append path and query parameters. This method is useful for creating redirect messages and for reporting errors.

Returns:StringBuilder

"scheme://host:port"

getSchemeback to summary
public String getScheme()

Implements javax.servlet.ServletRequest.getScheme.

Doc from javax.servlet.ServletRequest.getScheme.

Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.

Returns:String

a String containing the name of the scheme used to make this request

getServerNameback to summary
public String getServerName()

Implements javax.servlet.ServletRequest.getServerName.

Doc from javax.servlet.ServletRequest.getServerName.

Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.

Returns:String

a String containing the name of the server

getServerPortback to summary
public int getServerPort()

Implements javax.servlet.ServletRequest.getServerPort.

Doc from javax.servlet.ServletRequest.getServerPort.

Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.

Returns:int

an integer specifying the port number

getServletContextback to summary
public ServletContext getServletContext()

Implements javax.servlet.ServletRequest.getServletContext.

Doc from javax.servlet.ServletRequest.getServletContext.

Gets the servlet context to which this ServletRequest was last dispatched.

Returns:ServletContext

the servlet context to which this ServletRequest was last dispatched

getServletNameback to summary
public String getServletName()
getServletPathback to summary
public String getServletPath()

Implements javax.servlet.http.HttpServletRequest.getServletPath.

Doc from javax.servlet.http.HttpServletRequest.getServletPath.

Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.

This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.

Returns:String

a String containing the name or path of the servlet being called, as specified in the request URL, decoded, or an empty string if the servlet used to process the request is matched using the "/*" pattern.

getServletResponseback to summary
public ServletResponse getServletResponse()
getSessionback to summary
public HttpSession getSession()

Implements javax.servlet.http.HttpServletRequest.getSession.

Doc from javax.servlet.http.HttpServletRequest.getSession.

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

Returns:HttpSession

the HttpSession associated with this request

getSessionback to summary
public HttpSession getSession(boolean create)

Implements javax.servlet.http.HttpServletRequest.getSession.

Doc from javax.servlet.http.HttpServletRequest.getSession.

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.

To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.

Parameters
create:boolean

true to create a new session for this request if necessary; false to return null if there's no current session

Returns:HttpSession

the HttpSession associated with this request or null if create is false and the request has no valid session

getSessionManagerback to summary
public SessionManager getSessionManager()
Returns:SessionManager

Returns the sessionManager.

getTimeStampback to summary
public long getTimeStamp()

Get Request TimeStamp

Returns:long

The time that the request was received.

getTimeStampBufferback to summary
public Buffer getTimeStampBuffer()

Get Request TimeStamp

Returns:Buffer

The time that the request was received.

getUriback to summary
public HttpURI getUri()
Returns:HttpURI

Returns the uri.

getUserPrincipalback to summary
public Principal getUserPrincipal()

Implements javax.servlet.http.HttpServletRequest.getUserPrincipal.

Doc from javax.servlet.http.HttpServletRequest.getUserPrincipal.

Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Returns:Principal

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

getUserRealmback to summary
public UserRealm getUserRealm()
Returns:UserRealm

Returns the userRealm.

isHandledback to summary
public boolean isHandled()
isRequestedSessionIdFromCookieback to summary
public boolean isRequestedSessionIdFromCookie()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie.

Doc from javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie.

Checks whether the requested session ID was conveyed to the server as an HTTP cookie.

Returns:boolean

true if the session ID was conveyed to the server an an HTTP cookie; otherwise, false

isRequestedSessionIdFromUrlback to summary
public boolean isRequestedSessionIdFromUrl()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromUrl.

Returns:boolean

Doc from javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromUrl.

true if the session ID was conveyed to the server as part of a URL; otherwise, false

isRequestedSessionIdFromURLback to summary
public boolean isRequestedSessionIdFromURL()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL.

Doc from javax.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL.

Checks whether the requested session ID was conveyed to the server as part of the request URL.

Returns:boolean

true if the session ID was conveyed to the server as part of a URL; otherwise, false

isRequestedSessionIdValidback to summary
public boolean isRequestedSessionIdValid()

Implements javax.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

Doc from javax.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

Checks whether the requested session ID is still valid.

If the client did not specify any session ID, this method returns false.

Returns:boolean

true if this request has an id for a valid session in the current session context; false otherwise

isSecureback to summary
public boolean isSecure()

Implements javax.servlet.ServletRequest.isSecure.

Doc from javax.servlet.ServletRequest.isSecure.

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Returns:boolean

a boolean indicating if the request was made using a secure channel

isUserInRoleback to summary
public boolean isUserInRole(String role)

Implements javax.servlet.http.HttpServletRequest.isUserInRole.

Doc from javax.servlet.http.HttpServletRequest.isUserInRole.

Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

The role name "*" should never be used as an argument in calling isUserInRole. Any call to isUserInRole with "*" must return false. If the role-name of the security-role to be tested is "**", and the application has NOT declared an application security-role with role-name "**", isUserInRole must only return true if the user has been authenticated; that is, only when getRemoteUser and getUserPrincipal would both return a non-null value. Otherwise, the container must check the user for membership in the application role.

Parameters
role:String

a String specifying the name of the role

Returns:boolean

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated

recoverNewSessionback to summary
public HttpSession recoverNewSession(Object key)
recycleback to summary
protected void recycle()
removeAttributeback to summary
public void removeAttribute(String name)

Implements javax.servlet.ServletRequest.removeAttribute.

Doc from javax.servlet.ServletRequest.removeAttribute.

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.

Parameters
name:String

a String specifying the name of the attribute to remove

removeEventListenerback to summary
public synchronized void removeEventListener(EventListener listener)
resumeback to summary
public void resume()

Overrides org.mortbay.jetty.Suspendable.resume.

saveNewSessionback to summary
public void saveNewSession(Object key, HttpSession session)
setAttributeback to summary
public void setAttribute(String name, Object value)

Implements javax.servlet.ServletRequest.setAttribute.

Doc from javax.servlet.ServletRequest.setAttribute.

Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with RequestDispatcher.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as calling removeAttribute.
It is warned that when the request is dispatched from the servlet resides in a different web application by RequestDispatcher, the object set by this method may not be correctly retrieved in the caller servlet.

Parameters
name:String

a String specifying the name of the attribute

value:Object

the Object to be stored

setAttributesback to summary
public void setAttributes(Attributes attributes)
setAuthTypeback to summary
public void setAuthType(String authType)
Parameters
authType:String

The authType to set.

setCharacterEncodingback to summary
public void setCharacterEncoding(String encoding) throws UnsupportedEncodingException

Implements javax.servlet.ServletRequest.setCharacterEncoding.

Doc from javax.servlet.ServletRequest.setCharacterEncoding.

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(). Otherwise, it has no effect.

Parameters
encoding:String

String containing the name of the character encoding.

Exceptions
UnsupportedEncodingException:
if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid
setCharacterEncodingUncheckedback to summary
public void setCharacterEncodingUnchecked(String encoding)
setConnectionback to summary
protected void setConnection(HttpConnection connection)
setContentTypeback to summary
public void setContentType(String contentType)
setContextback to summary
public void setContext(ContextHandler.SContext context)
setContextPathback to summary
public void setContextPath(String contextPath)

Sets the "context path" for this request

See Also
HttpServletRequest#getContextPath
setContinuationback to summary
pack-priv void setContinuation(Continuation cont)

Deprecated

as a consequence of Continuation being deprecated. See corresponding docs for further information.

setCookiesback to summary
public void setCookies(Cookie[] cookies)
Parameters
cookies:Cookie[]

The cookies to set.

setHandledback to summary
public void setHandled(boolean h)
setMethodback to summary
public void setMethod(String method)
Parameters
method:String

The method to set.

setParametersback to summary
public void setParameters(MultiMap<K> parameters)
Parameters
parameters:MultiMap<K>

The parameters to set.

setPathInfoback to summary
public void setPathInfo(String pathInfo)
Parameters
pathInfo:String

The pathInfo to set.

setProtocolback to summary
public void setProtocol(String protocol)
Parameters
protocol:String

The protocol to set.

setQueryEncodingback to summary
public void setQueryEncoding(String queryEncoding)

Set the character encoding used for the query string. This call will effect the return of getQueryString and getParamaters. It must be called before any geParameter methods. The request attribute "org.mortbay.jetty.Request.queryEncoding" may be set as an alternate method of calling setQueryEncoding.

setQueryStringback to summary
public void setQueryString(String queryString)
Parameters
queryString:String

The queryString to set.

setRemoteAddrback to summary
public void setRemoteAddr(String addr)
Parameters
addr:String

The address to set.

setRemoteHostback to summary
public void setRemoteHost(String host)
Parameters
host:String

The host to set.

setRequestedSessionIdback to summary
public void setRequestedSessionId(String requestedSessionId)
Parameters
requestedSessionId:String

The requestedSessionId to set.

setRequestedSessionIdFromCookieback to summary
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdCookie)
Parameters
requestedSessionIdCookie:boolean

The requestedSessionIdCookie to set.

setRequestURIback to summary
public void setRequestURI(String requestURI)
Parameters
requestURI:String

The requestURI to set.

setRoleMapback to summary
public void setRoleMap(Map<K, V> map)
setSchemeback to summary
public void setScheme(String scheme)
Parameters
scheme:String

The scheme to set.

setServerNameback to summary
public void setServerName(String host)
Parameters
host:String

The host to set.

setServerPortback to summary
public void setServerPort(int port)
Parameters
port:int

The port to set.

setServletNameback to summary
public void setServletName(String name)
Parameters
name:String

The servletName to set.

setServletPathback to summary
public void setServletPath(String servletPath)
Parameters
servletPath:String

The servletPath to set.

setSessionback to summary
public void setSession(HttpSession session)
Parameters
session:HttpSession

The session to set.

setSessionManagerback to summary
public void setSessionManager(SessionManager sessionManager)
Parameters
sessionManager:SessionManager

The sessionManager to set.

setTimeStampback to summary
public void setTimeStamp(long ts)
setUriback to summary
public void setUri(HttpURI uri)
Parameters
uri:HttpURI

The uri to set.

setUserPrincipalback to summary
public void setUserPrincipal(Principal userPrincipal)
Parameters
userPrincipal:Principal

The userPrincipal to set.

setUserRealmback to summary
public void setUserRealm(UserRealm userRealm)
Parameters
userRealm:UserRealm

The userRealm to set.

suspendback to summary
public void suspend()

Overrides org.mortbay.jetty.Suspendable.suspend.

toStringback to summary
public String toString()

Overrides org.mortbay.jetty.Suspendable.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object