to.etc.domui.server

Interface IRequestResponse

All Known Implementing Classes:

HttpServerRequestResponse, TestRequestResponse

public interface IRequestResponse

Author:

Frits Jalvingh Created on Oct 3, 2013

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addHeader(String name, String value)
String	getApplicationURL() Return the base URL to the web application from the current requests.
javax.servlet.http.Cookie[]	getCookies()
UploadItem[]	getFileParameter(String name)
String[]	getFileParameters()
String	getHostURL()
OutputStream	getOutputStream(String contentType, String encoding, int contentLength)
Writer	getOutputWriter(String contentType, String encoding)
String	getParameter(String name)
String[]	getParameterNames()
String[]	getParameters(String name)
String	getQueryString()
String	getRemoteUser() The "remote" user ID from a server request, if present.
String	getRequestURI() Must return the path part of a request URL.
IServerSession	getServerSession(boolean create) Returns a wrapper for a HttpSession.
String	getUserAgent()
String	getWebappContext() Returns the webapp context as either an empty string for the ROOT context or a string starting without a slash and always ending in one, like "viewpoint/".
void	redirect(String newUrl) Send a redirect response to the client.
void	releaseUploads() Called when uploaded files are no longer needed; this can then discard of them.
void	sendError(int httpErrorCode, String message) Send an error back to the client.
void	setExpiry(int cacheTime)
void	setNoCache()

Method Detail

getRequestURI

@Nonnull
String getRequestURI()

Must return the path part of a request URL. It contains both webapp context and relative path, but no host name etc. It is required to start with a '/'.

Returns:

getQueryString

@Nonnull
String getQueryString()

releaseUploads

void releaseUploads()

Called when uploaded files are no longer needed; this can then discard of them.

getUserAgent

@Nonnull
String getUserAgent()

getRemoteUser

@Nullable
String getRemoteUser()

The "remote" user ID from a server request, if present. This does not need to represent the real logged-in user; it will however be filled if JSDK declarative security is used. This field is null if DomUI internal login code is used.

Returns:

getServerSession

@Nullable
IServerSession getServerSession(boolean create)

Returns a wrapper for a HttpSession. If "create" is true the session will be created if it does not exist in which case the call will never return null.

Parameters:

create -

Returns:

getApplicationURL

@Nonnull
String getApplicationURL()

Return the base URL to the web application from the current requests. This uses hostname, protocol, portname and web application context from the incoming requests and returns it. The returned URL is guaranteed to end in a slash.

Returns:

getHostURL

@Nonnull
String getHostURL()

getParameters

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

getParameter

@Nullable
String getParameter(@Nonnull
                              String name)

getParameterNames

@Nonnull
String[] getParameterNames()

getFileParameters

@Nonnull
String[] getFileParameters()
                             throws Exception

Throws:

Exception

getFileParameter

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

Throws:

Exception

setNoCache

void setNoCache()

addHeader

void addHeader(@Nonnull
               String name,
               @Nonnull
               String value)

getOutputWriter

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

Throws:

Exception

getOutputStream

@Nonnull
OutputStream getOutputStream(@Nonnull
                                      String contentType,
                                      @Nullable
                                      String encoding,
                                      int contentLength)
                               throws Exception

Throws:

Exception

getWebappContext

@Nonnull
String getWebappContext()

Returns the webapp context as either an empty string for the ROOT context or a string starting without a slash and always ending in one, like "viewpoint/".

Returns:

addCookie

void addCookie(@Nonnull
               javax.servlet.http.Cookie cookie)

getCookies

@Nonnull
javax.servlet.http.Cookie[] getCookies()

setExpiry

void setExpiry(int cacheTime)

redirect

void redirect(@Nonnull
              String newUrl)
       throws Exception

Send a redirect response to the client.

Parameters:

newUrl -

Throws:

Exception

sendError

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

Send an error back to the client.

Parameters:

httpErrorCode -

message -

Throws:

Exception