strutsportlet.html

门户开发

<A NAME="getServletContextWrapper()"><!-- --></A><H3>
getServletContextWrapper</H3>
<PRE>
protected javax.servlet.ServletContext <B>getServletContextWrapper</B>()</PRE>
<DL>
<DD>Returns the Servlet Context Wrapper
<P>
<DD><DL>

<DT><B>Returns:</B><DD>returns the Servlet Context object</DL>
</DD>
</DL>
<HR>

<A NAME="init(javax.portlet.PortletConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(javax.portlet.PortletConfig&nbsp;portletConfig)
          throws javax.portlet.PortletException</PRE>
<DL>
<DD>Called by the portlet container to indicate to a portlet 
 that the portlet is being placed into service. The ActionServlet init
 is called to digest the Struts configuration, and the init parameters are
 read to set up the portlet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletConfig</CODE> - the portlet configuration
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if an exception has occurred that interferes with the portlet normal operation</DL>
</DD>
</DL>
<HR>

<A NAME="createActionServlet(javax.servlet.ServletContext, javax.servlet.ServletConfig, javax.portlet.PortletConfig, com.ibm.portal.struts.portlet.StrutsInfo)"><!-- --></A><H3>
createActionServlet</H3>
<PRE>
protected <A HREF="../../../../../com/ibm/portal/struts/portlet/WpActionServlet.html" title="class in com.ibm.portal.struts.portlet">WpActionServlet</A> <B>createActionServlet</B>(javax.servlet.ServletContext&nbsp;servletContext,
                                              javax.servlet.ServletConfig&nbsp;servletConfig,
                                              javax.portlet.PortletConfig&nbsp;portletConfig,
                                              <A HREF="../../../../../com/ibm/portal/struts/portlet/StrutsInfo.html" title="class in com.ibm.portal.struts.portlet">StrutsInfo</A>&nbsp;strutsInfo)</PRE>
<DL>
<DD>Returns the ActionServlet.  This method can be overridden 
 so an ActionServlet subclass can be created for custom processing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletConfig</CODE> - the ServletConfig object<DD><CODE>servletContext</CODE> - the ServletContext object<DD><CODE>portletConfig</CODE> - the PortletConfig object<DD><CODE>strutsInfo</CODE> - the StrutsInfo object
<DT><B>Returns:</B><DD>returns the ActionServlet object</DL>
</DD>
</DL>
<HR>

<A NAME="readInitParameters(javax.servlet.ServletContext, javax.portlet.PortletConfig, com.ibm.portal.struts.portlet.StrutsInfo)"><!-- --></A><H3>
readInitParameters</H3>
<PRE>
protected void <B>readInitParameters</B>(javax.servlet.ServletContext&nbsp;servletContext,
                                  javax.portlet.PortletConfig&nbsp;portletConfig,
                                  <A HREF="../../../../../com/ibm/portal/struts/portlet/StrutsInfo.html" title="class in com.ibm.portal.struts.portlet">StrutsInfo</A>&nbsp;strutsInfo)</PRE>
<DL>
<DD>Reads the init parameters for this portlet from the web deployment 
 descriptor and performs the appropriate configuration.
 
 Supported init parameters
 <ul>
 <li>INIT_PARAM_STRUTS_SERVLET_MAPPING</li>
 <li>INIT_PARAM_MODULE_SEARCH_PATH</li> 
 <li>INIT_PARAM_EDIT_MODE</li>
 <li>INIT_PARAM_HELP_MODE</li>
 <li>INIT_PARAM_VIEW_MODE</li>
 <li>INIT_PARAM_INCLUDES_SEARCH_PATH</li>
 <li>INIT_PARAM_USE_GROUPS_FOR_ACCESS</li>
 <li>INIT_PARAM_NAMESCOPE_FORM_NAME</li>
 <li>INIT_PARAM_USE_PORTALS_LOCALE</li>
 <li>INIT_PARAM_PROCESSING_PHASE_SUPPORTED</li>
 <li>INIT_PARAM_HIDE_PARAMS_IN_RENDER</li>
 <li>INIT_PARAM_PORTLET_SESSION_MODE</li>
 <li>INIT_PARAM_WELCOME_FILE_SEARCH_PATH</li>
 <ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the servlet context<DD><CODE>portletConfig</CODE> - the portlet config<DD><CODE>strutsInfo</CODE> - the struts inf object</DL>
</DD>
</DL>
<HR>

<A NAME="doService(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doService</H3>
<PRE>
protected void <B>doService</B>(javax.portlet.RenderRequest&nbsp;renderRequest,
                         javax.portlet.RenderResponse&nbsp;renderResponse)
                  throws javax.portlet.PortletException,
                         java.io.IOException</PRE>
<DL>
<DD>The common processing for doView, doHelp, doConfigure and doEdit. The
 <code>StrutsViewCommand</code> is obtained from the <code>CommandManagerFactory</code>.
 If the command is found, then it is executed to render the view. If a 
 <code>StrutsViewCommand</code> is not found then the welcome file processing
 is used for the initial view.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doView</H3>
<PRE>
public void <B>doView</B>(javax.portlet.RenderRequest&nbsp;request,
                   javax.portlet.RenderResponse&nbsp;response)
            throws javax.portlet.PortletException,
                   java.io.IOException</PRE>
<DL>
<DD>Render method for view mode. The default implementation of this 
 method calls the doService method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request object<DD><CODE>response</CODE> - the render response object
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doHelp</H3>
<PRE>
public void <B>doHelp</B>(javax.portlet.RenderRequest&nbsp;request,
                   javax.portlet.RenderResponse&nbsp;response)
            throws javax.portlet.PortletException,
                   java.io.IOException</PRE>
<DL>
<DD>Render method for help mode. The default implementation of this method 
 calls the doService method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request object<DD><CODE>response</CODE> - the render response object
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doEdit</H3>
<PRE>
public void <B>doEdit</B>(javax.portlet.RenderRequest&nbsp;request,
                   javax.portlet.RenderResponse&nbsp;response)
            throws javax.portlet.PortletException,
                   java.io.IOException</PRE>
<DL>
<DD>Render method for edit mode. The default implemention of this method calls 
 the doService method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request object<DD><CODE>response</CODE> - the render response object
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="doConfigure(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doConfigure</H3>
<PRE>
public void <B>doConfigure</B>(javax.portlet.RenderRequest&nbsp;request,
                        javax.portlet.RenderResponse&nbsp;response)
                 throws javax.portlet.PortletException,
                        java.io.IOException</PRE>
<DL>
<DD>Render method for configure mode. The default implementation of this method 
 calls the doService method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request object<DD><CODE>response</CODE> - the render response object
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="createWelcomeFileCommand(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"><!-- --></A><H3>
createWelcomeFileCommand</H3>
<PRE>
protected void <B>createWelcomeFileCommand</B>(javax.portlet.PortletRequest&nbsp;request,
                                        javax.portlet.PortletResponse&nbsp;response)
                                 throws javax.portlet.PortletException</PRE>
<DL>
<DD>Creates the welcome file command. The welcome file list can be obtained 
 from the welcome file list in the web.xml, or can be configured per
 portlet. This method will use the ModuleSearch path to find the welcome
 file for the portlet mode, and other configurable parameters.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request object<DD><CODE>response</CODE> - the response object
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request</DL>
</DD>
</DL>
<HR>

<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public void <B>destroy</B>()</PRE>
<DL>
<DD>Called by the portlet container to indicate to a portlet that the portlet
 is being taken out of service.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"><!-- --></A><H3>
processAction</H3>
<PRE>
public void <B>processAction</B>(javax.portlet.ActionRequest&nbsp;aRequest,
                          javax.portlet.ActionResponse&nbsp;aResponse)
                   throws javax.portlet.PortletException,
                          java.io.IOException</PRE>
<DL>
<DD>Called by the portlet container to allow the portlet to process an action 
 request. This method is called if the client request was originated by a URL 
 created (by the portlet) with the RenderResponse.createActionURL() method.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="processActionPerformed(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"><!-- --></A><H3>
processActionPerformed</H3>
<PRE>
protected void <B>processActionPerformed</B>(javax.portlet.PortletRequest&nbsp;pRequest,
                                      javax.portlet.PortletResponse&nbsp;pResponse)
                               throws java.io.IOException,
                                      javax.portlet.PortletException</PRE>
<DL>
<DD>The processing for actionPerformed. 

 This is a separate method so it can be called from processAction
 and processStrutsAction or for an action welcome file.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the portlet cannot fulfill the request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="createCommandExecutionContext(javax.portlet.PortletContext, com.ibm.portal.struts.common.ModuleContext, javax.servlet.ServletContext)"><!-- --></A><H3>
createCommandExecutionContext</H3>
<PRE>
protected <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A> <B>createCommandExecutionContext</B>(javax.portlet.PortletContext&nbsp;portletContext,
                                                                    <A HREF="../../../../../com/ibm/portal/struts/common/ModuleContext.html" title="class in com.ibm.portal.struts.common">ModuleContext</A>&nbsp;moduleContext,
                                                                    javax.servlet.ServletContext&nbsp;servletContext)</PRE>
<DL>
<DD>Creates a ViewCommandExecutionContext to be used when executing a ViewCommand.  
 This can be overridden to supply execution context that is particular to 
 the Portal environment.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletContext</CODE> - the PortletContext object<DD><CODE>moduleContext</CODE> - the module context object<DD><CODE>servletContext</CODE> - the servlet context object
<DT><B>Returns:</B><DD>ViewCommandExecutionContext the ViewCommandExecutionContext object</DL>
</DD>
</DL>
<HR>

<A NAME="getWelcomeFileList(javax.servlet.ServletContext, javax.portlet.PortletContext, javax.portlet.PortletRequest)"><!-- --></A><H3>
getWelcomeFileList</H3>