to.etc.domui.server

Class RequestContextImpl

java.lang.Object

to.etc.domui.server.RequestContextImpl

All Implemented Interfaces:

IAttributeContainer, IExtendedParameterInfo, IParameterInfo, IRequestContext

public class RequestContextImpl
extends Object
implements IRequestContext, IAttributeContainer

Constructor Summary

Constructors

Constructor and Description
RequestContextImpl(IRequestResponse rr, DomApplication app, AppSession ses)

Method Summary

Modifier and Type	Method and Description
void	discard()
void	flush()
DomApplication	getApplication() Return the DomApplication instance.
Object	getAttribute(String name)
BrowserVersion	getBrowserVersion()
String	getExtension() Return the name extension of the input URL without it's "." character.
UploadItem[]	getFileParameter(String name)
String[]	getFileParameters() Returns the names of all file parameters.
String	getInputPath() Return the input path relative to the webapp's root.
Writer	getOutputWriter(String contentType, String encoding) This returns a fully buffered output writer.
String	getParameter(String name)
String[]	getParameterNames()
String[]	getParameters(String name)
String	getRelativePath(String rel) Creates a full path from an application-relative path.
IRequestResponse	getRequestResponse()
IServerSession	getServerSession(boolean create)
AppSession	getSession() Get the session for this context.
String	getUserAgent() Returns the value of the "User-Agent" header to determine the browser type.
WindowSession	getWindowSession() Gets this request's conversation.
void	internalOnRequestFinished() Called for all requests that have used a RequestContextImpl.
void	internalSetWindowSession(WindowSession cm) QUESTIONABLE.
void	redirect(String newUrl) Send a redirect response to the client.
void	sendError(int httpErrorCode, String message) Send an error back to the client.
void	setAttribute(String name, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestContextImpl

public RequestContextImpl(@Nonnull
                          IRequestResponse rr,
                          @Nonnull
                          DomApplication app,
                          @Nonnull
                          AppSession ses)

Method Detail

getApplication

@Nonnull
public final DomApplication getApplication()

Description copied from interface: IRequestContext

Return the DomApplication instance.

Specified by:

getApplication in interface IRequestContext

Returns:

See Also:

IRequestContext.getApplication()

getSession

@Nonnull
public final AppSession getSession()

Get the session for this context.

Specified by:

getSession in interface IRequestContext

Returns:

See Also:

IRequestContext.getSession()

getRequestResponse

@Nonnull
public IRequestResponse getRequestResponse()

Specified by:

getRequestResponse in interface IRequestContext

internalSetWindowSession

public final void internalSetWindowSession(WindowSession cm)

QUESTIONABLE.

Parameters:

cm -

getWindowSession

@Nonnull
public final WindowSession getWindowSession()

Gets this request's conversation. If not already known it tries to locate the conversation parameter and locate the manager from there. If that fails it throws an exception.

Specified by:

getWindowSession in interface IRequestContext

Returns:

See Also:

IRequestContext.getWindowSession()

internalOnRequestFinished

public void internalOnRequestFinished()

Called for all requests that have used a RequestContextImpl. This releases all lazily-aquired resources.

getExtension

@Nonnull
public String getExtension()

Description copied from interface: IRequestContext

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.

Specified by:

getExtension in interface IRequestContext

Returns:

See Also:

IRequestContext.getExtension()

getInputPath

@Nonnull
public final String getInputPath()

Description copied from interface: IRequestContext

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".

Specified by:

getInputPath in interface IRequestContext

Returns:

See Also:

IRequestContext.getInputPath()

getUserAgent

public String getUserAgent()

Description copied from interface: IRequestContext

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

Specified by:

getUserAgent in interface IRequestContext

Returns:

See Also:

IRequestContext.getUserAgent()

getBrowserVersion

public BrowserVersion getBrowserVersion()

Specified by:

getBrowserVersion in interface IExtendedParameterInfo

flush

public void flush()
           throws Exception

Throws:

Exception

discard

public void discard()
             throws IOException

Throws:

IOException

getRelativePath

@Nonnull
public String getRelativePath(@Nonnull
                                       String rel)

Description copied from interface: IRequestContext

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".

Specified by:

getRelativePath in interface IRequestContext

Returns:

See Also:

IRequestContext.getRelativePath(java.lang.String)

getOutputWriter

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

This returns a fully buffered output writer. Calling it twice is explicitly allowed, but clears the data written before as it's assumed that another route to output will be chosen.

Specified by:

getOutputWriter in interface IRequestContext

Returns:

Throws:

IOException

redirect

public void redirect(@Nonnull
                     String newUrl)
              throws Exception

Send a redirect response to the client.

Parameters:

newUrl -

Throws:

Exception

sendError

public void sendError(int httpErrorCode,
                      @Nonnull
                      String message)
               throws Exception

Send an error back to the client.

Parameters:

httpErrorCode -

message -

Throws:

Exception

getServerSession

@Nullable
public IServerSession getServerSession(boolean create)

Specified by:

getServerSession in interface IRequestContext

getParameter

@Nullable
public String getParameter(@Nonnull
                                     String name)

Specified by:

getParameter in interface IParameterInfo

See Also:

IParameterInfo.getParameter(java.lang.String)

getParameters

@Nonnull
public String[] getParameters(@Nonnull
                                       String name)

Specified by:

getParameters in interface IParameterInfo

See Also:

IParameterInfo.getParameters(java.lang.String)

getParameterNames

@Nonnull
public String[] getParameterNames()

Specified by:

getParameterNames in interface IParameterInfo

See Also:

IParameterInfo.getParameterNames()

getFileParameters

public String[] getFileParameters()
                           throws Exception

Returns the names of all file parameters.

Returns:

Throws:

Exception

getFileParameter

public UploadItem[] getFileParameter(@Nonnull
                                     String name)
                              throws Exception

Throws:

Exception

getAttribute

public Object getAttribute(@Nonnull
                           String name)

Specified by:

getAttribute in interface IAttributeContainer

See Also:

IAttributeContainer.getAttribute(java.lang.String)

setAttribute

public void setAttribute(@Nonnull
                         String name,
                         @Nullable
                         Object value)

Specified by:

setAttribute in interface IAttributeContainer