com.caucho.server.connection
Class StubServletRequest

java.lang.Object
  com.caucho.server.connection.AbstractHttpRequest
      com.caucho.server.connection.StubServletRequest

All Implemented Interfaces:

SecurityContextProvider, CauchoRequest, HttpServletRequest, ServletRequest

public class StubServletRequest
extends AbstractHttpRequest

Used when there isn't any actual request object, e.g. for calling run-at servlets.

Field Summary

Fields inherited from class com.caucho.server.connection.AbstractHttpRequest

_calendar, _cb, _conn, _expect100Continue, _hasReadStream, _headerCodes, _hostHeader, _invocation, _rawRead, _readStream, _response, _server, _sessionGroup, _tcpConn, CONTEXT_PATH, ERROR_URI, EXCEPTION, EXCEPTION_TYPE, JSP_EXCEPTION, log, MESSAGE, PATH_INFO, QUERY_STRING, REQUEST_URI, SERVLET_NAME, SERVLET_PATH, SHUTDOWN, STATUS_CODE

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

StubServletRequest()

Method Summary

java.lang.Object	getAttribute(java.lang.String name) Returns the value of the named request attribute.
java.util.Enumeration<java.lang.String>	getAttributeNames() Returns an enumeration of the request attribute names.
java.lang.String	getAuthType() Gets the authorization type
java.lang.String	getCharacterEncoding() Returns the character encoding of a post.
int	getContentLength() Returns the content length of a post.
java.lang.String	getContentType() Returns the content-length of a post.
java.lang.String	getContextPath() Returns the context part of the uri.
long	getDateHeader(java.lang.String header) Returns a header interpreted as a date.
java.lang.String	getHeader(java.lang.String header) Returns the named header.
java.util.Enumeration<java.lang.String>	getHeaderNames() Enumerates the header keys
java.util.Enumeration	getHeaders(java.lang.String header) Returns an enumeration of the headers for the named attribute.
ServletInputStream	getInputStream() Returns a stream for reading POST data.
int	getIntHeader(java.lang.String header) Returns the named header, converted to an integer.
java.util.Locale	getLocale() Returns the request's preferred locale, based on the Accept-Language header.
java.util.Enumeration<java.util.Locale>	getLocales() Returns an enumeration of all locales acceptable by the client.
java.lang.String	getMethod() Returns the HTTP method, e.g.
java.lang.String	getParameter(java.lang.String name) Returns the form primary value for the given name.
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap() Returns a map of the form.
java.util.Enumeration<java.lang.String>	getParameterNames() Returns an enumeration of the form names.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the form's values for the given name.
java.lang.String	getPathInfo() Returns the portion of the uri after the servlet path for the original request.
java.lang.String	getPathTranslated() Returns the real path of pathInfo.
java.lang.String	getProtocol() Returns the prococol, e.g.
java.lang.String	getQueryString() Returns the current page's query string.
java.io.BufferedReader	getReader() Returns a Reader for the POST contents
java.lang.String	getRealPath(java.lang.String path) Returns the path of the URI.
java.lang.String	getRemoteAddr() Returns the IP address of the remote host, i.e.
java.lang.String	getRemoteHost() Returns the DNS hostname of the remote host, i.e.
int	getRemotePort() Returns the local port.
java.lang.String	getRemoteUser() Gets the remote user from the authorization type
RequestDispatcher	getRequestDispatcher(java.lang.String uri) Returns a request dispatcher relative to the current request.
java.lang.String	getRequestURI() Returns the URI for the request
java.lang.StringBuffer	getRequestURL() Returns the URL for the request
java.lang.String	getScheme() Returns the request's scheme.
java.lang.String	getServerName() Returns the local server name.
int	getServerPort() Returns the server's port.
java.lang.String	getServletPath() Returns the portion of the uri mapped to the servlet for the original request.
byte[]	getUriBuffer()
int	getUriLength()
java.security.Principal	getUserPrincipal() Returns the Principal representing the logged in user.
boolean	initStream(ReadStream rawStream, ReadStream realStream) Initialize the read stream from the raw stream.
boolean	isSecure() Returns true if the request is secure.
boolean	isUserInRole(java.lang.String str) Returns true if the user represented by the current request plays the named role.
void	removeAttribute(java.lang.String name) Removes the value of the named request attribute.
void	setAttribute(java.lang.String name, java.lang.Object value) Sets the value of the named request attribute.
void	setCharacterEncoding(java.lang.String encoding) Sets the character encoding of a post.

Methods inherited from class com.caucho.server.connection.AbstractHttpRequest

addCloseOnExit, addHeaderInt, allowKeepalive, authenticate, cleanup, complete, connectionClose, dbgId, findSessionIdFromConnection, finish, getConnection, getContentTypeBuffer, getCookie, getCookies, getDispatchServer, getHasCookie, getHeaderBuffer, getHeaderBuffers, getHeaderKey, getHeaderSize, getHeaderValue, getHost, getInvocation, getLoadedSession, getLocalAddr, getLocalName, getLocalPort, getLogBuffer, getLongContentLength, getMemorySession, getPageContextPath, getPagePathInfo, getPageQueryString, getPageServletPath, getPageURI, getRawInput, getRawReadBuffer, getRemoteUser, getRequestDepth, getRequestDepth, getRequestedSessionId, getRequestedSessionIdNoVary, getResponse, getServletContext, getServletName, getServletResponse, getSession, getSession, getSessionCookie, getSessionGroup, getSessionManager, getStartTime, getStream, getStream, getVaryCookie, getVaryCookies, getWebApp, handleResume, init, isIgnoreClientDisconnect, isInitial, isKeepalive, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isResumed, isSuspended, isTimeout, isTop, isTransportSecure, killKeepalive, logout, logoutUserPrincipal, printRemoteAddr, restartServer, resume, runAs, setHasCookie, setHeader, setInvocation, setStartTime, setVaryCookie, skip, start, startConnection, startResume, suspend, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StubServletRequest

public StubServletRequest()

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Description copied from class: AbstractHttpRequest

Returns the value of the named request attribute.

Specified by:

getAttribute in interface ServletRequest

Overrides:

getAttribute in class AbstractHttpRequest

Parameters:

name - the attribute name.

Returns:

the attribute value.

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Description copied from class: AbstractHttpRequest

Returns an enumeration of the request attribute names.

Specified by:

getAttributeNames in interface ServletRequest

Overrides:

getAttributeNames in class AbstractHttpRequest

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from class: AbstractHttpRequest

Sets the value of the named request attribute.

Specified by:

setAttribute in interface ServletRequest

Overrides:

setAttribute in class AbstractHttpRequest

Parameters:

name - the attribute name.

value - the new attribute value.

removeAttribute

public void removeAttribute(java.lang.String name)

Description copied from class: AbstractHttpRequest

Removes the value of the named request attribute.

Specified by:

removeAttribute in interface ServletRequest

Overrides:

removeAttribute in class AbstractHttpRequest

Parameters:

name - the attribute name.

initStream

public boolean initStream(ReadStream rawStream,
                          ReadStream realStream)

Description copied from class: AbstractHttpRequest

Initialize the read stream from the raw stream.

Specified by:

initStream in class AbstractHttpRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Description copied from class: AbstractHttpRequest

Returns the character encoding of a post.

Specified by:

getCharacterEncoding in interface ServletRequest

Overrides:

getCharacterEncoding in class AbstractHttpRequest

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)

Description copied from class: AbstractHttpRequest

Sets the character encoding of a post.

Specified by:

setCharacterEncoding in interface ServletRequest

Overrides:

setCharacterEncoding in class AbstractHttpRequest

getContentLength

public int getContentLength()

Description copied from class: AbstractHttpRequest

Returns the content length of a post.

Specified by:

getContentLength in interface ServletRequest

Overrides:

getContentLength in class AbstractHttpRequest

getContentType

public java.lang.String getContentType()

Description copied from class: AbstractHttpRequest

Returns the content-length of a post.

Specified by:

getContentType in interface ServletRequest

Overrides:

getContentType in class AbstractHttpRequest

getInputStream

public ServletInputStream getInputStream()

Description copied from class: AbstractHttpRequest

Returns a stream for reading POST data.

Specified by:

getInputStream in interface ServletRequest

Overrides:

getInputStream in class AbstractHttpRequest

getParameter

public java.lang.String getParameter(java.lang.String name)

Description copied from class: AbstractHttpRequest

Returns the form primary value for the given name.

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class AbstractHttpRequest

Parameters:

name - the form parameter to return

Returns:

the form value or null if none matches.

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

Description copied from class: AbstractHttpRequest

Returns an enumeration of the form names.

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class AbstractHttpRequest

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Description copied from class: AbstractHttpRequest

Returns the form's values for the given name.

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class AbstractHttpRequest

Parameters:

name - key in the form

Returns:

value matching the key

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Description copied from class: AbstractHttpRequest

Returns a map of the form.

Specified by:

getParameterMap in interface ServletRequest

Overrides:

getParameterMap in class AbstractHttpRequest

getProtocol

public java.lang.String getProtocol()

Description copied from interface: ServletRequest

Returns the prococol, e.g. "HTTP/1.1"

Specified by:

getProtocol in interface ServletRequest

Specified by:

getProtocol in class AbstractHttpRequest

getReader

public java.io.BufferedReader getReader()

Description copied from class: AbstractHttpRequest

Returns a Reader for the POST contents

Specified by:

getReader in interface ServletRequest

Overrides:

getReader in class AbstractHttpRequest

getRemoteAddr

public java.lang.String getRemoteAddr()

Description copied from interface: ServletRequest

Returns the IP address of the remote host, i.e. the client browser.

Specified by:

getRemoteAddr in interface ServletRequest

Overrides:

getRemoteAddr in class AbstractHttpRequest

getRemoteHost

public java.lang.String getRemoteHost()

Description copied from interface: ServletRequest

Returns the DNS hostname of the remote host, i.e. the client browser.

Specified by:

getRemoteHost in interface ServletRequest

Overrides:

getRemoteHost in class AbstractHttpRequest

getRemotePort

public int getRemotePort()

Description copied from class: AbstractHttpRequest

Returns the local port.

Specified by:

getRemotePort in interface ServletRequest

Overrides:

getRemotePort in class AbstractHttpRequest

getScheme

public java.lang.String getScheme()

Description copied from class: AbstractHttpRequest

Returns the request's scheme.

Specified by:

getScheme in interface ServletRequest

Overrides:

getScheme in class AbstractHttpRequest

getServerName

public java.lang.String getServerName()

Description copied from class: AbstractHttpRequest

Returns the local server name.

Specified by:

getServerName in interface ServletRequest

Overrides:

getServerName in class AbstractHttpRequest

getServerPort

public int getServerPort()

Description copied from class: AbstractHttpRequest

Returns the server's port.

Specified by:

getServerPort in interface ServletRequest

Overrides:

getServerPort in class AbstractHttpRequest

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Description copied from interface: ServletRequest

Returns the path of the URI.

Specified by:

getRealPath in interface ServletRequest

Overrides:

getRealPath in class AbstractHttpRequest

getLocale

public java.util.Locale getLocale()

Description copied from interface: ServletRequest

Returns the request's preferred locale, based on the Accept-Language header. If unspecified, returns the server's default locale.

Specified by:

getLocale in interface ServletRequest

Overrides:

getLocale in class AbstractHttpRequest

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

Description copied from interface: ServletRequest

Returns an enumeration of all locales acceptable by the client.

Specified by:

getLocales in interface ServletRequest

Overrides:

getLocales in class AbstractHttpRequest

isSecure

public boolean isSecure()

Description copied from class: AbstractHttpRequest

Returns true if the request is secure.

Specified by:

isSecure in interface ServletRequest

Overrides:

isSecure in class AbstractHttpRequest

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String uri)

Description copied from class: AbstractHttpRequest

Returns a request dispatcher relative to the current request.

Specified by:

getRequestDispatcher in interface ServletRequest

Overrides:

getRequestDispatcher in class AbstractHttpRequest

Parameters:

uri - the relative uri to the new servlet.

Returns:

RequestDispatcher for later inclusion or forwarding.

getMethod

public java.lang.String getMethod()

Description copied from interface: HttpServletRequest

Returns the HTTP method, e.g. "GET" or "POST"

Equivalent to CGI's REQUEST_METHOD

Specified by:

getMethod in interface HttpServletRequest

Specified by:

getMethod in class AbstractHttpRequest

getServletPath

public java.lang.String getServletPath()

Description copied from class: AbstractHttpRequest

Returns the portion of the uri mapped to the servlet for the original request.

Specified by:

getServletPath in interface HttpServletRequest

Overrides:

getServletPath in class AbstractHttpRequest

getContextPath

public java.lang.String getContextPath()

Description copied from class: AbstractHttpRequest

Returns the context part of the uri. The context part is the part that maps to an webApp.

Specified by:

getContextPath in interface HttpServletRequest

Overrides:

getContextPath in class AbstractHttpRequest

getPathInfo

public java.lang.String getPathInfo()

Description copied from class: AbstractHttpRequest

Returns the portion of the uri after the servlet path for the original request.

Specified by:

getPathInfo in interface HttpServletRequest

Overrides:

getPathInfo in class AbstractHttpRequest

getPathTranslated

public java.lang.String getPathTranslated()

Description copied from class: AbstractHttpRequest

Returns the real path of pathInfo.

Specified by:

getPathTranslated in interface HttpServletRequest

Overrides:

getPathTranslated in class AbstractHttpRequest

Returns:

null if there is no path info.

getRequestURI

public java.lang.String getRequestURI()

Description copied from class: AbstractHttpRequest

Returns the URI for the request

Specified by:

getRequestURI in interface HttpServletRequest

Overrides:

getRequestURI in class AbstractHttpRequest

getRequestURL

public java.lang.StringBuffer getRequestURL()

Description copied from class: AbstractHttpRequest

Returns the URL for the request

Specified by:

getRequestURL in interface HttpServletRequest

Overrides:

getRequestURL in class AbstractHttpRequest

getUriLength

public int getUriLength()

Specified by:

getUriLength in class AbstractHttpRequest

getUriBuffer

public byte[] getUriBuffer()

Specified by:

getUriBuffer in class AbstractHttpRequest

getQueryString

public java.lang.String getQueryString()

Description copied from class: AbstractHttpRequest

Returns the current page's query string.

Specified by:

getQueryString in interface HttpServletRequest

Overrides:

getQueryString in class AbstractHttpRequest

getHeader

public java.lang.String getHeader(java.lang.String header)

Description copied from class: AbstractHttpRequest

Returns the named header.

Specified by:

getHeader in interface HttpServletRequest

Specified by:

getHeader in class AbstractHttpRequest

Parameters:

header - the header key

Returns:

the header value

getIntHeader

public int getIntHeader(java.lang.String header)

Description copied from class: AbstractHttpRequest

Returns the named header, converted to an integer.

Specified by:

getIntHeader in interface HttpServletRequest

Overrides:

getIntHeader in class AbstractHttpRequest

Parameters:

header - the header key.

Returns:

the value of the header as an integer.

getDateHeader

public long getDateHeader(java.lang.String header)

Description copied from class: AbstractHttpRequest

Returns a header interpreted as a date.

Specified by:

getDateHeader in interface HttpServletRequest

Overrides:

getDateHeader in class AbstractHttpRequest

Parameters:

header - the header key.

Returns:

the value of the header as an integer.

getHeaders

public java.util.Enumeration getHeaders(java.lang.String header)

Description copied from class: AbstractHttpRequest

Returns an enumeration of the headers for the named attribute.

Specified by:

getHeaders in interface HttpServletRequest

Overrides:

getHeaders in class AbstractHttpRequest

Parameters:

header - the header name

Returns:

an enumeration of the header values.

getHeaderNames

public java.util.Enumeration<java.lang.String> getHeaderNames()

Description copied from class: AbstractHttpRequest

Enumerates the header keys

Specified by:

getHeaderNames in interface HttpServletRequest

Specified by:

getHeaderNames in class AbstractHttpRequest

getAuthType

public java.lang.String getAuthType()

Description copied from class: AbstractHttpRequest

Gets the authorization type

Specified by:

getAuthType in interface HttpServletRequest

Overrides:

getAuthType in class AbstractHttpRequest

getRemoteUser

public java.lang.String getRemoteUser()

Description copied from class: AbstractHttpRequest

Gets the remote user from the authorization type

Specified by:

getRemoteUser in interface HttpServletRequest

Overrides:

getRemoteUser in class AbstractHttpRequest

getUserPrincipal

public java.security.Principal getUserPrincipal()

Description copied from class: AbstractHttpRequest

Returns the Principal representing the logged in user.

Specified by:

getUserPrincipal in interface SecurityContextProvider

Specified by:

getUserPrincipal in interface HttpServletRequest

Overrides:

getUserPrincipal in class AbstractHttpRequest

Returns:

the principal in the context or null.

isUserInRole

public boolean isUserInRole(java.lang.String str)

Description copied from class: AbstractHttpRequest

Returns true if the user represented by the current request plays the named role.

Specified by:

isUserInRole in interface SecurityContextProvider

Specified by:

isUserInRole in interface HttpServletRequest

Overrides:

isUserInRole in class AbstractHttpRequest

Parameters:

str - the named role to test.

Returns:

true if the user plays the role.