javax.portlet
Interface PortletRequest

All Known Subinterfaces:

ActionRequest, RenderRequest

All Known Implementing Classes:

ActionRequestImpl, JBossActionRequest, JBossRenderRequest, PortletRequestImpl, RenderRequestImpl

public interface PortletRequest

Field Summary

static java.lang.String	BASIC_AUTH
static java.lang.String	CLIENT_CERT_AUTH
static java.lang.String	DIGEST_AUTH
static java.lang.String	FORM_AUTH
static java.lang.String	USER_INFO

Method Summary

java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration	getAttributeNames()
java.lang.String	getAuthType()
java.lang.String	getContextPath()
java.util.Locale	getLocale()
java.util.Enumeration	getLocales()
java.lang.String	getParameter(java.lang.String name)
java.util.Map	getParameterMap()
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
PortalContext	getPortalContext()
PortletMode	getPortletMode()
PortletSession	getPortletSession()
PortletSession	getPortletSession(boolean create)
PortletPreferences	getPreferences()
java.util.Enumeration	getProperties(java.lang.String name)
java.lang.String	getProperty(java.lang.String name)
java.util.Enumeration	getPropertyNames()
java.lang.String	getRemoteUser()
java.lang.String	getRequestedSessionId()
java.lang.String	getResponseContentType()
java.util.Enumeration	getResponseContentTypes()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
java.security.Principal	getUserPrincipal()
WindowState	getWindowState()
boolean	isPortletModeAllowed(PortletMode mode)
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(java.lang.String role)
boolean	isWindowStateAllowed(WindowState state)
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object o)

Field Detail

BASIC_AUTH

static final java.lang.String BASIC_AUTH

See Also:

Constant Field Values

FORM_AUTH

static final java.lang.String FORM_AUTH

See Also:

Constant Field Values

CLIENT_CERT_AUTH

static final java.lang.String CLIENT_CERT_AUTH

See Also:

Constant Field Values

DIGEST_AUTH

static final java.lang.String DIGEST_AUTH

See Also:

Constant Field Values

USER_INFO

static final java.lang.String USER_INFO

See Also:

Constant Field Values

Method Detail

isWindowStateAllowed

boolean isWindowStateAllowed(WindowState state)

isPortletModeAllowed

boolean isPortletModeAllowed(PortletMode mode)

getPortletMode

PortletMode getPortletMode()

getWindowState

WindowState getWindowState()

getPreferences

PortletPreferences getPreferences()

getPortletSession

PortletSession getPortletSession()

getPortletSession

PortletSession getPortletSession(boolean create)

getProperty

java.lang.String getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getProperties

java.util.Enumeration getProperties(java.lang.String name)
                                    throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getPropertyNames

java.util.Enumeration getPropertyNames()

getPortalContext

PortalContext getPortalContext()

getAuthType

java.lang.String getAuthType()

getContextPath

java.lang.String getContextPath()

getRemoteUser

java.lang.String getRemoteUser()

getUserPrincipal

java.security.Principal getUserPrincipal()

isUserInRole

boolean isUserInRole(java.lang.String role)

getAttribute

java.lang.Object getAttribute(java.lang.String name)
                              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getAttributeNames

java.util.Enumeration getAttributeNames()

getParameter

java.lang.String getParameter(java.lang.String name)
                              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getParameterNames

java.util.Enumeration getParameterNames()

getParameterValues

java.lang.String[] getParameterValues(java.lang.String name)
                                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getParameterMap

java.util.Map getParameterMap()

isSecure

boolean isSecure()

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.Object o)
                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

removeAttribute

void removeAttribute(java.lang.String name)
                     throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getRequestedSessionId

java.lang.String getRequestedSessionId()

isRequestedSessionIdValid

boolean isRequestedSessionIdValid()

getResponseContentType

java.lang.String getResponseContentType()

getResponseContentTypes

java.util.Enumeration getResponseContentTypes()

getLocale

java.util.Locale getLocale()

getLocales

java.util.Enumeration getLocales()

getScheme

java.lang.String getScheme()

getServerName

java.lang.String getServerName()

getServerPort

int getServerPort()