org.chwf.servlet.mock
Class MockServletRequest

java.lang.Object
  |
  +--org.chwf.servlet.mock.MockServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class MockServletRequest

extends java.lang.Object

implements javax.servlet.http.HttpServletRequest

Mock servlet request.

Author:

Paul Strack

Field Summary

static java.lang.String	DEFAULT_CONTEXT_PATH Default context path: "/context"
static int	DEFAULT_PORT Default Server port
static java.lang.String	DEFAULT_REQUEST_URI Default request uri: "/requestURI"

Constructor Summary

MockServletRequest()
Constructor

Method Summary

void	addHeader(java.lang.String name, java.lang.String value) MOCK METHOD: Add a header.
void	addParameter(java.lang.String name, java.lang.String value) MOCK METHOD: Add a parameter.
void	addUserRole(java.lang.String role) MOCK METHOD: Add a user role.
java.lang.Object	getAttribute(java.lang.String name) Attribute
java.util.Enumeration	getAttributeNames() Attribute names.
java.lang.String	getAuthType() Set by setAuthType()
java.lang.String	getCharacterEncoding() Unsupported.
int	getContentLength() Unsupported.
java.lang.String	getContentType() Unsupported.
java.lang.String	getContextPath() Set by setContexPath() or "/context"
javax.servlet.http.Cookie[]	getCookies() Unsupported.
long	getDateHeader(java.lang.String name) Unsupported.
java.lang.String	getHeader(java.lang.String name) Set by setHeader()
java.util.Enumeration	getHeaderNames() Unsupported
java.util.Enumeration	getHeaders(java.lang.String name) Unsupported.
javax.servlet.ServletInputStream	getInputStream() Unsupported.
int	getIntHeader(java.lang.String name) Unsupported
java.util.Locale	getLocale() Unsupported
java.util.Enumeration	getLocales() Unsupported
java.lang.String	getMethod() Unsupported.
MockRequestDispatcher	getMockRequestDispatcher() MOCK METHOD: Get the mock request dispatcher created by getRequestDispatcher().
java.lang.String	getParameter(java.lang.String name) From addParameter()
java.util.Map	getParameterMap() From addParameter()
java.util.Enumeration	getParameterNames() From addParameter()
java.lang.String[]	getParameterValues(java.lang.String name) From addParameter() (same name more than once)
java.lang.String	getPathInfo() Unsupported
java.lang.String	getPathTranslated() Unsupported
java.lang.String	getProtocol() Unsupported
java.lang.String	getQueryString() Unsupported.
java.io.BufferedReader	getReader() Unsupported
java.lang.String	getRealPath(java.lang.String arg0) Deprecated.
java.lang.String	getRemoteAddr() Unsupported
java.lang.String	getRemoteHost() Unsupported
java.lang.String	getRemoteUser() Set by setRemoteUser()
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String uri) MockRequestDispatcher, or null if masked.
java.lang.String	getRequestedSessionId() Unsupported.
java.lang.String	getRequestURI() As setRequestURI() or "/requestURI"
java.lang.StringBuffer	getRequestURL() Unsupported.
java.lang.String	getScheme() Returns "http" or "https" depending on setSecure(boolean).
java.lang.String	getServerName() Returns "host"
int	getServerPort() Returns 80.
java.lang.String	getServletPath() As setServletPath()
javax.servlet.http.HttpSession	getSession() MockSession
javax.servlet.http.HttpSession	getSession(boolean arg0) MockSession
java.security.Principal	getUserPrincipal() Unsupported.
boolean	isRequestedSessionIdFromCookie() Unsupported.
boolean	isRequestedSessionIdFromUrl() Deprecated.
boolean	isRequestedSessionIdFromURL() Unsupported.
boolean	isRequestedSessionIdValid() Unsupported
boolean	isSecure() Return value of setSecure().
boolean	isUserInRole(java.lang.String role) As per addRole()
void	maskDispatcher(java.lang.String uri) MOCK METHOD: Mask a dispatcher (so that getRequestDispatcher() returns null).
void	removeAttribute(java.lang.String name) Remove attribute
void	setAttribute(java.lang.String name, java.lang.Object value) Set attribute
void	setAuthType(java.lang.String value) MOCK METHOD: Set the auth type.
void	setCharacterEncoding(java.lang.String arg0) Unsupported.
void	setContextPath(java.lang.String path) MOCK METHOD: Set the context path.
void	setRemoteUser(java.lang.String value) MOCK METHOD: Set the remote user.
void	setRequestURI(java.lang.String uri) MOCK METHOD: Set the request URI.
void	setSecure(boolean secure) MOCK METHOD: Set secure (SSL encryption).
void	setServletPath(java.lang.String path) MOCK METHOD: Set the servlet path.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Default Server port

DEFAULT_REQUEST_URI

public static final java.lang.String DEFAULT_REQUEST_URI

Default request uri: "/requestURI"

DEFAULT_CONTEXT_PATH

public static final java.lang.String DEFAULT_CONTEXT_PATH

Default context path: "/context"

Constructor Detail

MockServletRequest

public MockServletRequest()

Constructor

Method Detail

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

MOCK METHOD: Add a parameter.

Parameters:

name - name

value - value

setContextPath

public void setContextPath(java.lang.String path)

MOCK METHOD: Set the context path.

Parameters:

path - context path

setRequestURI

public void setRequestURI(java.lang.String uri)

MOCK METHOD: Set the request URI.

Parameters:

uri - uri

setServletPath

public void setServletPath(java.lang.String path)

MOCK METHOD: Set the servlet path.

Parameters:

path - path

getMockRequestDispatcher

public MockRequestDispatcher getMockRequestDispatcher()

MOCK METHOD: Get the mock request dispatcher created by getRequestDispatcher().

Returns:

The mock dispatcher.

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

MOCK METHOD: Add a header.

Parameters:

name - name

value - value

maskDispatcher

public void maskDispatcher(java.lang.String uri)

MOCK METHOD: Mask a dispatcher (so that getRequestDispatcher() returns null).

Parameters:

uri - Mask uri

setAuthType

public void setAuthType(java.lang.String value)

MOCK METHOD: Set the auth type.

Parameters:

value - value

setRemoteUser

public void setRemoteUser(java.lang.String value)

MOCK METHOD: Set the remote user.

Parameters:

value - value

addUserRole

public void addUserRole(java.lang.String role)

MOCK METHOD: Add a user role.

Parameters:

role - role

setSecure

public void setSecure(boolean secure)

MOCK METHOD: Set secure (SSL encryption).

Parameters:

secure - Whether SSL or not

getAuthType

public java.lang.String getAuthType()

Set by setAuthType()

Specified by:

getAuthType in interface javax.servlet.http.HttpServletRequest

Returns:

auth type

See Also:

HttpServletRequest.getAuthType()

getCookies

public javax.servlet.http.Cookie[] getCookies()

Unsupported.

Specified by:

getCookies in interface javax.servlet.http.HttpServletRequest

Returns:

cookies

See Also:

HttpServletRequest.getCookies()

getDateHeader

public long getDateHeader(java.lang.String name)

Unsupported.

Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

Parameters:

name - name

Returns:

header

See Also:

HttpServletRequest.getDateHeader(String)

getHeader

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

Set by setHeader()

Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

Parameters:

name - name

Returns:

header

See Also:

HttpServletRequest.getHeader(String)

getHeaders

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

Unsupported.

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

Parameters:

name - name

Returns:

headers

See Also:

HttpServletRequest.getHeaders(String)

getHeaderNames

public java.util.Enumeration getHeaderNames()

Unsupported

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

Returns:

header name

See Also:

HttpServletRequest.getHeaderNames()

getIntHeader

public int getIntHeader(java.lang.String name)

Unsupported

Specified by:

getIntHeader in interface javax.servlet.http.HttpServletRequest

Parameters:

name - name

Returns:

header

See Also:

HttpServletRequest.getIntHeader(String)

getMethod

public java.lang.String getMethod()

Unsupported.

Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

Returns:

method

See Also:

HttpServletRequest.getMethod()

getPathInfo

public java.lang.String getPathInfo()

Unsupported

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

Returns:

path info

See Also:

HttpServletRequest.getPathInfo()

getPathTranslated

public java.lang.String getPathTranslated()

Unsupported

Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

Returns:

path translated

See Also:

HttpServletRequest.getPathTranslated()

getContextPath

public java.lang.String getContextPath()

Set by setContexPath() or "/context"

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

Returns:

context path

See Also:

HttpServletRequest.getContextPath()

getQueryString

public java.lang.String getQueryString()

Unsupported.

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

Returns:

query string

See Also:

HttpServletRequest.getQueryString()

getRemoteUser

public java.lang.String getRemoteUser()

Set by setRemoteUser()

Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

Returns:

remote user

See Also:

HttpServletRequest.getRemoteUser()

isUserInRole

public boolean isUserInRole(java.lang.String role)

As per addRole()

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

Parameters:

role - role

Returns:

If role set.

See Also:

HttpServletRequest.isUserInRole(String)

getUserPrincipal

public java.security.Principal getUserPrincipal()

Unsupported.

Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

Returns:

principal

See Also:

HttpServletRequest.getUserPrincipal()

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Unsupported.

Specified by:

getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

Returns:

session id

See Also:

HttpServletRequest.getRequestedSessionId()

getRequestURI

public java.lang.String getRequestURI()

As setRequestURI() or "/requestURI"

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

See Also:

HttpServletRequest.getRequestURI()

getRequestURL

public java.lang.StringBuffer getRequestURL()

Unsupported.

Returns:

request URL

See Also:

HttpServletRequest

getServletPath

public java.lang.String getServletPath()

As setServletPath()

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

Returns:

servlet path

See Also:

HttpServletRequest.getServletPath()

getSession

public javax.servlet.http.HttpSession getSession(boolean arg0)

MockSession

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Parameters:

arg0 - arg0

Returns:

session

See Also:

HttpServletRequest.getSession(boolean)

getSession

public javax.servlet.http.HttpSession getSession()

MockSession

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Returns:

session

See Also:

HttpServletRequest.getSession()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Unsupported

Specified by:

isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

Returns:

is valid

See Also:

HttpServletRequest.isRequestedSessionIdValid()

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Unsupported.

Specified by:

isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

Returns:

from cookie

See Also:

HttpServletRequest.isRequestedSessionIdFromCookie()

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Unsupported.

Specified by:

isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

Returns:

from URL

See Also:

HttpServletRequest.isRequestedSessionIdFromURL()

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Deprecated.

Unsupported.

Specified by:

isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

Returns:

from URL

See Also:

HttpServletRequest.isRequestedSessionIdFromUrl()

getAttribute

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

Attribute

Specified by:

getAttribute in interface javax.servlet.ServletRequest

Parameters:

name - name

Returns:

value

See Also:

ServletRequest.getAttribute(String)

getAttributeNames

public java.util.Enumeration getAttributeNames()

Attribute names.

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

Returns:

names

See Also:

ServletRequest.getAttributeNames()

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Unsupported.

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

Returns:

encoding

See Also:

ServletRequest.getCharacterEncoding()

setCharacterEncoding

public void setCharacterEncoding(java.lang.String arg0)

Unsupported.

Parameters:

arg0 - arg0

See Also:

ServletRequest

getContentLength

public int getContentLength()

Unsupported.

Specified by:

getContentLength in interface javax.servlet.ServletRequest

Returns:

length

See Also:

ServletRequest.getContentLength()

getContentType

public java.lang.String getContentType()

Unsupported.

Specified by:

getContentType in interface javax.servlet.ServletRequest

Returns:

type

See Also:

ServletRequest.getContentType()

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Unsupported.

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Returns:

stream

Throws:

java.io.IOException - error

See Also:

ServletRequest.getInputStream()

getParameter

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

From addParameter()

Specified by:

getParameter in interface javax.servlet.ServletRequest

Parameters:

name - name

Returns:

value

See Also:

ServletRequest.getParameter(String)

getParameterNames

public java.util.Enumeration getParameterNames()

From addParameter()

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

Returns:

names

See Also:

ServletRequest.getParameterNames()

getParameterValues

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

From addParameter() (same name more than once)

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

Parameters:

name - name

Returns:

values

See Also:

ServletRequest.getParameterValues(String)

getParameterMap

public java.util.Map getParameterMap()

From addParameter()

Returns:

map

See Also:

ServletRequest

getProtocol

public java.lang.String getProtocol()

Unsupported

Specified by:

getProtocol in interface javax.servlet.ServletRequest

Returns:

protocol

See Also:

ServletRequest.getProtocol()

getScheme

public java.lang.String getScheme()

Returns "http" or "https" depending on setSecure(boolean).

Specified by:

getScheme in interface javax.servlet.ServletRequest

Returns:

scheme

See Also:

ServletRequest.getScheme()

getServerName

public java.lang.String getServerName()

Returns "host"

Specified by:

getServerName in interface javax.servlet.ServletRequest

Returns:

server name

See Also:

ServletRequest.getServerName()

getServerPort

public int getServerPort()

Returns 80.

Specified by:

getServerPort in interface javax.servlet.ServletRequest

Returns:

server port

See Also:

ServletRequest.getServerPort()

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Unsupported

Specified by:

getReader in interface javax.servlet.ServletRequest

Returns:

reader

Throws:

java.io.IOException - error

See Also:

ServletRequest.getReader()

getRemoteAddr

public java.lang.String getRemoteAddr()

Unsupported

Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

Returns:

address

See Also:

ServletRequest.getRemoteAddr()

getRemoteHost

public java.lang.String getRemoteHost()

Unsupported

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

Returns:

host

See Also:

ServletRequest.getRemoteHost()

setAttribute

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

Set attribute

Specified by:

setAttribute in interface javax.servlet.ServletRequest

Parameters:

name - name

value - value

See Also:

ServletRequest.setAttribute(String, Object)

removeAttribute

public void removeAttribute(java.lang.String name)

Remove attribute

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

Parameters:

name - name

See Also:

ServletRequest.removeAttribute(String)

getLocale

public java.util.Locale getLocale()

Unsupported

Specified by:

getLocale in interface javax.servlet.ServletRequest

Returns:

locale

See Also:

ServletRequest.getLocale()

getLocales

public java.util.Enumeration getLocales()

Unsupported

Specified by:

getLocales in interface javax.servlet.ServletRequest

Returns:

locales

See Also:

ServletRequest.getLocales()

isSecure

public boolean isSecure()

Return value of setSecure().

Specified by:

isSecure in interface javax.servlet.ServletRequest

Returns:

secure

See Also:

ServletRequest.isSecure()

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String uri)

MockRequestDispatcher, or null if masked. Multiple calls return the same dispatcher object [so you can check MockRequestDispatcher.getUri()]

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

Parameters:

uri - uri

Returns:

dispatcher

See Also:

ServletRequest.getRequestDispatcher(String)

getRealPath

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

Deprecated.

Unsupported

Specified by:

getRealPath in interface javax.servlet.ServletRequest

Parameters:

arg0 - arg0

Returns:

real path

See Also:

ServletRequest.getRealPath(String)