portletrequestwrapper.html

门户开发

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the last mode that is kept for this portlet on the mode
 stack, or <CODE>null</CODE> if no previous mode exists.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../org/apache/jetspeed/portlet/User.html" title="interface in org.apache.jetspeed.portlet">User</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/ibm/wps/pe/pc/legacy/cmpf/PortletRequestWrapper.html#getUser()">getUser</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the user object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletWindow.html" title="interface in org.apache.jetspeed.portlet">PortletWindow</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/ibm/wps/pe/pc/legacy/cmpf/PortletRequestWrapper.html#getWindow()">getWindow</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the window that the portlet is running in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/ibm/wps/pe/pc/legacy/cmpf/PortletRequestWrapper.html#invalidateCache()">invalidateCache</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invalidates the cache for all window states, markups and locals</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/ibm/wps/pe/pc/legacy/cmpf/PortletRequestWrapper.html#setModeModifier(org.apache.jetspeed.portlet.Portlet.ModeModifier)">setModeModifier</A></B>(<A HREF="../../../../../../../org/apache/jetspeed/portlet/Portlet.ModeModifier.html" title="class in org.apache.jetspeed.portlet">Portlet.ModeModifier</A>&nbsp;modeModifier)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines which portlet mode is shown next.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.http.HttpServletRequestWrapper"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class javax.servlet.http.HttpServletRequestWrapper</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>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</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.ServletRequestWrapper"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class javax.servlet.ServletRequestWrapper</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.jetspeed.portlet.PortletRequest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.jetspeed.portlet.<A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getAttributeNames()">getAttributeNames</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getCookies()">getCookies</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getDateHeader(java.lang.String)">getDateHeader</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getHeader(java.lang.String)">getHeader</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getHeaderNames()">getHeaderNames</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getHeaders(java.lang.String)">getHeaders</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getInputStream()">getInputStream</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getIntHeader(java.lang.String)">getIntHeader</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getLocale()">getLocale</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getLocales()">getLocales</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getMethod()">getMethod</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameter(java.lang.String)">getParameter</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterMap()">getParameterMap</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterNames()">getParameterNames</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterValues(java.lang.String)">getParameterValues</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#isSecure()">isSecure</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.http.HttpServletRequest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.http.HttpServletRequest</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>getAuthType, getContextPath, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.ServletRequest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.ServletRequest</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>getCharacterEncoding, getContentLength, getContentType, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, setCharacterEncoding</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="PortletRequestWrapper(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
PortletRequestWrapper</H3>
<PRE>
public <B>PortletRequestWrapper</B>(<A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;portletRequest)</PRE>
<DL>
<DD>Creates a PortletRequest adaptor wrapping the specified request object.
<P>
<DT><B>Parameters:</B><DD><CODE>portletRequest</CODE> - the portlet request
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the request is null</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getPortletRequest()"><!-- --></A><H3>
getPortletRequest</H3>
<PRE>
protected <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A> <B>getPortletRequest</B>()</PRE>
<DL>
<DD>Returns the wrapped ServletRequest object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMode()"><!-- --></A><H3>
getMode</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/Portlet.Mode.html" title="class in org.apache.jetspeed.portlet">Portlet.Mode</A> <B>getMode</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the mode that the portlet is running in.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getMode()">getMode</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet mode</DL>
</DD>
</DL>
<HR>

<A NAME="getPreviousMode()"><!-- --></A><H3>
getPreviousMode</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/Portlet.Mode.html" title="class in org.apache.jetspeed.portlet">Portlet.Mode</A> <B>getPreviousMode</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the last mode that is kept for this portlet on the mode
 stack, or <CODE>null</CODE> if no previous mode exists.
 <p>
 Note that the result is not necessarily the last mode that this 
 portlet was running in. For example, if the portlet starts in view 
 mode, changes to edit mode and then goes back to view mode through
 a return URL or by using <CODE>PortletMode.ModeModifier.PREVIOUS</CODE>,
 then <CODE>getPreviousMode</CODE> will return <CODE>null</CODE>
 because the edit mode has already been removed from the stack.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getPreviousMode()">getPreviousMode</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the previous portlet mode</DL>
</DD>
</DL>
<HR>

<A NAME="setModeModifier(org.apache.jetspeed.portlet.Portlet.ModeModifier)"><!-- --></A><H3>
setModeModifier</H3>
<PRE>
public void <B>setModeModifier</B>(<A HREF="../../../../../../../org/apache/jetspeed/portlet/Portlet.ModeModifier.html" title="class in org.apache.jetspeed.portlet">Portlet.ModeModifier</A>&nbsp;modeModifier)
                     throws <A HREF="../../../../../../../org/apache/jetspeed/portlet/AccessDeniedException.html" title="class in org.apache.jetspeed.portlet">AccessDeniedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Defines which portlet mode is shown next. Once the mode
 is changed it cannot be changed back to
 <CODE>Portlet.ModeModifier.REQUESTED</CODE>.

 <P>
 This function may only be used during event processing,
 in any other case the call has no effect.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#setModeModifier(org.apache.jetspeed.portlet.Portlet.ModeModifier)">setModeModifier</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>modeModifier</CODE> - the mode modifier
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/AccessDeniedException.html" title="class in org.apache.jetspeed.portlet">AccessDeniedException</A></CODE> - if the portlet tries to access this function
              outside of the action event processing</DL>
</DD>
</DL>
<HR>

<A NAME="getClient()"><!-- --></A><H3>
getClient</H3>
<PRE>
public final <A HREF="../../../../../../../org/apache/jetspeed/portlet/Client.html" title="interface in org.apache.jetspeed.portlet">Client</A> <B>getClient</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns an object representing the client device that the
 user connects to the portal with.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getClient()">getClient</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the client</DL>
</DD>
</DL>
<HR>

<A NAME="getClientWrapper()"><!-- --></A><H3>
getClientWrapper</H3>