org.apache.pluto.internal
Interface InternalPortletRequest

All Superinterfaces:
PortletRequest
All Known Subinterfaces:
InternalActionRequest, InternalEventRequest, InternalRenderRequest, InternalResourceRequest
All Known Implementing Classes:
ActionRequestImpl, EventRequestImpl, PortletRequestImpl, RenderRequestImpl, ResourceRequestImpl

public interface InternalPortletRequest
extends PortletRequest

The internal portlet request interface extends PortletRequest and adds some methods used by Pluto.


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest
PortletRequest.P3PUserInfos
 
Field Summary
 
Fields inherited from interface javax.portlet.PortletRequest
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO
 
Method Summary
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
           
 InternalPortletWindow getInternalPortletWindow()
           
 java.lang.String getLifecyclePhase()
           
 PortletContainer getPortletContainer()
           
 void init(PortletContext context, javax.servlet.http.HttpServletRequest request)
          Initializes the portlet request for use within the target context.
 boolean isForwarded()
           
 boolean isIncluded()
          Returns true if a jsp or servlet is included.
 void release()
          Recycle the request by rolling the underlying request back to the originating request.
 void setAttribute(java.lang.String name, java.lang.Object object)
          Stores an attribute in this request.
 void setForwarded(boolean forwarded)
           
 void setForwardedQueryString(java.lang.String queryString)
           
 void setIncluded(boolean included)
          Is set true when a jsp, servlet is included.
 void setIncludedQueryString(java.lang.String queryString)
           
 
Methods inherited from interface javax.portlet.PortletRequest
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute
 

Method Detail

init

void init(PortletContext context,
          javax.servlet.http.HttpServletRequest request)
Initializes the portlet request for use within the target context. This method ensures that the portlet utilizes resources from the included context, and not those from the intiating (portal) context.

Parameters:
context - the target portlet context.
request - the servlet request.

release

void release()
Recycle the request by rolling the underlying request back to the originating request.


getInternalPortletWindow

InternalPortletWindow getInternalPortletWindow()

getPortletContainer

PortletContainer getPortletContainer()

getHttpServletRequest

javax.servlet.http.HttpServletRequest getHttpServletRequest()

setIncluded

void setIncluded(boolean included)
Is set true when a jsp, servlet is included.

Parameters:
included - true when included

isIncluded

boolean isIncluded()
Returns true if a jsp or servlet is included.

Returns:
true if a jsp or servlet is included.

setIncludedQueryString

void setIncludedQueryString(java.lang.String queryString)

setForwarded

void setForwarded(boolean forwarded)

isForwarded

boolean isForwarded()

setForwardedQueryString

void setForwardedQueryString(java.lang.String queryString)

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.Object object)
Description copied from interface: PortletRequest
Stores an attribute in this request.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.* are reserved.
If the value passed into this method is null, the effect is the same as calling PortletRequest.removeAttribute(java.lang.String).

Specified by:
setAttribute in interface PortletRequest
Parameters:
name - a String specifying the name of the attribute
object - the Object to be stored

getLifecyclePhase

java.lang.String getLifecyclePhase()


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.