to.etc.domui.server

Interface IRequestContext

All Superinterfaces:

IExtendedParameterInfo, IParameterInfo

All Known Implementing Classes:

RequestContextImpl, TestRequestContext

public interface IRequestContext
extends IExtendedParameterInfo

Interface representing the context for a request to the server. In a real server request this encapsulates HttpServletRequest and HttpServletResponse, and interfaces with those to get data. The interface should be used as much as possible, since JUnit tests cannot use the real server implementation of it (due to lack of HttpServlet* thingies there).

Author:

Frits Jalvingh Created on Dec 29, 2010

Method Summary

Modifier and Type	Method and Description
DomApplication	getApplication() Return the DomApplication instance.
String	getExtension() Return the name extension of the input URL without it's "." character.
String	getInputPath() Return the input path relative to the webapp's root.
Writer	getOutputWriter(String contentType, String encoding) Returns the buffered writer to use to generate text-based output to this context.
String	getRelativePath(String rel) Creates a full path from an application-relative path.
IRequestResponse	getRequestResponse()
IServerSession	getServerSession(boolean create)
AppSession	getSession() Return this-user's AppSession.
String	getUserAgent() Returns the value of the "User-Agent" header to determine the browser type.
WindowSession	getWindowSession() Return the WindowSession for this request.

Methods inherited from interface to.etc.domui.server.IExtendedParameterInfo

getBrowserVersion

Methods inherited from interface to.etc.domui.server.IParameterInfo

getParameter, getParameterNames, getParameters

Method Detail

getApplication

@Nonnull
DomApplication getApplication()

Return the DomApplication instance.

Returns:

getRequestResponse

@Nonnull
IRequestResponse getRequestResponse()

getSession

@Nonnull
AppSession getSession()

Return this-user's AppSession.

Returns:

getServerSession

@Nullable
IServerSession getServerSession(boolean create)

getWindowSession

@Nonnull
WindowSession getWindowSession()

Return the WindowSession for this request. The WindowSession represents one of the possible multiple open browser windows. Since each browser window shares a single HttpSession (sigh) the WindowSession is used to separate the administration for separate browser windows.

Returns:

getExtension

@Nonnull
String getExtension()

Return the name extension of the input URL without it's "." character. This extension is defined as the part after the last dot in the last "directory name fragment" of the name. For example, for the url "/demo/css/style.css" this call will return "css" (no dot). If the page has no extension this returns the empty string.

Returns:

getInputPath

@Nonnull
String getInputPath()

Return the input path relative to the webapp's root. The webapp context path is not part of this path, and the path never starts with a slash. So for the webapp "demo" with input URL "http://localhost/demo/css/style.css" this will return "css/style.css".

Returns:

getUserAgent

@Nullable
String getUserAgent()

Returns the value of the "User-Agent" header to determine the browser type.

Returns:

getRelativePath

@Nonnull
String getRelativePath(@Nonnull
                                String rel)

Creates a full path from an application-relative path. So if the root of the application is "http://localhost/demo/", calling this with "img/button.png" will return the string "http://localhost/demo/img/button.png".

Parameters:

rel -

Returns:

getOutputWriter

@Nonnull
Writer getOutputWriter(@Nonnull
                                String contentType,
                                @Nullable
                                String encoding)
                         throws IOException

Returns the buffered writer to use to generate text-based output to this context.

Returns:

Throws:

IOException