org.exist.cocoon
Class CocoonRequestWrapper

java.lang.Object
  org.exist.cocoon.CocoonRequestWrapper

All Implemented Interfaces:

RequestWrapper

public class CocoonRequestWrapper

extends java.lang.Object

implements RequestWrapper

A wrapper for requests processed by Cocoon.

Author:

Wolfgang Meier , Pierrick Brihaye

Constructor Summary

CocoonRequestWrapper(Request cocoonRequest)
Constructs a wrapper for the given Cocoon request.

CocoonRequestWrapper(Request cocoonRequest, HttpServletRequest servletRequest)
Constructs a wrapper for the given Cocoon request.

Method Summary

java.lang.Object	get(java.lang.String arg0)
java.lang.String	getCharacterEncoding()
int	getContentLength()
java.lang.String	getContentType()
java.lang.String	getContextPath()
java.util.Map	getCookieMap()
java.io.File	getFileUploadParam(java.lang.String parameter)
java.lang.String	getHeader(java.lang.String arg0)
java.util.Enumeration	getHeaderNames()
java.util.Enumeration	getHeaders(java.lang.String arg0)
java.io.InputStream	getInputStream()
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String arg0)
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String arg0)
java.lang.String	getPathInfo()
java.lang.String	getPathTranslated()
java.lang.String	getProtocol()
java.lang.String	getQueryString()
java.lang.String	getRemoteAddr()
java.lang.String	getRemoteHost()
java.lang.String	getRemoteUser()
java.lang.String	getRequestedSessionId()
java.lang.String	getRequestURI()
java.lang.StringBuffer	getRequestURL()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
java.lang.String	getServletPath()
SessionWrapper	getSession()
SessionWrapper	getSession(boolean arg0)
java.lang.String	getSitemapURI()
java.lang.String	getUploadedFileName(java.lang.String parameter)
java.security.Principal	getUserPrincipal()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(java.lang.String arg0)
void	removeAttribute(java.lang.String arg0)
void	setAttribute(java.lang.String arg0, java.lang.Object arg1)
void	setCharacterEncoding(java.lang.String arg0)

Methods inherited from class java.lang.Object

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

Constructor Detail

CocoonRequestWrapper

public CocoonRequestWrapper(Request cocoonRequest)

Constructs a wrapper for the given Cocoon request.

Parameters:

cocoonRequest - The request as viewed by Cocoon.

CocoonRequestWrapper

public CocoonRequestWrapper(Request cocoonRequest,
                            HttpServletRequest servletRequest)

Constructs a wrapper for the given Cocoon request.

Parameters:

cocoonRequest - The request as viewed by Cocoon.

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Specified by:

getInputStream in interface RequestWrapper

Throws:

java.io.IOException

See Also:

javax.servlet.http.HttpServletRequest#getInputStream()

get

public java.lang.Object get(java.lang.String arg0)

See Also:

org.apache.cocoon.environment.Request#get(String)

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getCharacterEncoding()

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getContentLength()

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getContentType()

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getContextPath()

getCookieMap

public java.util.Map getCookieMap()

See Also:

org.apache.cocoon.environment.Request#getCookieMap()

getHeader

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

Specified by:

getHeader in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getHeader(String)

getHeaderNames

public java.util.Enumeration getHeaderNames()

Specified by:

getHeaderNames in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getHeaderNames()

getHeaders

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

Specified by:

getHeaders in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getHeaders(String)

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getMethod()

getParameter

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

Specified by:

getParameter in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getParameter(String)

getParameterNames

public java.util.Enumeration getParameterNames()

Specified by:

getParameterNames in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getParameterNames()

getParameterValues

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

Specified by:

getParameterValues in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getParameterValues(String)

getPathInfo

public java.lang.String getPathInfo()

Specified by:

getPathInfo in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getPathInfo()

getPathTranslated

public java.lang.String getPathTranslated()

Specified by:

getPathTranslated in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getPathTranslated()

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getProtocol()

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getQueryString()

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getRemoteAddr()

getRemoteHost

public java.lang.String getRemoteHost()

Specified by:

getRemoteHost in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getRemoteHost()

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getRemoteUser()

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getRequestedSessionId()

getRequestURI

public java.lang.String getRequestURI()

Specified by:

getRequestURI in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getRequestURI()

getRequestURL

public java.lang.StringBuffer getRequestURL()

Specified by:

getRequestURL in interface RequestWrapper

See Also:

javax.servlet.http.HttpServletRequest#getRequestURL()

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getScheme()

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getServerName()

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getServerPort()

getServletPath

public java.lang.String getServletPath()

Specified by:

getServletPath in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getServletPath()()

getSession

public SessionWrapper getSession()

Specified by:

getSession in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getSession()

getSession

public SessionWrapper getSession(boolean arg0)

Specified by:

getSession in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getSession(boolean)

getSitemapURI

public java.lang.String getSitemapURI()

See Also:

org.apache.cocoon.environment.Request#getSitemapURI()

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#getUserPrincipal()

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#isRequestedSessionIdFromCookie()

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#isRequestedSessionIdFromURL()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#isRequestedSessionIdValid()

isSecure

public boolean isSecure()

Specified by:

isSecure in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#isSecure()

isUserInRole

public boolean isUserInRole(java.lang.String arg0)

Specified by:

isUserInRole in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#isUserInRole(String)

removeAttribute

public void removeAttribute(java.lang.String arg0)

Specified by:

removeAttribute in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#removeAttribute(String)

setAttribute

public void setAttribute(java.lang.String arg0,
                         java.lang.Object arg1)

Specified by:

setAttribute in interface RequestWrapper

See Also:

org.apache.cocoon.environment.Request#setAttribute(String, Object)

setCharacterEncoding

public void setCharacterEncoding(java.lang.String arg0)
                          throws java.io.UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface RequestWrapper

Throws:

java.io.UnsupportedEncodingException

See Also:

org.apache.cocoon.environment.Request#setCharacterEncoding(String)

getFileUploadParam

public java.io.File getFileUploadParam(java.lang.String parameter)

Specified by:

getFileUploadParam in interface RequestWrapper

getUploadedFileName

public java.lang.String getUploadedFileName(java.lang.String parameter)

Specified by:

getUploadedFileName in interface RequestWrapper