站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Spring Framework 2.0.5 API 文档英文版

PortletRequestWrapper (Spring Framework API 2.0) - Spring Framework 2.0.5 API 文档英文版

The Spring Framework

org.springframework.web.portlet.util
Class PortletRequestWrapper

java.lang.Object
  extended by org.springframework.web.portlet.util.PortletRequestWrapper
All Implemented Interfaces:
PortletRequest
Direct Known Subclasses:
ActionRequestWrapper

public class PortletRequestWrapper
extends Object
implements PortletRequest

Simple wrapper for a PortletRequest, delegating all calls to the underlying request.

(In the style of the Servlet API's ServletRequestWrapper.)

Since:
2.0
Author:
Juergen Hoeller
See Also:
ActionRequestWrapper, ServletRequestWrapper

Field Summary
 
Fields inherited from interface javax.portlet.PortletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH, USER_INFO
 
Constructor Summary
PortletRequestWrapper(PortletRequest request)
          Create a PortletRequestWrapper for the given PortletRequest.
 
Method Summary
 Object getAttribute(String name)
           
 Enumeration getAttributeNames()
           
 String getAuthType()
           
 String getContextPath()
           
 Locale getLocale()
           
 Enumeration getLocales()
           
 String getParameter(String name)
           
 Map getParameterMap()
           
 Enumeration getParameterNames()
           
 String[] getParameterValues(String name)
           
 PortalContext getPortalContext()
           
 PortletMode getPortletMode()
           
 PortletSession getPortletSession()
           
 PortletSession getPortletSession(boolean create)
           
 PortletPreferences getPreferences()
           
 Enumeration getProperties(String name)
           
 String getProperty(String name)
           
 Enumeration getPropertyNames()
           
 String getRemoteUser()
           
 String getRequestedSessionId()
           
 String getResponseContentType()
           
 Enumeration getResponseContentTypes()
           
 String getScheme()
           
 String getServerName()
           
 int getServerPort()
           
 Principal getUserPrincipal()
           
 WindowState getWindowState()
           
 boolean isPortletModeAllowed(PortletMode mode)
           
 boolean isRequestedSessionIdValid()
           
 boolean isSecure()
           
 boolean isUserInRole(String role)
           
 boolean isWindowStateAllowed(WindowState state)
           
 void removeAttribute(String name)
           
 void setAttribute(String name, Object value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletRequestWrapper

public PortletRequestWrapper(PortletRequest request)
Create a PortletRequestWrapper for the given PortletRequest.

Parameters:
request - the original PortletRequest to wrap
Throws:
IllegalArgumentException - if the supplied request is null
Method Detail

isWindowStateAllowed

public boolean isWindowStateAllowed(WindowState state)
Specified by:
isWindowStateAllowed in interface PortletRequest

isPortletModeAllowed

public boolean isPortletModeAllowed(PortletMode mode)
Specified by:
isPortletModeAllowed in interface PortletRequest

getPortletMode

public PortletMode getPortletMode()
Specified by:
getPortletMode in interface PortletRequest

getWindowState

public WindowState getWindowState()
Specified by:
getWindowState in interface PortletRequest

getPreferences

public PortletPreferences getPreferences()
Specified by:
getPreferences in interface PortletRequest

getPortletSession

public PortletSession getPortletSession()
Specified by:
getPortletSession in interface PortletRequest

getPortletSession

public PortletSession getPortletSession(boolean create)
Specified by:
getPortletSession in interface PortletRequest

getProperty

public String getProperty(String name)
Specified by:
getProperty in interface PortletRequest

getProperties

public Enumeration getProperties(String name)
Specified by:
getProperties in interface PortletRequest

getPropertyNames

public Enumeration getPropertyNames()
Specified by:
getPropertyNames in interface PortletRequest

getPortalContext

public PortalContext getPortalContext()
Specified by:
getPortalContext in interface PortletRequest

getAuthType

public String getAuthType()
Specified by:
getAuthType in interface PortletRequest

getContextPath

public String getContextPath()
Specified by:
getContextPath in interface PortletRequest

getRemoteUser

public String getRemoteUser()
Specified by:
getRemoteUser in interface PortletRequest

getUserPrincipal

public Principal getUserPrincipal()
Specified by:
getUserPrincipal in interface PortletRequest

isUserInRole

public boolean isUserInRole(String role)
Specified by:
isUserInRole in interface PortletRequest

getAttribute

public Object getAttribute(String name)
Specified by:
getAttribute in interface PortletRequest

getAttributeNames

public Enumeration getAttributeNames()
Specified by:
getAttributeNames in interface PortletRequest

getParameter

public String getParameter(String name)
Specified by:
getParameter in interface PortletRequest

getParameterNames

public Enumeration getParameterNames()
Specified by:
getParameterNames in interface PortletRequest

getParameterValues

public String[] getParameterValues(String name)
Specified by:
getParameterValues in interface PortletRequest

getParameterMap

public Map getParameterMap()
Specified by:
getParameterMap in interface PortletRequest

isSecure

public boolean isSecure()
Specified by:
isSecure in interface PortletRequest

setAttribute

public void setAttribute(String name,
                         Object value)
Specified by:
setAttribute in interface PortletRequest

removeAttribute

public void removeAttribute(String name)
Specified by:
removeAttribute in interface PortletRequest

getRequestedSessionId

public String getRequestedSessionId()
Specified by:
getRequestedSessionId in interface PortletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()
Specified by:
isRequestedSessionIdValid in interface PortletRequest

getResponseContentType

public String getResponseContentType()
Specified by:
getResponseContentType in interface PortletRequest

getResponseContentTypes

public Enumeration getResponseContentTypes()
Specified by:
getResponseContentTypes in interface PortletRequest

getLocale

public Locale getLocale()
Specified by:
getLocale in interface PortletRequest

getLocales

public Enumeration getLocales()
Specified by:
getLocales in interface PortletRequest

getScheme

public String getScheme()
Specified by:
getScheme in interface PortletRequest

getServerName

public String getServerName()
Specified by:
getServerName in interface PortletRequest

getServerPort

public int getServerPort()
Specified by:
getServerPort in interface PortletRequest

The Spring Framework

Copyright © 2002-2007 The Spring Framework.