gnu.kawa.servlet

Class KawaServlet.Context

java.lang.Object

gnu.kawa.servlet.HttpRequestContext

gnu.kawa.servlet.KawaServlet.Context

Enclosing class:

KawaServlet

public static class KawaServlet.Context
extends HttpRequestContext

Field Summary

Fields inherited from class gnu.kawa.servlet.HttpRequestContext

HTTP_NOT_FOUND, HTTP_OK, importServletDefinitions, instance, statusCode, statusReasonPhrase

Constructor Summary

Constructors

Constructor and Description
Context(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name) Get attribute from the server context.
java.lang.String	getContextPath() Returns the context path, relative to the server root.
static javax.servlet.http.HttpServletRequest	getCurrentRequest()
static javax.servlet.http.HttpServletResponse	getCurrentResponse()
static KawaServlet.Context	getInstance(java.lang.String command)
static KawaServlet.Context	getInstanceOrNull()
java.net.InetAddress	getLocalHost()
java.lang.String	getLocalIPAddress()
int	getLocalPort()
java.lang.String	getPathTranslated()
java.lang.String	getQueryString()
java.net.InetAddress	getRemoteHost()
java.lang.String	getRemoteIPAddress()
int	getRemotePort()
javax.servlet.http.HttpServletRequest	getRequest()
java.lang.String	getRequestHeader(java.lang.String name)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestHeaders()
java.util.List<java.lang.String>	getRequestHeaders(java.lang.String name)
java.lang.String	getRequestMethod()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestParameters()
java.lang.String	getRequestPath()
java.lang.String	getRequestScheme()
java.io.InputStream	getRequestStream()
java.net.URI	getRequestURI()
java.lang.StringBuffer	getRequestURLBuffer()
java.net.URL	getResourceURL(java.lang.String path) Returns the URL of a resource.
javax.servlet.http.HttpServletResponse	getResponse()
java.io.OutputStream	getResponseStream() Return an OutputStream for the result body.
javax.servlet.http.HttpServlet	getServlet()
javax.servlet.ServletConfig	getServletConfig()
javax.servlet.ServletContext	getServletContext()
java.lang.String	getServletPath()
void	log(java.lang.String message)
void	log(java.lang.String message, java.lang.Throwable ex)
boolean	reset(boolean headersAlso) Try to reset (delete) any response generated so far.
void	sendResponseHeaders(int reasonCode, java.lang.String reasonPhrase, long responseLength) Send headers.
void	setAttribute(java.lang.String name, java.lang.Object value) Set attribute in the server context.
void	setContentType(java.lang.String type)
void	setResponseHeader(java.lang.String name, java.lang.String value)

Methods inherited from class gnu.kawa.servlet.HttpRequestContext

getConsumer, getInstance, getLocalPath, getLocalSocketAddress, getRemoteSocketAddress, getRequestBodyChars, getRequestParameter, getRequestPort, getScriptPath, handleStaticFile, normalizeToContext, sendNotFound, setInstance, setScriptAndLocalPath

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(javax.servlet.http.HttpServlet servlet,
               javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response)

Method Detail

getInstance

public static KawaServlet.Context getInstance(java.lang.String command)

getInstanceOrNull

public static KawaServlet.Context getInstanceOrNull()

getCurrentRequest

public static javax.servlet.http.HttpServletRequest getCurrentRequest()

getCurrentResponse

public static javax.servlet.http.HttpServletResponse getCurrentResponse()

getServlet

public javax.servlet.http.HttpServlet getServlet()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

getServletContext

public javax.servlet.ServletContext getServletContext()

getRequestURI

public java.net.URI getRequestURI()

Specified by:

getRequestURI in class HttpRequestContext

getContextPath

public java.lang.String getContextPath()

Description copied from class: HttpRequestContext

Returns the context path, relative to the server root. This is an initial substring of the HttpRequestContext.getRequestPath(). Like ServletContext#getContextPath, but ends with a '/'. The string getRequestURI() is the same as the concatenation of getContextPath(), getScriptPath(), and getLocalPath().

Specified by:

getContextPath in class HttpRequestContext

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in class HttpRequestContext

getRequestMethod

public java.lang.String getRequestMethod()

Specified by:

getRequestMethod in class HttpRequestContext

getRequestPath

public java.lang.String getRequestPath()

Overrides:

getRequestPath in class HttpRequestContext

getRequestScheme

public java.lang.String getRequestScheme()

Overrides:

getRequestScheme in class HttpRequestContext

getLocalHost

public java.net.InetAddress getLocalHost()

Overrides:

getLocalHost in class HttpRequestContext

getLocalIPAddress

public java.lang.String getLocalIPAddress()

Overrides:

getLocalIPAddress in class HttpRequestContext

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in class HttpRequestContext

getRemoteIPAddress

public java.lang.String getRemoteIPAddress()

Specified by:

getRemoteIPAddress in class HttpRequestContext

getRemoteHost

public java.net.InetAddress getRemoteHost()

Specified by:

getRemoteHost in class HttpRequestContext

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in class HttpRequestContext

getRequestURLBuffer

public java.lang.StringBuffer getRequestURLBuffer()

Overrides:

getRequestURLBuffer in class HttpRequestContext

getServletPath

public java.lang.String getServletPath()

getPathTranslated

public java.lang.String getPathTranslated()

Specified by:

getPathTranslated in class HttpRequestContext

getRequestParameters

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestParameters()

Specified by:

getRequestParameters in class HttpRequestContext

getRequestHeader

public java.lang.String getRequestHeader(java.lang.String name)

Specified by:

getRequestHeader in class HttpRequestContext

getRequestHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestHeaders()

Specified by:

getRequestHeaders in class HttpRequestContext

getRequestHeaders

public java.util.List<java.lang.String> getRequestHeaders(java.lang.String name)

Specified by:

getRequestHeaders in class HttpRequestContext

getRequestStream

public java.io.InputStream getRequestStream()

Specified by:

getRequestStream in class HttpRequestContext

getResponseStream

public java.io.OutputStream getResponseStream()

Description copied from class: HttpRequestContext

Return an OutputStream for the result body. Multiple calls will return the same OutputStream.

Specified by:

getResponseStream in class HttpRequestContext

setResponseHeader

public void setResponseHeader(java.lang.String name,
                              java.lang.String value)

Specified by:

setResponseHeader in class HttpRequestContext

setContentType

public void setContentType(java.lang.String type)

Overrides:

setContentType in class HttpRequestContext

reset

public boolean reset(boolean headersAlso)

Description copied from class: HttpRequestContext

Try to reset (delete) any response generated so far.

Specified by:

reset in class HttpRequestContext

Parameters:

headersAlso - if response headers should also be reset.

Returns:

true on success, false if it's too late.

getResourceURL

public java.net.URL getResourceURL(java.lang.String path)

Description copied from class: HttpRequestContext

Returns the URL of a resource. The resource is relative to the script path, if the path is relative; otherwise (if it starts with a '/' it is relative to the context path.

Specified by:

getResourceURL in class HttpRequestContext

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Description copied from class: HttpRequestContext

Get attribute from the server context.

Specified by:

getAttribute in class HttpRequestContext

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from class: HttpRequestContext

Set attribute in the server context.

Specified by:

setAttribute in class HttpRequestContext

sendResponseHeaders

public void sendResponseHeaders(int reasonCode,
                                java.lang.String reasonPhrase,
                                long responseLength)
                         throws java.io.IOException

Description copied from class: HttpRequestContext

Send headers.

Specified by:

sendResponseHeaders in class HttpRequestContext

Parameters:

reasonCode - response code - e.g. 200 for OK.

reasonPhrase - response string - e.g. "OK" or "Not Found".

responseLength - response length in bytes, or -1 (unspecified). Note this is different from HttpExchange.sendResponseHeaders. This method must be called before getResponseStream. Implementations should set statusCode to STATUS_SENT.

Throws:

java.io.IOException

log

public void log(java.lang.String message)

Specified by:

log in class HttpRequestContext

log

public void log(java.lang.String message,
                java.lang.Throwable ex)

Specified by:

log in class HttpRequestContext