genericportlet.html.svn-base

portal越来越流行了

init</H3>
<PRE>
public void <B>init</B>()
          throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></PRE>
<DL>
<DD>A convenience method which can be overridden so that there's no need to
 call <code>super.init(config)</code>.
 
 <p>
 Instead of overriding <A HREF="../../javax/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)"><CODE>init(PortletConfig)</CODE></A>, simply override this
 method and it will be called by
 <code>GenericPortlet.init(PortletConfig config)</code>. The
 <code>PortletConfig</code> object can still be retrieved via <A HREF="../../javax/portlet/GenericPortlet.html#getPortletConfig()"><CODE>getPortletConfig()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if an exception has occurred that interferes with the
                portlet normal operation.
<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to perform init</DL>
</DD>
</DL>
<HR>

<A NAME="processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"><!-- --></A><H3>
processAction</H3>
<PRE>
public void <B>processAction</B>(<A HREF="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</A>&nbsp;request,
                          <A HREF="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</A>&nbsp;response)
                   throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                          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
 <code>RenderResponse.createActionURL()</code> method.
 <p>
 The default implementation tries to dispatch to a method
 annotated with <code>@ProcessAction</name> that matches the action parameter 
 value <code>ActionRequest.ACTION_NAME</code> or, if no
 such method is found throws a <code>PortletException</code>.<br>
 Note that the annotated methods needs to be public in order
 to be allowed to be called by <code>GenericPortlet</code>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)">processAction</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the action request<DD><CODE>response</CODE> - the action response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet cannot fulfilling the request
<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to process the action at
                this time
<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of
                security reasons
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A>&nbsp;request,
                   <A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A>&nbsp;response)
            throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                   java.io.IOException</PRE>
<DL>
<DD>The default implementation of this method sets the headers using the
 <code>doHeaders</code> method, sets the title using the
 <code>getTitle</code> method and invokes the <code>doDispatch</code>
 method.
 <p>
 It also evaluates the <code>RENDER_PART</code> request attribute and if
 set calls the <code>doHeaders, getNextPossiblePortletModes</code> and
 <code>getTitle</code> methods for the <code>RENDER_HEADERS</code>
 part and the <code>doDispatch</code> method for the
 <code>RENDER_MARKUP</code> part.<br>
 If the <code>RENDER_PART</code> request attribute is not set all of the
 above methods will be called.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">render</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request<DD><CODE>response</CODE> - the render response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet cannot fulfilling the request
<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this
                time
<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of
                security reasons
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="getTitle(javax.portlet.RenderRequest)"><!-- --></A><H3>
getTitle</H3>
<PRE>
protected java.lang.String <B>getTitle</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A>&nbsp;request)</PRE>
<DL>
<DD>Used by the render method to get the title.
 <p>
 The default implementation gets the title from the ResourceBundle of the
 PortletConfig of the portlet. The title is retrieved using the
 'javax.portlet.title' resource name.
 <p>
 Portlets can overwrite this method to provide dynamic titles (e.g. based
 on locale, client, and session information). Examples are:
 <UL>
 <LI>language-dependent titles for multi-lingual portals</li>
 <LI>shorter titles for WAP phones</li>
 <LI>the number of messages in a mailbox portlet</li>
 </UL>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet title for this window
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if no portlet config object is available</DL>
</DD>
</DL>
<HR>

<A NAME="doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doDispatch</H3>
<PRE>
protected void <B>doDispatch</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A>&nbsp;request,
                          <A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A>&nbsp;response)
                   throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                          java.io.IOException</PRE>
<DL>
<DD>The default implementation of this method routes the render request to:
 <ol>
 <li>method annotated with <code>@RenderMode</name> and the name of the
       portlet mode</li>
   <li>a set of helper methods depending on the current portlet mode the portlet
                 is currently in. These methods are:
                <ul>
                        <li><code>doView</code> for handling <code>view</code> requests</li>
                        <li><code>doEdit</code> for handling <code>edit</code> requests</li>
                        <li><code>doHelp</code> for handling <code>help</code> requests</li>
                </ul>
        </li>
 </ul> 
 <P>
 If the window state of this portlet is <code>minimized</code>, this
 method does not invoke any of the portlet mode rendering methods.
 <p>
 For handling custom portlet modes the portlet should either use the
 <code>@RenderMode</code> annotation or override this
 method. Note that the annotated methods needs to be public in order
 to be allowed to be called by <code>GenericPortlet</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request<DD><CODE>response</CODE> - the render response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet cannot fulfilling the request
<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this
                time
<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of
                security reasons
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/GenericPortlet.html#doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><CODE>doView(RenderRequest, RenderResponse)</CODE></A>, 
<A HREF="../../javax/portlet/GenericPortlet.html#doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><CODE>doEdit(RenderRequest, RenderResponse)</CODE></A>, 
<A HREF="../../javax/portlet/GenericPortlet.html#doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><CODE>doHelp(RenderRequest, RenderResponse)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doView</H3>
<PRE>
protected void <B>doView</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A>&nbsp;request,
                      <A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A>&nbsp;response)
               throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                      java.io.IOException</PRE>
<DL>
<DD>Helper method to serve up the mandatory <code>view</code> mode.
 <p>
 The default implementation throws an exception.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the render response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet cannot fulfilling the request
<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this
                time
<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of
                security reasons
<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>
protected void <B>doEdit</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A>&nbsp;request,
                      <A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A>&nbsp;response)
               throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                      java.io.IOException</PRE>
<DL>
<DD>Helper method to serve up the <code>edit</code> mode.
 <p>
 The default implementation throws an exception.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the render response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet cannot fulfilling the request
<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this
                time
<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of
                security reasons
<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>
protected void <B>doHelp</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A>&nbsp;request,
                      <A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A>&nbsp;response)
               throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                      java.io.IOException</PRE>
<DL>
<DD>Helper method to serve up the <code>help</code> mode.
 <p>
 The default implementation throws an exception.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the render response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet cannot fulfilling the request