wpsstrutsportlet.html

门户开发

<DL>
<DD>Returns the WpsActionServlet for this application. A protected method is used
 so the WpsActionServlet used can be customized.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><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 action servlet object</DL>
</DD>
</DL>
<HR>

<A NAME="readInitParameters(javax.servlet.ServletContext, org.apache.jetspeed.portlet.PortletConfig, com.ibm.wps.portlets.struts.WpsStrutsInfo)"><!-- --></A><H3>
readInitParameters</H3>
<PRE>
protected void <B>readInitParameters</B>(javax.servlet.ServletContext&nbsp;servletContext,
                                  <A HREF="../../../../../org/apache/jetspeed/portlet/PortletConfig.html" title="interface in org.apache.jetspeed.portlet">PortletConfig</A>&nbsp;portletConfig,
                                  <A HREF="../../../../../com/ibm/wps/portlets/struts/WpsStrutsInfo.html" title="class in com.ibm.wps.portlets.struts">WpsStrutsInfo</A>&nbsp;strutsInfo)</PRE>
<DL>
<DD>Reads the init parameters for this portlet from the web deployment descriptor and performs the 
 appropriate configuration.
 
 </br>
 Supported init parameters
 </br>
 <ul>
 <li>INIT_PARAM_STRUTS_SERVLET_MAPPING</li>
 <li>INIT_PARAM_MODULE_SEARCH_PATH</li>
 <li>INIT_PARAM_SUB_APPLICATION_SEARCH_PATH</li>
 <li>INIT_PARAM_EDIT_MODE</li>
 <li>INIT_PARAM_CONFIGURE_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_LAST_MODIFIED_SUPPORTED</li>
 <li>INIT_PARAM_PROCESSING_PHASE_SUPPORTED</li>
 <li>INIT_PARAM_HIDE_PARAMS_IN_RENDER</li>
 <li>INIT_PARAM_WELCOME_FILE_SEARCH_PATH</li>
 </ul>
<P>
<DD><DL>
</DL>
</DD>
<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 info object</DL>
</DD>
</DL>
<HR>

<A NAME="login(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
login</H3>
<PRE>
public void <B>login</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request)
           throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></PRE>
<DL>
<DD>Called by the portlet container to ask the portlet 
 to initialize a personalized user experience.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletSessionListener.html#login(org.apache.jetspeed.portlet.PortletRequest)">login</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletSessionListener.html" title="interface in org.apache.jetspeed.portlet">PortletSessionListener</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html#login(org.apache.jetspeed.portlet.PortletRequest)">login</A></CODE> in class <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">PortletAdapter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the PortletRequest
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></CODE> - if the portlet cannot fulfill the request</DL>
</DD>
</DL>
<HR>

<A NAME="logout(org.apache.jetspeed.portlet.PortletSession)"><!-- --></A><H3>
logout</H3>
<PRE>
public void <B>logout</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletSession.html" title="interface in org.apache.jetspeed.portlet">PortletSession</A>&nbsp;session)
            throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></PRE>
<DL>
<DD>Called by the portlet container when the user has logged out.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletSessionListener.html#logout(org.apache.jetspeed.portlet.PortletSession)">logout</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletSessionListener.html" title="interface in org.apache.jetspeed.portlet">PortletSessionListener</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html#logout(org.apache.jetspeed.portlet.PortletSession)">logout</A></CODE> in class <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">PortletAdapter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the portlet session
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></CODE> - if the portlet cannot fulfill the request</DL>
</DD>
</DL>
<HR>

<A NAME="doService(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)"><!-- --></A><H3>
doService</H3>
<PRE>
protected void <B>doService</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;portletRequest,
                         <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response)
                  throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A>,
                         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 to find the initial view.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - the portlet response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></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(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)"><!-- --></A><H3>
doView</H3>
<PRE>
public void <B>doView</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                   <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response)
            throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A>,
                   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>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html#doView(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)">doView</A></CODE> in class <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">PortletAdapter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the portlet response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></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(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)"><!-- --></A><H3>
doHelp</H3>
<PRE>
public void <B>doHelp</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                   <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response)
            throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A>,
                   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>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html#doHelp(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)">doHelp</A></CODE> in class <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">PortletAdapter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the portlet response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></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(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)"><!-- --></A><H3>
doEdit</H3>
<PRE>
public void <B>doEdit</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                   <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response)
            throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A>,
                   java.io.IOException</PRE>
<DL>
<DD>Render method for edit mode. The default implementation of this method 
 calls the doService method.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html#doEdit(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)">doEdit</A></CODE> in class <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">PortletAdapter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the portlet response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></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(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)"><!-- --></A><H3>
doConfigure</H3>
<PRE>
public void <B>doConfigure</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                        <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response)
                 throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A>,
                        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>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html#doConfigure(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)">doConfigure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">PortletAdapter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the portlet response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletExcept