All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.mock.web.MockHttpServletRequest Maven / Gradle / Ivy

There is a newer version: 5.3.39
Show newest version
/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.mock.web;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.security.Principal;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.Vector;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletInputStream;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import org.springframework.core.CollectionFactory;
import org.springframework.util.Assert;

/**
 * Mock implementation of the {@link javax.servlet.http.HttpServletRequest}
 * interface. Supports the Servlet 2.4 API level.
 *
 * 

Used for testing the web framework; also useful for testing * application controllers. * * @author Juergen Hoeller * @author Rod Johnson * @author Rick Evans * @since 1.0.2 */ public class MockHttpServletRequest implements HttpServletRequest { /** * The default protocol: 'http'. */ public static final String DEFAULT_PROTOCOL = "http"; /** * The default server address: '127.0.0.1'. */ public static final String DEFAULT_SERVER_ADDR = "127.0.0.1"; /** * The default server name: 'localhost'. */ public static final String DEFAULT_SERVER_NAME = "localhost"; /** * The default server port: '80'. */ public static final int DEFAULT_SERVER_PORT = 80; /** * The default remote address: '127.0.0.1'. */ public static final String DEFAULT_REMOTE_ADDR = "127.0.0.1"; /** * The default remote host: 'localhost'. */ public static final String DEFAULT_REMOTE_HOST = "localhost"; private boolean active = true; //--------------------------------------------------------------------- // ServletRequest properties //--------------------------------------------------------------------- private final Hashtable attributes = new Hashtable(); private String characterEncoding; private byte[] content; private String contentType; private final Map parameters = CollectionFactory.createLinkedMapIfPossible(16); private String protocol = DEFAULT_PROTOCOL; private String scheme = DEFAULT_PROTOCOL; private String serverName = DEFAULT_SERVER_NAME; private int serverPort = DEFAULT_SERVER_PORT; private String remoteAddr = DEFAULT_REMOTE_ADDR; private String remoteHost = DEFAULT_REMOTE_HOST; /** List of locales in descending order */ private final Vector locales = new Vector(); private boolean secure = false; private final ServletContext servletContext; private int remotePort = DEFAULT_SERVER_PORT; private String localName = DEFAULT_SERVER_NAME; private String localAddr = DEFAULT_SERVER_ADDR; private int localPort = DEFAULT_SERVER_PORT; //--------------------------------------------------------------------- // HttpServletRequest properties //--------------------------------------------------------------------- private String authType; private Cookie[] cookies; /** * The key is the lowercase header name; the value is a {@link HeaderValueHolder} object. */ private final Hashtable headers = new Hashtable(); private String method; private String pathInfo; private String contextPath = ""; private String queryString; private String remoteUser; private final Set userRoles = new HashSet(); private Principal userPrincipal; private String requestURI; private String servletPath = ""; private HttpSession session; private boolean requestedSessionIdValid = true; private boolean requestedSessionIdFromCookie = true; private boolean requestedSessionIdFromURL = false; //--------------------------------------------------------------------- // Constructors //--------------------------------------------------------------------- /** * Create a new MockHttpServletRequest with a default * {@link MockServletContext}. * @see MockServletContext */ public MockHttpServletRequest() { this(null, "", ""); } /** * Create a new MockHttpServletRequest with a default * {@link MockServletContext}. * @param method the request method (may be null) * @param requestURI the request URI (may be null) * @see #setMethod * @see #setRequestURI * @see MockServletContext */ public MockHttpServletRequest(String method, String requestURI) { this(null, method, requestURI); } /** * Create a new MockHttpServletRequest. * @param servletContext the ServletContext that the request runs in * (may be null to use a default MockServletContext) * @see MockServletContext */ public MockHttpServletRequest(ServletContext servletContext) { this(servletContext, "", ""); } /** * Create a new MockHttpServletRequest. * @param servletContext the ServletContext that the request runs in * (may be null to use a default MockServletContext) * @param method the request method (may be null) * @param requestURI the request URI (may be null) * @see #setMethod * @see #setRequestURI * @see MockServletContext */ public MockHttpServletRequest(ServletContext servletContext, String method, String requestURI) { this.servletContext = (servletContext != null ? servletContext : new MockServletContext()); this.method = method; this.requestURI = requestURI; this.locales.add(Locale.ENGLISH); } //--------------------------------------------------------------------- // Lifecycle methods //--------------------------------------------------------------------- /** * Return whether this request is still active (that is, not completed yet). */ public boolean isActive() { return this.active; } /** * Mark this request as completed, keeping its state. */ public void close() { this.active = false; } /** * Invalidate this request, clearing its state. */ public void invalidate() { close(); clearAttributes(); } /** * Check whether this request is still active (that is, not completed yet), * throwing an IllegalStateException if not active anymore. */ protected void checkActive() throws IllegalStateException { if (!this.active) { throw new IllegalStateException("Request is not active anymore"); } } //--------------------------------------------------------------------- // ServletRequest interface //--------------------------------------------------------------------- public Object getAttribute(String name) { checkActive(); return this.attributes.get(name); } public Enumeration getAttributeNames() { checkActive(); return this.attributes.keys(); } public String getCharacterEncoding() { return this.characterEncoding; } public void setCharacterEncoding(String characterEncoding) { this.characterEncoding = characterEncoding; } public void setContent(byte[] content) { this.content = content; } public int getContentLength() { return (this.content != null ? this.content.length : -1); } public void setContentType(String contentType) { this.contentType = contentType; } public String getContentType() { return this.contentType; } public ServletInputStream getInputStream() { if (this.content != null) { return new DelegatingServletInputStream(new ByteArrayInputStream(this.content)); } else { return null; } } /** * Set a single value for the specified HTTP parameter. *

If there are already one or more values registered for the given * parameter name, they will be replaced. */ public void setParameter(String name, String value) { setParameter(name, new String[] {value}); } /** * Set an array of values for the specified HTTP parameter. *

If there are already one or more values registered for the given * parameter name, they will be replaced. */ public void setParameter(String name, String[] values) { Assert.notNull(name, "Parameter name must not be null"); this.parameters.put(name, values); } /** * Add a single value for the specified HTTP parameter. *

If there are already one or more values registered for the given * parameter name, the given value will be added to the end of the list. */ public void addParameter(String name, String value) { addParameter(name, new String[] {value}); } /** * Add an array of values for the specified HTTP parameter. *

If there are already one or more values registered for the given * parameter name, the given values will be added to the end of the list. */ public void addParameter(String name, String[] values) { Assert.notNull(name, "Parameter name must not be null"); String[] oldArr = (String[]) this.parameters.get(name); if (oldArr != null) { String[] newArr = new String[oldArr.length + values.length]; System.arraycopy(oldArr, 0, newArr, 0, oldArr.length); System.arraycopy(values, 0, newArr, oldArr.length, values.length); this.parameters.put(name, newArr); } else { this.parameters.put(name, values); } } /** * Remove already registered values for the specified HTTP parameter, if any. */ public void removeParameter(String name) { Assert.notNull(name, "Parameter name must not be null"); this.parameters.remove(name); } public String getParameter(String name) { Assert.notNull(name, "Parameter name must not be null"); String[] arr = (String[]) this.parameters.get(name); return (arr != null && arr.length > 0 ? arr[0] : null); } public Enumeration getParameterNames() { return Collections.enumeration(this.parameters.keySet()); } public String[] getParameterValues(String name) { Assert.notNull(name, "Parameter name must not be null"); return (String[]) this.parameters.get(name); } public Map getParameterMap() { return Collections.unmodifiableMap(this.parameters); } public void setProtocol(String protocol) { this.protocol = protocol; } public String getProtocol() { return this.protocol; } public void setScheme(String scheme) { this.scheme = scheme; } public String getScheme() { return this.scheme; } public void setServerName(String serverName) { this.serverName = serverName; } public String getServerName() { return this.serverName; } public void setServerPort(int serverPort) { this.serverPort = serverPort; } public int getServerPort() { return this.serverPort; } public BufferedReader getReader() throws UnsupportedEncodingException { if (this.content != null) { InputStream sourceStream = new ByteArrayInputStream(this.content); Reader sourceReader = (this.characterEncoding != null) ? new InputStreamReader(sourceStream, this.characterEncoding) : new InputStreamReader(sourceStream); return new BufferedReader(sourceReader); } else { return null; } } public void setRemoteAddr(String remoteAddr) { this.remoteAddr = remoteAddr; } public String getRemoteAddr() { return this.remoteAddr; } public void setRemoteHost(String remoteHost) { this.remoteHost = remoteHost; } public String getRemoteHost() { return this.remoteHost; } public void setAttribute(String name, Object value) { checkActive(); Assert.notNull(name, "Attribute name must not be null"); if (value != null) { this.attributes.put(name, value); } else { this.attributes.remove(name); } } public void removeAttribute(String name) { checkActive(); Assert.notNull(name, "Attribute name must not be null"); this.attributes.remove(name); } /** * Clear all of this request's attributes. */ public void clearAttributes() { this.attributes.clear(); } /** * Add a new preferred locale, before any existing locales. */ public void addPreferredLocale(Locale locale) { Assert.notNull(locale, "Locale must not be null"); this.locales.add(0, locale); } public Locale getLocale() { return (Locale) this.locales.get(0); } public Enumeration getLocales() { return this.locales.elements(); } public void setSecure(boolean secure) { this.secure = secure; } public boolean isSecure() { return this.secure; } public RequestDispatcher getRequestDispatcher(String path) { return new MockRequestDispatcher(path); } public String getRealPath(String path) { return this.servletContext.getRealPath(path); } public void setRemotePort(int remotePort) { this.remotePort = remotePort; } public int getRemotePort() { return this.remotePort; } public void setLocalName(String localName) { this.localName = localName; } public String getLocalName() { return this.localName; } public void setLocalAddr(String localAddr) { this.localAddr = localAddr; } public String getLocalAddr() { return this.localAddr; } public void setLocalPort(int localPort) { this.localPort = localPort; } public int getLocalPort() { return this.localPort; } //--------------------------------------------------------------------- // HttpServletRequest interface //--------------------------------------------------------------------- public void setAuthType(String authType) { this.authType = authType; } public String getAuthType() { return this.authType; } public void setCookies(Cookie[] cookies) { this.cookies = cookies; } public Cookie[] getCookies() { return this.cookies; } /** * Add a header entry for the given name. *

If there was no entry for that header name before, * the value will be used as-is. In case of an existing entry, * a String array will be created, adding the given value (more * specifically, its toString representation) as further element. *

Multiple values can only be stored as list of Strings, * following the Servlet spec (see getHeaders accessor). * As alternative to repeated addHeader calls for * individual elements, you can use a single call with an entire * array or Collection of values as parameter. * @see #getHeaderNames * @see #getHeader * @see #getHeaders * @see #getDateHeader * @see #getIntHeader */ public void addHeader(String name, Object value) { HeaderValueHolder header = HeaderValueHolder.getByName(this.headers, name); Assert.notNull(value, "Header value must not be null"); if (header == null) { header = new HeaderValueHolder(); this.headers.put(name, header); } if (value instanceof Collection) { header.addValues((Collection) value); } else if (value.getClass().isArray()) { header.addValueArray(value); } else { header.addValue(value); } } public long getDateHeader(String name) { HeaderValueHolder header = HeaderValueHolder.getByName(this.headers, name); Object value = (header != null ? header.getValue() : null); if (value instanceof Date) { return ((Date) value).getTime(); } else if (value instanceof Number) { return ((Number) value).longValue(); } else if (value != null) { throw new IllegalArgumentException( "Value for header '" + name + "' is neither a Date nor a Number: " + value); } else { return -1L; } } public String getHeader(String name) { HeaderValueHolder header = HeaderValueHolder.getByName(this.headers, name); return (header != null ? header.getValue().toString() : null); } public Enumeration getHeaders(String name) { HeaderValueHolder header = HeaderValueHolder.getByName(this.headers, name); return Collections.enumeration(header != null ? header.getValues() : Collections.EMPTY_LIST); } public Enumeration getHeaderNames() { return this.headers.keys(); } public int getIntHeader(String name) { HeaderValueHolder header = HeaderValueHolder.getByName(this.headers, name); Object value = (header != null ? header.getValue() : null); if (value instanceof Number) { return ((Number) value).intValue(); } else if (value instanceof String) { return Integer.parseInt((String) value); } else if (value != null) { throw new NumberFormatException("Value for header '" + name + "' is not a Number: " + value); } else { return -1; } } public void setMethod(String method) { this.method = method; } public String getMethod() { return this.method; } public void setPathInfo(String pathInfo) { this.pathInfo = pathInfo; } public String getPathInfo() { return this.pathInfo; } public String getPathTranslated() { return (this.pathInfo != null ? getRealPath(this.pathInfo) : null); } public void setContextPath(String contextPath) { this.contextPath = contextPath; } public String getContextPath() { return this.contextPath; } public void setQueryString(String queryString) { this.queryString = queryString; } public String getQueryString() { return this.queryString; } public void setRemoteUser(String remoteUser) { this.remoteUser = remoteUser; } public String getRemoteUser() { return this.remoteUser; } /** * @deprecated in favor of addUserRole * @see #addUserRole */ public void addRole(String role) { addUserRole(role); } public void addUserRole(String role) { this.userRoles.add(role); } public boolean isUserInRole(String role) { return this.userRoles.contains(role); } public void setUserPrincipal(Principal userPrincipal) { this.userPrincipal = userPrincipal; } public Principal getUserPrincipal() { return this.userPrincipal; } public String getRequestedSessionId() { HttpSession session = getSession(); return (session != null ? session.getId() : null); } public void setRequestURI(String requestURI) { this.requestURI = requestURI; } public String getRequestURI() { return this.requestURI; } public StringBuffer getRequestURL() { StringBuffer url = new StringBuffer(this.scheme); url.append("://").append(this.serverName).append(':').append(this.serverPort); url.append(getRequestURI()); return url; } public void setServletPath(String servletPath) { this.servletPath = servletPath; } public String getServletPath() { return this.servletPath; } public void setSession(HttpSession session) { this.session = session; if (session instanceof MockHttpSession) { MockHttpSession mockSession = ((MockHttpSession) session); mockSession.access(); } } public HttpSession getSession(boolean create) { checkActive(); // Reset session if invalidated. if (this.session instanceof MockHttpSession && ((MockHttpSession) this.session).isInvalid()) { this.session = null; } // Create new session if necessary. if (this.session == null && create) { this.session = new MockHttpSession(this.servletContext); } return this.session; } public HttpSession getSession() { return getSession(true); } public void setRequestedSessionIdValid(boolean requestedSessionIdValid) { this.requestedSessionIdValid = requestedSessionIdValid; } public boolean isRequestedSessionIdValid() { return this.requestedSessionIdValid; } public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie) { this.requestedSessionIdFromCookie = requestedSessionIdFromCookie; } public boolean isRequestedSessionIdFromCookie() { return this.requestedSessionIdFromCookie; } public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL) { this.requestedSessionIdFromURL = requestedSessionIdFromURL; } public boolean isRequestedSessionIdFromURL() { return this.requestedSessionIdFromURL; } public boolean isRequestedSessionIdFromUrl() { return isRequestedSessionIdFromURL(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy