org.springframework.mock.web.portlet
Class MockPortletRequest

java.lang.Object
  org.springframework.mock.web.portlet.MockPortletRequest

Direct Known Subclasses:

MockClientDataRequest, MockEventRequest, MockRenderRequest

public class MockPortletRequest
extends java.lang.Object

Mock implementation of the javax.portlet.PortletRequest interface.

Since:

2.0

Author:

John A. Lewis, Juergen Hoeller

Field Summary

private boolean	active
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private java.lang.String	authType
private java.lang.String	contextPath
private Cookie[]	cookies
private java.util.List<java.util.Locale>	locales
private java.util.Map<java.lang.String,java.lang.String[]>	parameters
private PortalContext	portalContext
private PortletContext	portletContext
private PortletMode	portletMode
private PortletPreferences	portletPreferences
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	properties
private java.util.Set<java.lang.String>	publicParameterNames
private java.lang.String	remoteUser
private boolean	requestedSessionIdValid
private java.util.List<java.lang.String>	responseContentTypes
private java.lang.String	scheme
private boolean	secure
private java.lang.String	serverName
private int	serverPort
private PortletSession	session
private java.security.Principal	userPrincipal
private java.util.Set<java.lang.String>	userRoles
private java.lang.String	windowID
private WindowState	windowState

Constructor Summary

MockPortletRequest()
Create a new MockPortletRequest with a default MockPortalContext and a default MockPortletContext.

MockPortletRequest(PortalContext portalContext, PortletContext portletContext)
Create a new MockPortletRequest.

MockPortletRequest(PortletContext portletContext)
Create a new MockPortletRequest with a default MockPortalContext.

Method Summary

void	addLocale(java.util.Locale locale)
void	addParameter(java.lang.String name, java.lang.String value)
void	addParameter(java.lang.String name, java.lang.String[] values)
void	addPreferredLocale(java.util.Locale locale)
void	addPreferredResponseContentType(java.lang.String responseContentType)
void	addProperty(java.lang.String key, java.lang.String value) Add a single value for the specified property.
void	addResponseContentType(java.lang.String responseContentType)
void	addUserRole(java.lang.String role)
protected void	checkActive() Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.
void	close() Mark this request as completed.
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration<java.lang.String>	getAttributeNames()
java.lang.String	getAuthType()
java.lang.String	getContextPath()
Cookie[]	getCookies()
protected java.lang.String	getLifecyclePhase() Return the Portlet 2.0 lifecycle id for the current phase.
java.util.Locale	getLocale()
java.util.Enumeration<java.util.Locale>	getLocales()
java.lang.String	getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap()
java.util.Enumeration<java.lang.String>	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
PortalContext	getPortalContext()
PortletMode	getPortletMode()
PortletSession	getPortletSession()
PortletSession	getPortletSession(boolean create)
PortletPreferences	getPreferences()
java.util.Map<java.lang.String,java.lang.String[]>	getPrivateParameterMap()
java.util.Enumeration<java.lang.String>	getProperties(java.lang.String key)
java.lang.String	getProperty(java.lang.String key)
java.util.Enumeration<java.lang.String>	getPropertyNames()
java.util.Map<java.lang.String,java.lang.String[]>	getPublicParameterMap()
java.lang.String	getRemoteUser()
java.lang.String	getRequestedSessionId()
java.lang.String	getResponseContentType()
java.util.Enumeration<java.lang.String>	getResponseContentTypes()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
java.security.Principal	getUserPrincipal()
java.lang.String	getWindowID()
WindowState	getWindowState()
boolean	isActive() Return whether this request is still active (that is, not completed yet).
boolean	isPortletModeAllowed(PortletMode portletMode)
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(java.lang.String role)
boolean	isWindowStateAllowed(WindowState windowState)
void	registerPublicParameter(java.lang.String name)
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setAuthType(java.lang.String authType)
void	setContextPath(java.lang.String contextPath)
void	setCookies(Cookie... cookies)
void	setParameter(java.lang.String key, java.lang.String value)
void	setParameter(java.lang.String key, java.lang.String[] values)
void	setParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)
void	setPortletMode(PortletMode portletMode)
void	setPreferences(PortletPreferences preferences)
void	setProperty(java.lang.String key, java.lang.String value) Set a single value for the specified property.
void	setRemoteUser(java.lang.String remoteUser)
void	setRequestedSessionIdValid(boolean requestedSessionIdValid)
void	setScheme(java.lang.String scheme)
void	setSecure(boolean secure)
void	setServerName(java.lang.String serverName)
void	setServerPort(int serverPort)
void	setSession(PortletSession session)
void	setUserPrincipal(java.security.Principal userPrincipal)
void	setWindowID(java.lang.String windowID)
void	setWindowState(WindowState windowState)

Methods inherited from class java.lang.Object

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

Field Detail

active

private boolean active

portalContext

private final PortalContext portalContext

portletContext

private final PortletContext portletContext

session

private PortletSession session

windowState

private WindowState windowState

portletMode

private PortletMode portletMode

portletPreferences

private PortletPreferences portletPreferences

properties

private final java.util.Map<java.lang.String,java.util.List<java.lang.String>> properties

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

parameters

private final java.util.Map<java.lang.String,java.lang.String[]> parameters

authType

private java.lang.String authType

contextPath

private java.lang.String contextPath

remoteUser

private java.lang.String remoteUser

userPrincipal

private java.security.Principal userPrincipal

userRoles

private final java.util.Set<java.lang.String> userRoles

secure

private boolean secure

requestedSessionIdValid

private boolean requestedSessionIdValid

responseContentTypes

private final java.util.List<java.lang.String> responseContentTypes

locales

private final java.util.List<java.util.Locale> locales

scheme

private java.lang.String scheme

serverName

private java.lang.String serverName

serverPort

private int serverPort

windowID

private java.lang.String windowID

cookies

private Cookie[] cookies

publicParameterNames

private final java.util.Set<java.lang.String> publicParameterNames

Constructor Detail

MockPortletRequest

public MockPortletRequest()

Create a new MockPortletRequest with a default MockPortalContext and a default MockPortletContext.

See Also:

MockPortalContext, MockPortletContext

MockPortletRequest

public MockPortletRequest(PortletContext portletContext)

Create a new MockPortletRequest with a default MockPortalContext.

Parameters:

portletContext - the PortletContext that the request runs in

See Also:

MockPortalContext

MockPortletRequest

public MockPortletRequest(PortalContext portalContext,
                          PortletContext portletContext)

Create a new MockPortletRequest.

Parameters:

portalContext - the PortalContext that the request runs in

portletContext - the PortletContext that the request runs in

Method Detail

getLifecyclePhase

protected java.lang.String getLifecyclePhase()

Return the Portlet 2.0 lifecycle id for the current phase.

isActive

public boolean isActive()

Return whether this request is still active (that is, not completed yet).

close

public void close()

Mark this request as completed.

checkActive

protected void checkActive()
                    throws java.lang.IllegalStateException

Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.

Throws:

java.lang.IllegalStateException

isWindowStateAllowed

public boolean isWindowStateAllowed(WindowState windowState)

isPortletModeAllowed

public boolean isPortletModeAllowed(PortletMode portletMode)

setPortletMode

public void setPortletMode(PortletMode portletMode)

getPortletMode

public PortletMode getPortletMode()

setWindowState

public void setWindowState(WindowState windowState)

getWindowState

public WindowState getWindowState()

setPreferences

public void setPreferences(PortletPreferences preferences)

getPreferences

public PortletPreferences getPreferences()

setSession

public void setSession(PortletSession session)

getPortletSession

public PortletSession getPortletSession()

getPortletSession

public PortletSession getPortletSession(boolean create)

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Set a single value for the specified property.

If there are already one or more values registered for the given property key, they will be replaced.

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

Add a single value for the specified property.

If there are already one or more values registered for the given property key, the given value will be added to the end of the list.

getProperty

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

getProperties

public java.util.Enumeration<java.lang.String> getProperties(java.lang.String key)

getPropertyNames

public java.util.Enumeration<java.lang.String> getPropertyNames()

getPortalContext

public PortalContext getPortalContext()

setAuthType

public void setAuthType(java.lang.String authType)

getAuthType

public java.lang.String getAuthType()

setContextPath

public void setContextPath(java.lang.String contextPath)

getContextPath

public java.lang.String getContextPath()

setRemoteUser

public void setRemoteUser(java.lang.String remoteUser)

getRemoteUser

public java.lang.String getRemoteUser()

setUserPrincipal

public void setUserPrincipal(java.security.Principal userPrincipal)

getUserPrincipal

public java.security.Principal getUserPrincipal()

addUserRole

public void addUserRole(java.lang.String role)

isUserInRole

public boolean isUserInRole(java.lang.String role)

getAttribute

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

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String[] values)

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String[] values)

getParameter

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

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

getParameterValues

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

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

setSecure

public void setSecure(boolean secure)

isSecure

public boolean isSecure()

setAttribute

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

removeAttribute

public void removeAttribute(java.lang.String name)

getRequestedSessionId

public java.lang.String getRequestedSessionId()

setRequestedSessionIdValid

public void setRequestedSessionIdValid(boolean requestedSessionIdValid)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

addResponseContentType

public void addResponseContentType(java.lang.String responseContentType)

addPreferredResponseContentType

public void addPreferredResponseContentType(java.lang.String responseContentType)

getResponseContentType

public java.lang.String getResponseContentType()

getResponseContentTypes

public java.util.Enumeration<java.lang.String> getResponseContentTypes()

addLocale

public void addLocale(java.util.Locale locale)

addPreferredLocale

public void addPreferredLocale(java.util.Locale locale)

getLocale

public java.util.Locale getLocale()

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

setScheme

public void setScheme(java.lang.String scheme)

getScheme

public java.lang.String getScheme()

setServerName

public void setServerName(java.lang.String serverName)

getServerName

public java.lang.String getServerName()

setServerPort

public void setServerPort(int serverPort)

getServerPort

public int getServerPort()

setWindowID

public void setWindowID(java.lang.String windowID)

getWindowID

public java.lang.String getWindowID()

setCookies

public void setCookies(Cookie... cookies)

getCookies

public Cookie[] getCookies()

getPrivateParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getPrivateParameterMap()

getPublicParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getPublicParameterMap()

registerPublicParameter

public void registerPublicParameter(java.lang.String name)