Package org.vx68k.bitbucket.stub

Class StubHttpServletRequest

java.lang.Object

org.vx68k.bitbucket.stub.StubServletRequest

org.vx68k.bitbucket.stub.StubHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class StubHttpServletRequest
extends StubServletRequest
implements HttpServletRequest

Stub implementation of HttpServletRequest.

Since:

5.0

Author:

Kaz Nishimura

Field Summary

Fields inherited from class org.vx68k.bitbucket.stub.StubServletRequest

HTTP_PORT, HTTPS_PORT

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
StubHttpServletRequest(ServletContext context)	Constructs this object with a ServletContext object.
StubHttpServletRequest(ServletContext context, ServletInputStream stream)	Constructs this object with a ServletContext object and a ServletInputStream object.

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(HttpServletResponse response)
String	changeSessionId()
String	getAuthType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String name)
String	getHeader(String name)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
int	getIntHeader(String name)
String	getMethod()
Part	getPart(String name)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getQueryString()
String	getRemoteUser()
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()	Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isUserInRole(String role)
void	login(String username, String password)
void	logout()
void	setMethod(String value)	Sets the request method of this request to a String value.
void	setPathInfo(String value)	Sets the path information of this request to a String value.
void	setQueryString(String value)	Sets the query string of this request to a String value.
<T extends HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)

Methods inherited from class org.vx68k.bitbucket.stub.StubServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setServerName, setServerPort, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

StubHttpServletRequest

public StubHttpServletRequest(ServletContext context)

Constructs this object with a ServletContext object. The input stream shall be set to empty.

Parameters:

context - ServletContext object

StubHttpServletRequest

public StubHttpServletRequest(ServletContext context,
                              ServletInputStream stream)

Constructs this object with a ServletContext object and a ServletInputStream object.

Parameters:

context - ServletContext object

stream - ServletInputStream object

Method Detail

setMethod

public final void setMethod(String value)

Sets the request method of this request to a String value. The given value will be returned by getMethod.

Parameters:

value - String value

setPathInfo

public final void setPathInfo(String value)

Sets the path information of this request to a String value. The given value will be returned by getPathInfo.

Parameters:

value - String value

setQueryString

public final void setQueryString(String value)

Sets the query string of this request to a String value. The given value will be returned by getQueryString.

Parameters:

value - String value

getAuthType

public String getAuthType()

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getAuthType in interface HttpServletRequest

Returns:

null

getCookies

public Cookie[] getCookies()

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getCookies in interface HttpServletRequest

Returns:

null

getDateHeader

public long getDateHeader(String name)

This implementation always returns -1. Subclasses may override this method to return other values.

Specified by:

getDateHeader in interface HttpServletRequest

Returns:

-1

getHeader

public String getHeader(String name)

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getHeader in interface HttpServletRequest

Returns:

null

getHeaders

public Enumeration<String> getHeaders(String name)

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getHeaders in interface HttpServletRequest

Returns:

null

getHeaderNames

public Enumeration<String> getHeaderNames()

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getHeaderNames in interface HttpServletRequest

Returns:

null

getIntHeader

public int getIntHeader(String name)

This implementation always returns -1. Subclasses may override this method to return other values.

Specified by:

getIntHeader in interface HttpServletRequest

Returns:

-1

getMethod

public final String getMethod()

This implementation returns the value set by setMethod, which is "GET" by default.

Specified by:

getMethod in interface HttpServletRequest

Returns:

the value set by setMethod

getPathInfo

public final String getPathInfo()

This implementation returns the value set by setPathInfo, which is null by default.

Specified by:

getPathInfo in interface HttpServletRequest

Returns:

the value set by setPathInfo

getPathTranslated

public String getPathTranslated()

This implementation always returns null. Subclasses may override this method to other values.

Specified by:

getPathTranslated in interface HttpServletRequest

Returns:

null

getContextPath

public String getContextPath()

This implementation always returns "". Subclasses may override this method to return other values.

Specified by:

getContextPath in interface HttpServletRequest

Returns:

""

getQueryString

public final String getQueryString()

This implementation returns the value set by setQueryString, which is null by default.

Specified by:

getQueryString in interface HttpServletRequest

Returns:

the value set by setQueryString

getRemoteUser

public String getRemoteUser()

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getRemoteUser in interface HttpServletRequest

Returns:

null

isUserInRole

public boolean isUserInRole(String role)

This implementation always returns false. Subclasses may override this method to return other values.

Specified by:

isUserInRole in interface HttpServletRequest

Returns:

false

getUserPrincipal

public Principal getUserPrincipal()

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getUserPrincipal in interface HttpServletRequest

Returns:

null

getRequestedSessionId

public String getRequestedSessionId()

This implementation always returns null. Subclasses may override this method to return other values.

Specified by:

getRequestedSessionId in interface HttpServletRequest

Returns:

null

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdFromUrl

@Deprecated
public final boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
                            ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

login

public void login(String username,
                  String password)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

getParts

public Collection<Part> getParts()
                          throws IOException,
                                 ServletException

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

getPart

public Part getPart(String name)
             throws IOException,
                    ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

upgrade

public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                         throws IOException,
                                                ServletException

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException