net.sf.jportlet.portlet
Interface PortletRequest

All Superinterfaces:

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

All Known Implementing Classes:

PortletRequestImpl

public interface PortletRequest

extends javax.servlet.http.HttpServletRequest

The PortletRequest encapsulates the request sent by the client to the portlet

Author:

Herve Tchepannou

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Method Summary

net.sf.jportlet.portlet.Client	getClient() Returns informations about the client device
net.sf.jportlet.portlet.PortletData	getData() Returns the data of the portlet
Portlet.Mode	getMode() Returns the mode of the portlet
net.sf.jportlet.portlet.PortletSession	getPortletSession() Returns the current session or, if there is no current session, it creates one and returns it.
net.sf.jportlet.portlet.PortletSession	getPortletSession(boolean create) Returns the current session or, if there is no current session and the given flag is true, it creates one and returns it.
net.sf.jportlet.portlet.PortletSettings	getSettings() Returns the settings of the portlet
net.sf.jportlet.portlet.User	getUser() Return the information of the current user.
net.sf.jportlet.portlet.PortletWindow	getWindow() Return the window of the portlet

Methods inherited from interface javax.servlet.http.HttpServletRequest

getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from interface javax.servlet.ServletRequest

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Method Detail

getClient

public net.sf.jportlet.portlet.Client getClient()

Returns informations about the client device

Returns:

Client

getData

public net.sf.jportlet.portlet.PortletData getData()

Returns the data of the portlet

Returns:

PortletData

getMode

public Portlet.Mode getMode()

Returns the mode of the portlet

Returns:

Mode

getPortletSession

public net.sf.jportlet.portlet.PortletSession getPortletSession()

Returns the current session or, if there is no current session, it creates one and returns it.

Returns:

PortletSession

getPortletSession

public net.sf.jportlet.portlet.PortletSession getPortletSession(boolean create)

Returns the current session or, if there is no current session and the given flag is true, it creates one and returns it.

Parameters:

create - flag to create the session

Returns:

PortletSession

getSettings

public net.sf.jportlet.portlet.PortletSettings getSettings()

Returns the settings of the portlet

Returns:

PortletSettings

getUser

public net.sf.jportlet.portlet.User getUser()

Return the information of the current user. If the user has not logged in, this method will return null

Returns:

User

getWindow

public net.sf.jportlet.portlet.PortletWindow getWindow()

Return the window of the portlet

Returns:

PortletWindow