org.jwarp.service.web
Class MutableRequest

java.lang.Object
  |
  +--org.jwarp.service.web.MutableRequest

All Implemented Interfaces:

IMutableRequest

public class MutableRequest

extends java.lang.Object

implements IMutableRequest

Wrapper class to extend the HttpServletRequest with the ability to set new parameters, to overwrite or even remove existing parameters from the request.

Version:

1.0

Author:

Anatole Tresch

Field Summary

(package private) java.lang.String	queryString
(package private) java.util.Hashtable	removedParams
(package private) org.jwarp.service.web.HttpServletRequest	request
(package private) javax.servlet.http.HttpSession	session
(package private) java.util.Hashtable	tempParams

Constructor Summary

MutableRequest(org.jwarp.service.web.HttpServletRequest req)
Creates an instance with the given HttpServletRequest

Method Summary

java.lang.Object	getAttribute(java.lang.String key) Returns an attribute from the request.
java.util.Enumeration	getAttributeNames() Wrapper method.
java.lang.String	getAuthType() Wrapper method.
java.lang.String	getCharacterEncoding() Wrapper method.
int	getContentLength() Wrapper method.
java.lang.String	getContentType() Wrapper method.
java.lang.String	getContextPath() Wrapper method.
javax.servlet.http.Cookie[]	getCookies() Wrapper method.
long	getDateHeader(java.lang.String p0) Wrapper method.
java.lang.String	getHeader(java.lang.String p0) Wrapper method.
java.util.Enumeration	getHeaderNames() Wrapper method.
java.util.Enumeration	getHeaders(java.lang.String p0) Wrapper method.
org.jwarp.service.web.ServletInputStream	getInputStream() Wrapper method.
int	getIntHeader(java.lang.String p0) Wrapper method.
java.util.Locale	getLocale() Wrapper method.
java.util.Enumeration	getLocales() Wrapper method.
java.lang.String	getMethod() Wrapper method.
java.lang.String	getParameter(java.lang.String key) Returns a parameter.
java.util.Enumeration	getParameterNames() Returns an Enumeration of all parameter names.
java.lang.String[]	getParameterValues(java.lang.String key) Returns a parameters values.
java.lang.String	getPathInfo() Wrapper method.
java.lang.String	getPathTranslated() Wrapper method.
java.lang.String	getProtocol() Wrapper method.
java.lang.String	getQueryString() Returns the query-string part from the request
java.io.BufferedReader	getReader() Wrapper method.
java.lang.String	getRealPath(java.lang.String p0) Wrapper method.
java.lang.String	getRemoteAddr() Wrapper method.
java.lang.String	getRemoteHost() Wrapper method.
java.lang.String	getRemoteUser() Wrapper method.
org.jwarp.service.web.HttpServletRequest	getRequest() Return the wrapped HttpServletRequest
org.jwarp.service.web.RequestDispatcher	getRequestDispatcher(java.lang.String p0) Wrapper method.
java.lang.String	getRequestedSessionId() Wrapper method.
java.lang.String	getRequestURI() Wrapper method.
java.lang.String	getScheme() Wrapper method.
java.lang.String	getServerName() Wrapper method.
int	getServerPort() Wrapper method.
java.lang.String	getServletPath() Wrapper method.
javax.servlet.http.HttpSession	getSession() Returns the HttpSession
javax.servlet.http.HttpSession	getSession(boolean createNew) Returns the HttpSession
java.security.Principal	getUserPrincipal() Wrapper method.
java.lang.Object	getValue(java.lang.String key) Returns a parameter as Object
boolean	isRequestedSessionIdFromCookie() Wrapper method.
boolean	isRequestedSessionIdFromUrl() Wrapper method.
boolean	isRequestedSessionIdFromURL() Wrapper method.
boolean	isRequestedSessionIdValid() Wrapper method.
boolean	isSecure() Wrapper method.
boolean	isUserInRole(java.lang.String p0) Wrapper method.
void	putParameter(java.lang.String key, java.lang.String object) Set a value as parameter.
void	removeAttribute(java.lang.String p0) Wrapper method.
java.lang.String	removeParameter(java.lang.String key) Removes a parameter.
void	restoreParameter(java.lang.String key)
void	setAttribute(java.lang.String key, java.lang.Object value) Set an attribute for the request.
void	setQuery(java.lang.String queryString) Sets the query-string part of the request
void	setSession(javax.servlet.http.HttpSession session) Sets a new HttpSession for ths request

Methods inherited from class java.lang.Object

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

Field Detail

removedParams

java.util.Hashtable removedParams

tempParams

java.util.Hashtable tempParams

session

javax.servlet.http.HttpSession session

request

org.jwarp.service.web.HttpServletRequest request

queryString

java.lang.String queryString

Constructor Detail

MutableRequest

public MutableRequest(org.jwarp.service.web.HttpServletRequest req)

Creates an instance with the given HttpServletRequest

Parameters:

context - Reference to the parent application-controller

req - The HttpServletRequest to wrap

Method Detail

putParameter

public void putParameter(java.lang.String key,
                         java.lang.String object)

Set a value as parameter. If the parameter exists already it will be overwritten.

Specified by:

putParameter in interface IMutableRequest

Parameters:

key - Name of the parameter to set

getQueryString

public java.lang.String getQueryString()

Returns the query-string part from the request

setQuery

public void setQuery(java.lang.String queryString)

Sets the query-string part of the request

Parameters:

queryString - New query-string

removeParameter

public java.lang.String removeParameter(java.lang.String key)

Removes a parameter.

Specified by:

removeParameter in interface IMutableRequest

Parameters:

key - Name of the parameter to set

restoreParameter

public void restoreParameter(java.lang.String key)

getParameter

public java.lang.String getParameter(java.lang.String key)

Returns a parameter.

Parameters:

key - Name of the parameter to get

getParameterNames

public java.util.Enumeration getParameterNames()

Returns an Enumeration of all parameter names.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String key)

Returns a parameters values.

Parameters:

key - Name of the parameter to get

setSession

public void setSession(javax.servlet.http.HttpSession session)

Sets a new HttpSession for ths request

Specified by:

setSession in interface IMutableRequest

Parameters:

session - New HttpSession

getSession

public javax.servlet.http.HttpSession getSession()

Returns the HttpSession

getSession

public javax.servlet.http.HttpSession getSession(boolean createNew)

Returns the HttpSession

Parameters:

createNew - If true a new HttpSession is created, if there is none.

getValue

public java.lang.Object getValue(java.lang.String key)

Returns a parameter as Object

Parameters:

key - Name of the parameter to get

getRequest

public org.jwarp.service.web.HttpServletRequest getRequest()

Return the wrapped HttpServletRequest

setAttribute

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

Set an attribute for the request.

Parameters:

key - Name of the attribute to set

getAttribute

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

Returns an attribute from the request.

Parameters:

key - Name of the attribute to get

getAuthType

public java.lang.String getAuthType()

Wrapper method. Calls the underlying method from HttpRequest

getCookies

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

Wrapper method. Calls the underlying method from HttpRequest

getDateHeader

public long getDateHeader(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

getHeader

public java.lang.String getHeader(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

getHeaderNames

public java.util.Enumeration getHeaderNames()

Wrapper method. Calls the underlying method from HttpRequest

getIntHeader

public int getIntHeader(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

getMethod

public java.lang.String getMethod()

Wrapper method. Calls the underlying method from HttpRequest

getPathInfo

public java.lang.String getPathInfo()

Wrapper method. Calls the underlying method from HttpRequest

getPathTranslated

public java.lang.String getPathTranslated()

Wrapper method. Calls the underlying method from HttpRequest

getRemoteUser

public java.lang.String getRemoteUser()

Wrapper method. Calls the underlying method from HttpRequest

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Wrapper method. Calls the underlying method from HttpRequest

getRequestURI

public java.lang.String getRequestURI()

Wrapper method. Calls the underlying method from HttpRequest

getServletPath

public java.lang.String getServletPath()

Wrapper method. Calls the underlying method from HttpRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Wrapper method. Calls the underlying method from HttpRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Wrapper method. Calls the underlying method from HttpRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Wrapper method. Calls the underlying method from HttpRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Wrapper method. Calls the underlying method from HttpRequest

getAttributeNames

public java.util.Enumeration getAttributeNames()

Wrapper method. Calls the underlying method from HttpRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Wrapper method. Calls the underlying method from HttpRequest

getContentLength

public int getContentLength()

Wrapper method. Calls the underlying method from HttpRequest

getContentType

public java.lang.String getContentType()

Wrapper method. Calls the underlying method from HttpRequest

getInputStream

public org.jwarp.service.web.ServletInputStream getInputStream()
                                                        throws java.io.IOException

Wrapper method. Calls the underlying method from HttpRequest

getProtocol

public java.lang.String getProtocol()

Wrapper method. Calls the underlying method from HttpRequest

getScheme

public java.lang.String getScheme()

Wrapper method. Calls the underlying method from HttpRequest

getServerName

public java.lang.String getServerName()

Wrapper method. Calls the underlying method from HttpRequest

getServerPort

public int getServerPort()

Wrapper method. Calls the underlying method from HttpRequest

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Wrapper method. Calls the underlying method from HttpRequest

getRemoteAddr

public java.lang.String getRemoteAddr()

Wrapper method. Calls the underlying method from HttpRequest

getRemoteHost

public java.lang.String getRemoteHost()

Wrapper method. Calls the underlying method from HttpRequest

getRealPath

public java.lang.String getRealPath(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

isUserInRole

public boolean isUserInRole(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

getUserPrincipal

public java.security.Principal getUserPrincipal()

Wrapper method. Calls the underlying method from HttpRequest

getHeaders

public java.util.Enumeration getHeaders(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

getContextPath

public java.lang.String getContextPath()

Wrapper method. Calls the underlying method from HttpRequest

removeAttribute

public void removeAttribute(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

isSecure

public boolean isSecure()

Wrapper method. Calls the underlying method from HttpRequest

getRequestDispatcher

public org.jwarp.service.web.RequestDispatcher getRequestDispatcher(java.lang.String p0)

Wrapper method. Calls the underlying method from HttpRequest

getLocale

public java.util.Locale getLocale()

Wrapper method. Calls the underlying method from HttpRequest

getLocales

public java.util.Enumeration getLocales()

Wrapper method. Calls the underlying method from HttpRequest