strutsportlet.html

门户开发

<PRE>
protected java.util.List <B>getWelcomeFileList</B>(javax.servlet.ServletContext&nbsp;servletContext,
                                            javax.portlet.PortletContext&nbsp;portletContext,
                                            javax.portlet.PortletRequest&nbsp;portletRequest)</PRE>
<DL>
<DD>Gets the welcome file list. The list will first contain entries configured in
 with the portlet and then the welcome file list values from the web.xml.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletRequest</CODE> - the portlet request objects
<DT><B>Returns:</B><DD>Vector welcome files</DL>
</DD>
</DL>
<HR>

<A NAME="getWelcomeFileList(javax.servlet.ServletContext)"><!-- --></A><H3>
getWelcomeFileList</H3>
<PRE>
protected java.util.Vector <B>getWelcomeFileList</B>(javax.servlet.ServletContext&nbsp;servletContext)</PRE>
<DL>
<DD>Gets the welcome file list from the web.xml file.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Vector welcome files</DL>
</DD>
</DL>
<HR>

<A NAME="createPortletRequestWrapper(javax.portlet.PortletRequest)"><!-- --></A><H3>
createPortletRequestWrapper</H3>
<PRE>
protected javax.portlet.PortletRequest <B>createPortletRequestWrapper</B>(javax.portlet.PortletRequest&nbsp;portletRequest)</PRE>
<DL>
<DD>Creates a portlet request wrapper. The request wrapper will be used to implement
 request features unique to the Struts Portlet Framework.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletRequest</CODE> - the portlet request
<DT><B>Returns:</B><DD>PortletRequest the portlet request wrapper</DL>
</DD>
</DL>
<HR>

<A NAME="processStrutsAction(javax.portlet.PortletRequest, javax.portlet.PortletResponse, java.lang.String)"><!-- --></A><H3>
processStrutsAction</H3>
<PRE>
public void <B>processStrutsAction</B>(javax.portlet.PortletRequest&nbsp;aRequest,
                                javax.portlet.PortletResponse&nbsp;aResponse,
                                java.lang.String&nbsp;strutsAction)
                         throws javax.portlet.PortletException</PRE>
<DL>
<DD>Calls the appropriate Struts request processor's process method
 for the specified Struts action. Note: The ActionServlet doPost/doGet is not
 used to invoke the request processor, the request processor is called directly.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>strutsAction</CODE> - the struts action
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request</DL>
</DD>
</DL>
<HR>

<A NAME="setupBase(javax.portlet.PortletRequest, javax.portlet.PortletResponse, javax.portlet.PortletConfig)"><!-- --></A><H3>
setupBase</H3>
<PRE>
protected static void <B>setupBase</B>(javax.portlet.PortletRequest&nbsp;request,
                                javax.portlet.PortletResponse&nbsp;response,
                                javax.portlet.PortletConfig&nbsp;config)</PRE>
<DL>
<DD>Allows BaseImplUtils to set up the processing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request object<DD><CODE>response</CODE> - the response object<DD><CODE>config</CODE> - the config parameter</DL>
</DD>
</DL>
<HR>

<A NAME="processLocale(javax.portlet.PortletRequest)"><!-- --></A><H3>
processLocale</H3>
<PRE>
protected void <B>processLocale</B>(javax.portlet.PortletRequest&nbsp;request)</PRE>
<DL>
<DD>Sets the locale for Jakarta Struts in session to the locale obtained from the 
 portlet request object. The locale object is stored in session under the 
 Globals.LOCALE_KEY and used by Struts components.
 
 Note: The Struts request processor implementation will only set a locale
 if a locale object is not already set. This method effectively defeats
 the Struts implementation.
 
 Struts actions can also set the locale object in session, 
 so the usePortalsLocale must be set to false for those applications to work.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request object</DL>
</DD>
</DL>
<HR>

<A NAME="setupRenderPhase(javax.portlet.PortletRequest)"><!-- --></A><H3>
setupRenderPhase</H3>
<PRE>
protected void <B>setupRenderPhase</B>(javax.portlet.PortletRequest&nbsp;request)</PRE>
<DL>
<DD>Sets up the render phase. Sets request attributes that can be used by
 the processor to determine the Portal phase.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request object</DL>
</DD>
</DL>
<HR>

<A NAME="setupRequestPhase(javax.portlet.PortletRequest)"><!-- --></A><H3>
setupRequestPhase</H3>
<PRE>
protected void <B>setupRequestPhase</B>(javax.portlet.PortletRequest&nbsp;request)</PRE>
<DL>
<DD>Sets up the request phase. Sets request attributes that can be used by
 the processor to determine the Portal phase.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request</DL>
</DD>
</DL>
<HR>

<A NAME="setCommonsLogFactory()"><!-- --></A><H3>
setCommonsLogFactory</H3>
<PRE>
public void <B>setCommonsLogFactory</B>()</PRE>
<DL>
<DD>Previously used to set a commons logger using the System property. The suggested solution
 is to set the commons logger in the commons-logging.properties file.
 
 The default logger will log all messages to the Portal log file.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getServletContextWrapper(javax.portlet.PortletConfig, javax.servlet.ServletContext)"><!-- --></A><H3>
getServletContextWrapper</H3>
<PRE>
protected javax.servlet.ServletContext <B>getServletContextWrapper</B>(javax.portlet.PortletConfig&nbsp;portletConfig,
                                                                javax.servlet.ServletContext&nbsp;servletContext)</PRE>
<DL>
<DD>Returns a servlet context that namescopes the attributes to the portlet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletConfig</CODE> - the portlet config<DD><CODE>servletContext</CODE> - the real servlet context
<DT><B>Returns:</B><DD>ServletContext the wrapper servlet context</DL>
</DD>
</DL>
<HR>

<A NAME="initCommandManagerPlugin(javax.portlet.PortletConfig)"><!-- --></A><H3>
initCommandManagerPlugin</H3>
<PRE>
protected void <B>initCommandManagerPlugin</B>(javax.portlet.PortletConfig&nbsp;portletConfig)</PRE>
<DL>
<DD>Initializes a plugin. A Struts plugin can be specified in the portlet 
 deployment descriptor. This will allow a plugin to execute once per 
 Struts application instead of once per Struts module.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletConfig</CODE> - the portlet config</DL>
</DD>
</DL>
<HR>

<A NAME="destroyCommandManagerPlugin(javax.portlet.PortletConfig)"><!-- --></A><H3>
destroyCommandManagerPlugin</H3>
<PRE>
protected void <B>destroyCommandManagerPlugin</B>(javax.portlet.PortletConfig&nbsp;portletConfig)</PRE>
<DL>
<DD>Destroys a plugin by calling the destroy method of the plugin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletConfig</CODE> - the portlet config</DL>
</DD>
</DL>
<HR>

<A NAME="getServletConfigWrapper(javax.portlet.PortletConfig)"><!-- --></A><H3>
getServletConfigWrapper</H3>
<PRE>
protected javax.servlet.ServletConfig <B>getServletConfigWrapper</B>(javax.portlet.PortletConfig&nbsp;portletConfig)</PRE>
<DL>
<DD>Gets the serlvet config wrapper.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>returns the servlet config wrapper</DL>
</DD>
</DL>
<HR>

<A NAME="doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doDispatch</H3>
<PRE>
protected void <B>doDispatch</B>(javax.portlet.RenderRequest&nbsp;request,
                          javax.portlet.RenderResponse&nbsp;response)
                   throws javax.portlet.PortletException,
                          java.io.IOException</PRE>
<DL>
<DD>Support for config mode
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/ibm/portal/struts/portlet/StrutsInfo.html" title="class in com.ibm.portal.struts.portlet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/portal/struts/portlet/WpActionServlet.html" title="class in com.ibm.portal.struts.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="StrutsPortlet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>