Package org.vx68k.bitbucket.stub

Class StubServletRequest

java.lang.Object

org.vx68k.bitbucket.stub.StubServletRequest

All Implemented Interfaces:

ServletRequest

Direct Known Subclasses:

StubHttpServletRequest

public class StubServletRequest
extends Object
implements ServletRequest

Stub implementation of ServletRequest.

Since:

5.0

Author:

Kaz Nishimura

Field Summary

Fields

Modifier and Type	Field	Description
static int	HTTP_PORT	Default HTTP server port.
static int	HTTPS_PORT	Default HTTPS server port.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AsyncContext	getAsyncContext()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
String	getCharacterEncoding()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
DispatcherType	getDispatcherType()
ServletInputStream	getInputStream()
String	getLocalAddr()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getLocalName()
int	getLocalPort()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
String	getProtocol()
BufferedReader	getReader()
String	getRealPath(String path)	Deprecated.
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
RequestDispatcher	getRequestDispatcher(String path)
String	getScheme()
String	getServerName()
int	getServerPort()
ServletContext	getServletContext()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isSecure()
void	removeAttribute(String name)
void	setAttribute(String name, Object object)
void	setCharacterEncoding(String env)
void	setServerName(String value)	Sets the server name to a String value.
void	setServerPort(int value)	Sets the server port to an int value.
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest request, ServletResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_PORT

public static final int HTTP_PORT

Default HTTP server port.

See Also:

Constant Field Values

HTTPS_PORT

public static final int HTTPS_PORT

Default HTTPS server port.

See Also:

Constant Field Values

Constructor Detail

StubServletRequest

public StubServletRequest(ServletContext context)

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

Parameters:

context - ServletContext object

StubServletRequest

public StubServletRequest(ServletContext context,
                          ServletInputStream stream)

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

Parameters:

context - ServletContext object

stream - ServletInputStream object

Method Detail

getServletContext

public final ServletContext getServletContext()

This implementation returns the ServletContext object given to the constructor.

Specified by:

getServletContext in interface ServletRequest

getInputStream

public final ServletInputStream getInputStream()

This implementation returns the ServletInputStream object given to the constructor.

Specified by:

getInputStream in interface ServletRequest

setServerName

public final void setServerName(String value)

Sets the server name to a String value.

Parameters:

value - String value to which the server name shall be set

setServerPort

public final void setServerPort(int value)

Sets the server port to an int value.

Parameters:

value - int value to which the server port shall be set

getAttribute

public final Object getAttribute(String name)

Specified by:

getAttribute in interface ServletRequest

getAttributeNames

public final Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

setAttribute

public final void setAttribute(String name,
                               Object object)

Specified by:

setAttribute in interface ServletRequest

removeAttribute

public final void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Throws:

UnsupportedEncodingException

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface ServletRequest

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

getServerName

public final String getServerName()

Specified by:

getServerName in interface ServletRequest

getServerPort

public final int getServerPort()

Specified by:

getServerPort in interface ServletRequest

getReader

public final BufferedReader getReader()
                               throws IOException

Specified by:

getReader in interface ServletRequest

Throws:

IOException

getRemoteAddr

public final String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost

public final String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface ServletRequest

getLocale

public final Locale getLocale()

This implementation returns the current locale.

Specified by:

getLocale in interface ServletRequest

Returns:

the current locale

getLocales

public final Enumeration<Locale> getLocales()

This implementation returns an empty enumeration.

Specified by:

getLocales in interface ServletRequest

Returns:

an empty enumeration

isSecure

public final boolean isSecure()

This implementation always returns false.

Specified by:

isSecure in interface ServletRequest

Returns:

false

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

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

Specified by:

getRequestDispatcher in interface ServletRequest

Returns:

null

getRealPath

@Deprecated
public final String getRealPath(String path)

Deprecated.

This implementation uses ServletContext.getRealPath(java.lang.String).

Specified by:

getRealPath in interface ServletRequest

getRemotePort

public final int getRemotePort()

This implementation returns the remote TCP port of this request.

Specified by:

getRemotePort in interface ServletRequest

Returns:

the remote TCP port

getLocalName

public final String getLocalName()

This implementation returns the local host name ("localhost" by default) of this request.

Specified by:

getLocalName in interface ServletRequest

Returns:

the local host name

getLocalAddr

public final String getLocalAddr()

This implementation returns the local IP address ( "127.0.0.1" by default) of this request.

Specified by:

getLocalAddr in interface ServletRequest

Returns:

the local IP address

getLocalPort

public final int getLocalPort()

This implementation returns the local TCP port (80 by default) of this request.

Specified by:

getLocalPort in interface ServletRequest

Returns:

the local TCP port

startAsync

public AsyncContext startAsync()

This implementation always throws IllegalStateException.

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException - always

startAsync

public AsyncContext startAsync(ServletRequest request,
                               ServletResponse response)

This implementation always throws IllegalStateException.

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException - always

isAsyncStarted

public boolean isAsyncStarted()

This implementation always returns false.

Specified by:

isAsyncStarted in interface ServletRequest

Returns:

false

isAsyncSupported

public boolean isAsyncSupported()

This implementation always returns false.

Specified by:

isAsyncSupported in interface ServletRequest

Returns:

false

getAsyncContext

public AsyncContext getAsyncContext()

This implementation always throws IllegalStateException.

Specified by:

getAsyncContext in interface ServletRequest

Throws:

IllegalStateException - always

getDispatcherType

public DispatcherType getDispatcherType()

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

Specified by:

getDispatcherType in interface ServletRequest

Returns:

DispatcherType.REQUEST