to.etc.domui.server

Class HttpServerRequestResponse

java.lang.Object

to.etc.domui.server.HttpServerRequestResponse

All Implemented Interfaces:

IRequestResponse

public class HttpServerRequestResponse
extends Object
implements IRequestResponse

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addHeader(String name, String value)
static HttpServerRequestResponse	create(DomApplication application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static HttpServerRequestResponse	get(IRequestContext ctx)
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() Returns the names of all file parameters.
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.
javax.servlet.http.HttpServletRequest	getRequest()
String	getRequestURI() Must return the path part of a request URL.
javax.servlet.http.HttpServletResponse	getResponse()
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()

Methods inherited from class java.lang.Object

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

Method Detail

getRequestURI

@Nonnull
public String getRequestURI()

Description copied from interface: IRequestResponse

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 '/'.

Specified by:

getRequestURI in interface IRequestResponse

Returns:

getQueryString

@Nonnull
public String getQueryString()

Specified by:

getQueryString in interface IRequestResponse

getRequest

@Nonnull
public javax.servlet.http.HttpServletRequest getRequest()

getResponse

@Nonnull
public javax.servlet.http.HttpServletResponse getResponse()

getWebappContext

@Nonnull
public String getWebappContext()

Description copied from interface: IRequestResponse

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

Specified by:

getWebappContext in interface IRequestResponse

Returns:

create

@Nonnull
public static HttpServerRequestResponse create(@Nonnull
                                                        DomApplication application,
                                                        @Nonnull
                                                        javax.servlet.http.HttpServletRequest request,
                                                        @Nonnull
                                                        javax.servlet.http.HttpServletResponse response)

releaseUploads

public void releaseUploads()

Description copied from interface: IRequestResponse

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

Specified by:

releaseUploads in interface IRequestResponse

getUserAgent

@Nonnull
public String getUserAgent()

Specified by:

getUserAgent in interface IRequestResponse

getApplicationURL

@Nonnull
public String getApplicationURL()

Description copied from interface: IRequestResponse

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.

Specified by:

getApplicationURL in interface IRequestResponse

Returns:

getHostURL

@Nonnull
public String getHostURL()

Specified by:

getHostURL in interface IRequestResponse

getParameter

@Nullable
public String getParameter(@Nonnull
                                     String name)

Specified by:

getParameter in interface IRequestResponse

See Also:

IParameterInfo.getParameter(java.lang.String)

getParameters

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

Specified by:

getParameters in interface IRequestResponse

See Also:

IParameterInfo.getParameters(java.lang.String)

getParameterNames

@Nonnull
public String[] getParameterNames()

Specified by:

getParameterNames in interface IRequestResponse

See Also:

IParameterInfo.getParameterNames()

getFileParameters

@Nonnull
public String[] getFileParameters()
                                    throws Exception

Returns the names of all file parameters.

Specified by:

getFileParameters in interface IRequestResponse

Returns:

Throws:

Exception

getFileParameter

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

Specified by:

getFileParameter in interface IRequestResponse

Throws:

Exception

setNoCache

public void setNoCache()

Specified by:

setNoCache in interface IRequestResponse

setExpiry

public void setExpiry(int cacheTime)

Specified by:

setExpiry in interface IRequestResponse

getOutputWriter

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

Specified by:

getOutputWriter in interface IRequestResponse

Throws:

IOException

getOutputStream

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

Specified by:

getOutputStream in interface IRequestResponse

Throws:

Exception

redirect

public void redirect(@Nonnull
                     String newUrl)
              throws Exception

Send a redirect response to the client.

Specified by:

redirect in interface IRequestResponse

Parameters:

newUrl -

Throws:

Exception

sendError

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

Description copied from interface: IRequestResponse

Send an error back to the client.

Specified by:

sendError in interface IRequestResponse

Throws:

Exception

addHeader

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

Specified by:

addHeader in interface IRequestResponse

addCookie

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

Specified by:

addCookie in interface IRequestResponse

getCookies

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

Specified by:

getCookies in interface IRequestResponse

getRemoteUser

@Nullable
public String getRemoteUser()

Description copied from interface: IRequestResponse

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.

Specified by:

getRemoteUser in interface IRequestResponse

Returns:

getServerSession

@Nullable
public IServerSession getServerSession(boolean create)

Description copied from interface: IRequestResponse

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.

Specified by:

getServerSession in interface IRequestResponse

Returns:

get

@Nullable
public static HttpServerRequestResponse get(@Nonnull
                                                      IRequestContext ctx)