DummyRequest (JBoss Web 8.0.0.Alpha1 API)

java.lang.Object
- org.apache.catalina.core.DummyRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class DummyRequest
extends Object
implements javax.servlet.http.HttpServletRequest
```
Dummy request object, used for request dispatcher mapping, as well as JSP precompilation.

Version:

$Revision: 1144 $ $Date: 2009-08-17 18:21:14 +0200 (Mon, 17 Aug 2009) $

Author:

Remy Maucherat

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`contextPath`
`protected String`	`decodedURI`
`protected javax.servlet.FilterChain`	`filterChain`
`protected String`	`pathInfo`
`protected String`	`queryString`
`protected String`	`servletPath`
`protected Wrapper`	`wrapper`

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

Constructor Summary

Constructors
Constructor and Description

DummyRequest()

DummyRequest(String contextPath, String decodedURI, String queryString)

Constructors
Constructor and Description
`DummyRequest()`
`DummyRequest(String contextPath, String decodedURI, String queryString)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAsyncListener(javax.servlet.AsyncListener listener)`
`void`	`addAsyncListener(javax.servlet.AsyncListener listener, javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`void`	`addCookie(javax.servlet.http.Cookie cookie)`
`void`	`addHeader(String name, String value)`
`void`	`addLocale(Locale locale)`
`void`	`addParameter(String name, String[] values)`
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`void`	`clearCookies()`
`void`	`clearHeaders()`
`void`	`clearLocales()`
`void`	`clearParameters()`
`javax.servlet.ServletInputStream`	`createInputStream()`
`void`	`finishRequest()`
`javax.servlet.AsyncContext`	`getAsyncContext()`
`long`	`getAsyncTimeout()`
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthorization()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`Connector`	`getConnector()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`Context`	`getContext()`
`String`	`getContextPath()`
`MessageBytes`	`getContextPathMB()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`String`	`getDecodedRequestURI()`
`MessageBytes`	`getDecodedRequestURIMB()`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`javax.servlet.FilterChain`	`getFilterChain()`
`String`	`getHeader(String name)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String name)`
`Host`	`getHost()`
`String`	`getInfo()`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`Object`	`getNote(String name)`
`Iterator`	`getNoteNames()`
`String`	`getParameter(String name)`
`Map`	`getParameterMap()`
`Enumeration`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`MessageBytes`	`getPathInfoMB()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.ServletRequest`	`getRequest()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`MessageBytes`	`getRequestPathMB()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`Response`	`getResponse()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`MessageBytes`	`getServletPathMB()`
`javax.servlet.ServletResponse`	`getServletResponse()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Socket`	`getSocket()`
`InputStream`	`getStream()`
`Principal`	`getUserPrincipal()`
`Wrapper`	`getWrapper()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String username, String password)`
`void`	`logout()`
`void`	`recycle()`
`void`	`removeAttribute(String name)`
`void`	`removeNote(String name)`
`void`	`setAsyncTimeout(long timeout)`
`void`	`setAttribute(String name, Object value)`
`void`	`setAuthorization(String authorization)`
`void`	`setAuthType(String authType)`
`void`	`setCharacterEncoding(String enc)`
`void`	`setConnector(Connector connector)`
`void`	`setContentLength(int length)`
`void`	`setContentType(String type)`
`void`	`setContext(Context context)`
`void`	`setContextPath(String path)`
`void`	`setDecodedRequestURI(String uri)`
`void`	`setFilterChain(javax.servlet.FilterChain filterChain)`
`void`	`setHost(Host host)`
`void`	`setMethod(String method)`
`void`	`setNote(String name, Object value)`
`void`	`setPathInfo(String path)`
`void`	`setProtocol(String protocol)`
`void`	`setQueryString(String query)`
`void`	`setRemoteAddr(String remoteAddr)`
`void`	`setRemoteHost(String remoteHost)`
`void`	`setRequestedSessionCookie(boolean flag)`
`void`	`setRequestedSessionId(String id)`
`void`	`setRequestedSessionURL(boolean flag)`
`void`	`setRequestURI(String uri)`
`void`	`setResponse(Response response)`
`void`	`setScheme(String scheme)`
`void`	`setSecure(boolean secure)`
`void`	`setServerName(String name)`
`void`	`setServerPort(int port)`
`void`	`setServletPath(String path)`
`void`	`setSocket(Socket socket)`
`void`	`setStream(InputStream input)`
`void`	`setUserPrincipal(Principal principal)`
`void`	`setWrapper(Wrapper wrapper)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> upgradeHandler)`

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

Field Detail

contextPath
```
protected String contextPath
```

decodedURI
```
protected String decodedURI
```

queryString
```
protected String queryString
```

pathInfo
```
protected String pathInfo
```

servletPath
```
protected String servletPath
```

wrapper
```
protected Wrapper wrapper
```

filterChain

protected javax.servlet.FilterChain filterChain

Constructor Detail

DummyRequest
```
public DummyRequest()
```

DummyRequest

public DummyRequest(String contextPath,
                    String decodedURI,
                    String queryString)

Method Detail

getContextPath
```
public String getContextPath()
```
Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

getContextPathMB

public MessageBytes getContextPathMB()

getRequest

public javax.servlet.ServletRequest getRequest()

getDecodedRequestURI
```
public String getDecodedRequestURI()
```

getDecodedRequestURIMB

public MessageBytes getDecodedRequestURIMB()

getFilterChain

public javax.servlet.FilterChain getFilterChain()

setFilterChain

public void setFilterChain(javax.servlet.FilterChain filterChain)

getQueryString
```
public String getQueryString()
```
Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

setQueryString

public void setQueryString(String query)

getPathInfo
```
public String getPathInfo()
```
Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

setPathInfo
```
public void setPathInfo(String path)
```

getPathInfoMB
```
public MessageBytes getPathInfoMB()
```

getRequestPathMB

public MessageBytes getRequestPathMB()

getServletPath
```
public String getServletPath()
```
Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

setServletPath

public void setServletPath(String path)

getServletPathMB

public MessageBytes getServletPathMB()

getWrapper
```
public Wrapper getWrapper()
```

setWrapper

public void setWrapper(Wrapper wrapper)

getAuthorization
```
public String getAuthorization()
```

setAuthorization

public void setAuthorization(String authorization)

getConnector
```
public Connector getConnector()
```

setConnector

public void setConnector(Connector connector)

getContext
```
public Context getContext()
```

setContext

public void setContext(Context context)

getHost
```
public Host getHost()
```

setHost
```
public void setHost(Host host)
```

getInfo
```
public String getInfo()
```

getResponse
```
public Response getResponse()
```

setResponse

public void setResponse(Response response)

getSocket
```
public Socket getSocket()
```

setSocket
```
public void setSocket(Socket socket)
```

getStream
```
public InputStream getStream()
```

setStream

public void setStream(InputStream input)

addLocale
```
public void addLocale(Locale locale)
```

createInputStream

public javax.servlet.ServletInputStream createInputStream()
                                                   throws IOException

Throws:: IOException

finishRequest

public void finishRequest()
                   throws IOException

Throws:: IOException

getNote
```
public Object getNote(String name)
```

getNoteNames
```
public Iterator getNoteNames()
```

removeNote
```
public void removeNote(String name)
```

setContentType

public void setContentType(String type)

setNote

public void setNote(String name,
                    Object value)

setProtocol

public void setProtocol(String protocol)

setRemoteAddr

public void setRemoteAddr(String remoteAddr)

setRemoteHost

public void setRemoteHost(String remoteHost)

setScheme
```
public void setScheme(String scheme)
```

setServerName

public void setServerName(String name)

setServerPort
```
public void setServerPort(int port)
```

getAttribute
```
public Object getAttribute(String name)
```
Specified by:

getAttribute in interface javax.servlet.ServletRequest

getAttributeNames
```
public Enumeration getAttributeNames()
```
Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

getCharacterEncoding
```
public String getCharacterEncoding()
```
Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

getContentLength
```
public int getContentLength()
```
Specified by:

getContentLength in interface javax.servlet.ServletRequest

setContentLength

public void setContentLength(int length)

getContentType
```
public String getContentType()
```
Specified by:

getContentType in interface javax.servlet.ServletRequest

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException

Specified by:: getInputStream in interface javax.servlet.ServletRequest
Throws:: IOException

getLocale
```
public Locale getLocale()
```
Specified by:

getLocale in interface javax.servlet.ServletRequest

getLocales
```
public Enumeration getLocales()
```
Specified by:

getLocales in interface javax.servlet.ServletRequest

getProtocol
```
public String getProtocol()
```
Specified by:

getProtocol in interface javax.servlet.ServletRequest

getReader
```
public BufferedReader getReader()
                         throws IOException
```
Specified by:

getReader in interface javax.servlet.ServletRequest

Throws:

IOException

getRealPath
```
public String getRealPath(String path)
```
Specified by:

getRealPath in interface javax.servlet.ServletRequest

getRemoteAddr
```
public String getRemoteAddr()
```
Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

getRemoteHost
```
public String getRemoteHost()
```
Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

getScheme
```
public String getScheme()
```
Specified by:

getScheme in interface javax.servlet.ServletRequest

getServerName
```
public String getServerName()
```
Specified by:

getServerName in interface javax.servlet.ServletRequest

getServerPort
```
public int getServerPort()
```
Specified by:

getServerPort in interface javax.servlet.ServletRequest

isSecure
```
public boolean isSecure()
```
Specified by:

isSecure in interface javax.servlet.ServletRequest

removeAttribute
```
public void removeAttribute(String name)
```
Specified by:

removeAttribute in interface javax.servlet.ServletRequest

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:: setAttribute in interface javax.servlet.ServletRequest

setCharacterEncoding
```
public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException
```
Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Throws:

UnsupportedEncodingException

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

addHeader

public void addHeader(String name,
                      String value)

addParameter

public void addParameter(String name,
                         String[] values)

clearCookies
```
public void clearCookies()
```

clearHeaders
```
public void clearHeaders()
```

clearLocales
```
public void clearLocales()
```

clearParameters
```
public void clearParameters()
```

recycle
```
public void recycle()
```

setAuthType

public void setAuthType(String authType)

setContextPath

public void setContextPath(String path)

setMethod
```
public void setMethod(String method)
```

setRequestedSessionCookie

public void setRequestedSessionCookie(boolean flag)

setRequestedSessionId

public void setRequestedSessionId(String id)

setRequestedSessionURL

public void setRequestedSessionURL(boolean flag)

setRequestURI

public void setRequestURI(String uri)

setSecure

public void setSecure(boolean secure)

setUserPrincipal

public void setUserPrincipal(Principal principal)

getParameter
```
public String getParameter(String name)
```
Specified by:

getParameter in interface javax.servlet.ServletRequest

getParameterMap
```
public Map getParameterMap()
```
Specified by:

getParameterMap in interface javax.servlet.ServletRequest

getParameterNames
```
public Enumeration getParameterNames()
```
Specified by:

getParameterNames in interface javax.servlet.ServletRequest

getParameterValues
```
public String[] getParameterValues(String name)
```
Specified by:

getParameterValues in interface javax.servlet.ServletRequest

getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

getAuthType
```
public String getAuthType()
```
Specified by:

getAuthType in interface javax.servlet.http.HttpServletRequest

getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
Specified by:

getCookies in interface javax.servlet.http.HttpServletRequest

getDateHeader
```
public long getDateHeader(String name)
```
Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

getHeader
```
public String getHeader(String name)
```
Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

getHeaders
```
public Enumeration getHeaders(String name)
```
Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

getHeaderNames
```
public Enumeration getHeaderNames()
```
Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

getIntHeader
```
public int getIntHeader(String name)
```
Specified by:

getIntHeader in interface javax.servlet.http.HttpServletRequest

getMethod
```
public String getMethod()
```
Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

getPathTranslated
```
public String getPathTranslated()
```
Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

getRemoteUser
```
public String getRemoteUser()
```
Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

getRequestedSessionId
```
public String getRequestedSessionId()
```
Specified by:

getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

getRequestURI
```
public String getRequestURI()
```
Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

setDecodedRequestURI

public void setDecodedRequestURI(String uri)

getRequestURL
```
public StringBuffer getRequestURL()
```
Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

getSession
```
public javax.servlet.http.HttpSession getSession()
```
Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
Specified by:

isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
Specified by:

isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
Specified by:

isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
Specified by:

isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

isUserInRole
```
public boolean isUserInRole(String role)
```
Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

getUserPrincipal
```
public Principal getUserPrincipal()
```
Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

getLocalAddr
```
public String getLocalAddr()
```
Specified by:

getLocalAddr in interface javax.servlet.ServletRequest

getLocalName
```
public String getLocalName()
```
Specified by:

getLocalName in interface javax.servlet.ServletRequest

getLocalPort
```
public int getLocalPort()
```
Specified by:

getLocalPort in interface javax.servlet.ServletRequest

getRemotePort
```
public int getRemotePort()
```
Specified by:

getRemotePort in interface javax.servlet.ServletRequest

addAsyncListener

public void addAsyncListener(javax.servlet.AsyncListener listener,
                             javax.servlet.ServletRequest servletRequest,
                             javax.servlet.ServletResponse servletResponse)

addAsyncListener

public void addAsyncListener(javax.servlet.AsyncListener listener)

getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
Specified by:

getAsyncContext in interface javax.servlet.ServletRequest

getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
Specified by:

getServletContext in interface javax.servlet.ServletRequest

isAsyncStarted
```
public boolean isAsyncStarted()
```
Specified by:

isAsyncStarted in interface javax.servlet.ServletRequest

isAsyncSupported
```
public boolean isAsyncSupported()
```
Specified by:

isAsyncSupported in interface javax.servlet.ServletRequest

setAsyncTimeout

public void setAsyncTimeout(long timeout)

startAsync

public javax.servlet.AsyncContext startAsync()
                                      throws IllegalStateException

Specified by:: startAsync in interface javax.servlet.ServletRequest
Throws:: IllegalStateException

startAsync

public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
                                      throws IllegalStateException

Specified by:: startAsync in interface javax.servlet.ServletRequest
Throws:: IllegalStateException

getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
Specified by:

getDispatcherType in interface javax.servlet.ServletRequest

getServletResponse

public javax.servlet.ServletResponse getServletResponse()

authenticate

public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException

Specified by:: authenticate in interface javax.servlet.http.HttpServletRequest
Throws:: IOException; javax.servlet.ServletException

login

public void login(String username,
                  String password)
           throws javax.servlet.ServletException

Specified by:: login in interface javax.servlet.http.HttpServletRequest
Throws:: javax.servlet.ServletException

logout
```
public void logout()
            throws javax.servlet.ServletException
```
Specified by:

logout in interface javax.servlet.http.HttpServletRequest

Throws:

javax.servlet.ServletException

getAsyncTimeout
```
public long getAsyncTimeout()
```

getPart

public javax.servlet.http.Part getPart(String name)
                                throws IllegalArgumentException

Specified by:: getPart in interface javax.servlet.http.HttpServletRequest
Throws:: IllegalArgumentException

getParts
```
public Collection<javax.servlet.http.Part> getParts()
```
Specified by:

getParts in interface javax.servlet.http.HttpServletRequest

getContentLengthLong
```
public long getContentLengthLong()
```
Specified by:

getContentLengthLong in interface javax.servlet.ServletRequest

changeSessionId
```
public String changeSessionId()
```
Specified by:

changeSessionId in interface javax.servlet.http.HttpServletRequest

upgrade

public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> upgradeHandler)
                                                            throws IOException

Specified by:: upgrade in interface javax.servlet.http.HttpServletRequest
Throws:: IOException

Class DummyRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

contextPath

decodedURI

queryString

pathInfo

servletPath

wrapper

filterChain

Constructor Detail

DummyRequest

DummyRequest

Method Detail

getContextPath

getContextPathMB

getRequest

getDecodedRequestURI

getDecodedRequestURIMB

getFilterChain

setFilterChain

getQueryString

setQueryString

getPathInfo

setPathInfo

getPathInfoMB

getRequestPathMB

getServletPath

setServletPath

getServletPathMB

getWrapper

setWrapper

getAuthorization

setAuthorization

getConnector

setConnector

getContext

setContext

getHost

setHost

getInfo

getResponse

setResponse

getSocket

setSocket

getStream

setStream

addLocale

createInputStream

finishRequest

getNote

getNoteNames

removeNote

setContentType

setNote

setProtocol

setRemoteAddr

setRemoteHost

setScheme

setServerName

setServerPort

getAttribute

getAttributeNames

getCharacterEncoding

getContentLength

setContentLength

getContentType

getInputStream

getLocale

getLocales

getProtocol

getReader

getRealPath

getRemoteAddr

getRemoteHost

getScheme