PageRequestContext - JBOSS Portal 2.2 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.theme.page
Interface PageRequestContext

All Known Implementing Classes:: PageRequestContextImpl

public interface PageRequestContext

Method Summary

javax.servlet.http.HttpServletRequest getHttpRequest()
          Get the HttpServletRequest that caused the current page request.

java.util.Map getPageProperties()
          Get the map of page properties for the currently requested page.

java.util.Map getPortalProperties()
          Get the map of portal properties for the currently requested portal.

java.util.List getPortletContexts()
          Get a map of all portlets on the currently requested page with their state information.

java.lang.String[] getRegionNames()
          Get an array of the names of all the regions on the currently requested page.

ServerRequest getServerRequest()
          Get the server request that caused this page request.

HTTPStreamInfo getStreamInfo()
          Get the StreamInfo for the current request.

java.util.Set getSupportedPortletModes()
          Get the portlet modes that are supported by the requested portal.

java.util.Set getSupportedWindowStates()
          Get the window states that are supported by the requested portal.

PortletContext getTargetPortlet()
          Get the portlet context for the targeted portlet, if any.

Method Detail

getSupportedWindowStates

public java.util.Set getSupportedWindowStates()

Get the window states that are supported by the requested portal.

Note: These are the states supported by the portal. Each indivudual portlet can support a subset of these states.

Returns:: the supported window states

getSupportedPortletModes

public java.util.Set getSupportedPortletModes()

Get the portlet modes that are supported by the requested portal.

Note: These are the modes supported by the portal. Each indivudual portlet can support a subset of these modes.

Returns:: the supported portlet modes

getHttpRequest

public javax.servlet.http.HttpServletRequest getHttpRequest()

Get the HttpServletRequest that caused the current page request.

Returns:: the http servlet request

getStreamInfo

public HTTPStreamInfo getStreamInfo()

Get the StreamInfo for the current request.

The stream info allows access to content type and char encoding that will be used to write the response of this request.

Returns:: the stream info for the current request

getPortalProperties

public java.util.Map getPortalProperties()

Get the map of portal properties for the currently requested portal.

Returns:: a map of portal properties

getPageProperties

public java.util.Map getPageProperties()

Get the map of page properties for the currently requested page.

Returns:: a map of page properties

getPortletContexts

public java.util.List getPortletContexts()

Get a map of all portlets on the currently requested page with their state information.

Returns:: a map of portlets on the currently requested page

getTargetPortlet

public PortletContext getTargetPortlet()

Get the portlet context for the targeted portlet, if any.

Returns:: the portlet context for the targeted portlet, or null if no portlet was targeted with the current request

getRegionNames

public java.lang.String[] getRegionNames()

Get an array of the names of all the regions on the currently requested page.

Returns:: the names of all the regions on the currently requested page

getServerRequest

public ServerRequest getServerRequest()

Get the server request that caused this page request.

Returns:: the current server request