MockHttpServletRequest (Struts 1.3.10 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.mock
Class MockHttpServletRequest

java.lang.Object
  org.apache.struts.mock.MockHttpServletRequest

All Implemented Interfaces:: HttpServletRequest, ServletRequest

public class MockHttpServletRequest
extends Object
implements HttpServletRequest
extends Object
implements HttpServletRequest

Mock HttpServletRequest object for low-level unit tests of Struts controller components. Coarser grained tests should be implemented in terms of the Cactus framework, instead of the mock object classes.

WARNING - Only the minimal set of methods needed to create unit tests is provided, plus additional methods to configure this object as necessary. Methods for unsupported operations will throw UnsupportedOperationException.

WARNING - Because unit tests operate in a single threaded environment, no synchronization is performed.

Version:: $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $

Field Summary
`protected HashMap`	`attributes` The set of request attributes.
`protected String`	`contentType` The Content Type for this request.
`protected String`	`contextPath` The context path for this request.
`protected Locale`	`locale` The preferred locale for this request.
`protected String`	`method` The HTTP request method.
`protected HashMap`	`parameters` The set of arrays of parameter values, keyed by parameter name.
`protected String`	`pathInfo` The extra path information for this request.
`protected Principal`	`principal` The authenticated user for this request.
`protected String`	`queryString` The query string for this request.
`protected String`	`servletPath` The servlet path for this request.
`protected HttpSession`	`session` The HttpSession with which we are associated.

Fields inherited from interface javax.servlet.http.HttpServletRequest
`BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH`

Constructor Summary
`MockHttpServletRequest()`
`MockHttpServletRequest(HttpSession session)`
`MockHttpServletRequest(String contextPath, String servletPath, String pathInfo, String queryString)`
`MockHttpServletRequest(String contextPath, String servletPath, String pathInfo, String queryString, HttpSession session)`

Method Summary
`void`	`addParameter(String name, String value)`
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`String`	`getHeader(String name)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String name)`
`ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`Locale`	`getLocale()`
`Enumeration`	`getLocales()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map`	`getParameterMap()`
`Enumeration`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`String`	`getRemoteUser()`
`RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`String`	`getServletPath()`
`HttpSession`	`getSession()`
`HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setCharacterEncoding(String name)`
`void`	`setContentType(String contentType)`
`void`	`setHttpSession(HttpSession session)`
`void`	`setLocale(Locale locale)`
`void`	`setMethod(String method)`
`void`	`setPathElements(String contextPath, String servletPath, String pathInfo, String queryString)`
`void`	`setUserPrincipal(Principal principal)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

attributes

protected HashMap attributes

The set of request attributes.

contextPath

protected String contextPath

The context path for this request.

locale

protected Locale locale

The preferred locale for this request.

parameters

protected HashMap parameters

The set of arrays of parameter values, keyed by parameter name.

pathInfo

protected String pathInfo

The extra path information for this request. v *

principal

protected Principal principal

The authenticated user for this request.

queryString

protected String queryString

The query string for this request.

servletPath

protected String servletPath

The servlet path for this request.

session

protected HttpSession session

The HttpSession with which we are associated.

method

protected String method

The HTTP request method.

contentType

protected String contentType

The Content Type for this request.

Constructor Detail