org.apache.wicket.portlet

Class PortletServletRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.apache.wicket.portlet.PortletServletRequestWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class PortletServletRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper

Wraps servlet request object with Portlet specific functionality by overriding the HttpServletRequestWrapper retrieval of the context path, path info, request URI etc... to return the portal specific translations. FIXME javadoc

Author:

Ate Douma, Sebastian Thomschke, Peter Pastrnak, Ronny Pscheidl

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Modifier	Constructor and Description
	PortletServletRequestWrapper(javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession proxiedSession, String filterPath) FIXME javadoc
	PortletServletRequestWrapper(javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession proxiedSession, String filterPath, String pathInfo) FIXME javadoc
protected	PortletServletRequestWrapper(javax.servlet.ServletContext context, javax.servlet.http.HttpSession proxiedSession, javax.servlet.http.HttpServletRequest request, String filterPath) Package private constructor which is called from either of the two public constructors - sets up the various portlet specific versions of the context path, servlet path, request URI etc...

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String name)
String	getContextPath()
String	getHeader(String name)
Enumeration	getHeaders(String name)
String	getPathInfo()
String	getQueryString()
String	getRequestURI()
String	getServletPath()
javax.servlet.http.HttpSession	getSession()
javax.servlet.http.HttpSession	getSession(boolean create)
void	setCharacterEncoding(String enc)

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getAuthType, getCookies, getDateHeader, getHeaderNames, getIntHeader, getMethod, getPart, getParts, getPathTranslated, getRemoteUser, getRequestedSessionId, getRequestURL, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, startAsync, startAsync

Constructor Detail

PortletServletRequestWrapper

public PortletServletRequestWrapper(javax.servlet.ServletContext context,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpSession proxiedSession,
                            String filterPath)

FIXME javadoc

Public constructor which internally builds the path info from request URI, instead of deriving it.

Parameters:

context -

request -

proxiedSession -

filterPath -

PortletServletRequestWrapper

public PortletServletRequestWrapper(javax.servlet.ServletContext context,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpSession proxiedSession,
                            String filterPath,
                            String pathInfo)

FIXME javadoc

Public constructor called when not running in a portlet environment, which is passed in the path info instead of deriving it. It overrides the generated request URI from the internal constructor.

Parameters:

context -

request -

proxiedSession -

filterPath - ???

pathInfo - ???

PortletServletRequestWrapper

protected PortletServletRequestWrapper(javax.servlet.ServletContext context,
                            javax.servlet.http.HttpSession proxiedSession,
                            javax.servlet.http.HttpServletRequest request,
                            String filterPath)

Package private constructor which is called from either of the two public constructors - sets up the various portlet specific versions of the context path, servlet path, request URI etc...

Parameters:

context -

proxiedSession -

request -

filterPath -

Method Detail

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface javax.servlet.ServletRequest

Overrides:

getAttribute in class javax.servlet.ServletRequestWrapper

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getContextPath in class javax.servlet.http.HttpServletRequestWrapper

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

Overrides:

getPathInfo in class javax.servlet.http.HttpServletRequestWrapper

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

Overrides:

getQueryString in class javax.servlet.http.HttpServletRequestWrapper

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestURI in class javax.servlet.http.HttpServletRequestWrapper

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getServletPath in class javax.servlet.http.HttpServletRequestWrapper

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Overrides:

getSession in class javax.servlet.http.HttpServletRequestWrapper

getSession

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

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Overrides:

getSession in class javax.servlet.http.HttpServletRequestWrapper

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeader in class javax.servlet.http.HttpServletRequestWrapper

getHeaders

public Enumeration getHeaders(String name)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeaders in class javax.servlet.http.HttpServletRequestWrapper

setCharacterEncoding

public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

setCharacterEncoding in class javax.servlet.ServletRequestWrapper

Throws:

UnsupportedEncodingException

See Also:

ServletRequestWrapper.setCharacterEncoding(java.lang.String)