portlet.html

门户开发

 <OL>
 <LI>throws <CODE>UnavailableException</CODE>
 <LI>does not return within a time period defined by the portlet
     container.
 </OL>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - the portlet configuration
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/apache/jetspeed/portlet/UnavailableException.html" title="class in org.apache.jetspeed.portlet">UnavailableException</A></CODE> - if an exception has occurrred that interferes
                   with the portlet's normal initialization</DL>
</DD>
</DL>
<HR>

<A NAME="destroy(org.apache.jetspeed.portlet.PortletConfig)"><!-- --></A><H3>
destroy</H3>
<PRE>
public abstract void <B>destroy</B>(<A HREF="../../../../org/apache/jetspeed/portlet/PortletConfig.html" title="interface in org.apache.jetspeed.portlet">PortletConfig</A>&nbsp;config)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Called by the portlet container to indicate to this portlet
 that it is taken out of service. This method is called
 when the <CODE>destroyConcrete()<CODE> method has been called
 on all concrete portlets that have been active, i.e. for which
 <CODE>initConcrete()</CODE> has been called before.

 <P>
 After the portlet container calls this method, it will not call the
 <CODE>service()</CODE> method or any listener methods again 
 on this portlet.

 <P>
 This method gives the portlet an opportunity to clean up any
 resources that are being held (for example, memory, file
 handles, threads).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="initConcrete(org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
initConcrete</H3>
<PRE>
public abstract void <B>initConcrete</B>(<A HREF="../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;settings)
                           throws <A HREF="../../../../org/apache/jetspeed/portlet/UnavailableException.html" title="class in org.apache.jetspeed.portlet">UnavailableException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Called by the portlet container to indicate that the concrete portlet
 is put into service.

 <P>
 The portlet container calls the <CODE>initConcrete()</CODE> method
 before the <CODE>service()</CODE> method or any listener method is invoked
 for the portlet.
 The <CODE>initConcrete()</CODE> method must complete successfully before
 concrete portlet instances can be created through the <CODE>login()</CODE> 
 method.
 
 <P>
 The portlet container cannot place the portlet into service
 if the <CODE>initConcrete()</CODE> method fails.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - The portlet settings
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/apache/jetspeed/portlet/UnavailableException.html" title="class in org.apache.jetspeed.portlet">UnavailableException</A></CODE> - if an exception has occurrred that interferes
                   with the portlet's normal initialization</DL>
</DD>
</DL>
<HR>

<A NAME="destroyConcrete(org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
destroyConcrete</H3>
<PRE>
public abstract void <B>destroyConcrete</B>(<A HREF="../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;settings)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Called by the portlet container to indicate that the concrete portlet
 is taken out of service. This method is only called
 once all threads within the portlet's <CODE>service()</CODE>
 method have exited or after a timeout period has passed. After
 the portlet container calls this method, it will not call the
 <CODE>service()</CODE> method or any listener methods again on this 
 portlet.
 
 <P>
 This method gives the portlet an opportunity to clean up any
 resources that are being held (for example, memory, file
 handles, threads).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the portlet settings</DL>
</DD>
</DL>
<HR>

<A NAME="service(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)"><!-- --></A><H3>
service</H3>
<PRE>
public abstract void <B>service</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><B>Deprecated.</B>&nbsp;<DD>Called by the portlet container to ask this portlet to generate
 its markup using the given request/response pair. Depending
 on the mode of the portlet and the requesting client device,
 the markup will be different. Also, the portlet can take language
 preferences and/or personalized settings into account.
<P>
<DD><DL>
</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 has trouble fulfilling the
              rendering request
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="getLastModified(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
getLastModified</H3>
<PRE>
public abstract long <B>getLastModified</B>(<A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the time the response of the <code>Portlet</code>
 object was last modified,
 in milliseconds since midnight January 1, 1970 GMT.
 If the time is unknown, this method returns a negative
 number (the default).

 <p>Portlets that can quickly determine
 their last modification time should override this method.
 This makes browser and proxy caches work more effectively,
 reducing the load on server and network resources.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/ibm/wps/pe/pc/legacy/cache/CacheablePortlet.html#getLastModified(org.apache.jetspeed.portlet.PortletRequest)">getLastModified</A></CODE> in class <CODE><A HREF="../../../../com/ibm/wps/pe/pc/legacy/cache/CacheablePortlet.html" title="class in com.ibm.wps.pe.pc.legacy.cache">CacheablePortlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code>
                object that is sent to the portlet
<DT><B>Returns:</B><DD>a <code>long</code> integer specifying
         the time the response of the <code>Portlet</code>
         object was last modified, in milliseconds
         since midnight, January 1, 1970 GMT, or
         -1 if the time is not known</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletConfig()"><!-- --></A><H3>
getPortletConfig</H3>
<PRE>
public abstract <A HREF="../../../../org/apache/jetspeed/portlet/PortletConfig.html" title="interface in org.apache.jetspeed.portlet">PortletConfig</A> <B>getPortletConfig</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the <CODE>PortletConfig</CODE> object of the portlet
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the PortletConfig object</DL>
</DD>
</DL>
<HR>

<A NAME="login(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
login</H3>
<PRE>
public abstract 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><B>Deprecated.</B>&nbsp;<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jetspeed/portlet/PortletSessionListener.html" title="interface in org.apache.jetspeed.portlet">PortletSessionListener</A></CODE></B></DD>
<DD>Called by the portlet container before the <CODE>service()</CODE> method of
 this portlet is invoked for the first time in the context of a new user session.
 This method will called at most once for any user session in the portal.

 <P>
 This method can be implemented by the portlet to
 initialize a personalized user experience.
 In addition to initializing the session this method allows the
 portlet to initialize the concrete portlet instance, for example, to
 store attributes in the session.
 </P>
<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></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request
<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 has trouble fulfilling the
              request</DL>
</DD>
</DL>
<HR>

<A NAME="logout(org.apache.jetspeed.portlet.PortletSession)"><!-- --></A><H3>
logout</H3>
<PRE>
public abstract 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><B>Deprecated.</B>&nbsp;<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jetspeed/portlet/PortletSessionListener.html" title="interface in org.apache.jetspeed.portlet">PortletSessionListener</A></CODE></B></DD>
<DD>Called by the portlet container when a user session terminates (by user logout
 or timeout) for which the <CODE>login()</CODE> method has been called before.
 After this method has been called, the <CODE>service()</CODE> method of the
 portlet will nor be invoked again within the context of the same user session.

 <P>
 This method gives the concrete portlet instance an
 opportunity to clean up any resources (for example, memory,
 file handles, threads), before it is removed.
 </P>
<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></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 has trouble fulfilling the
              request</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletSettings()"><!-- --></A><H3>
getPortletSettings</H3>
<PRE>
protected <A HREF="../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A> <B>getPortletSettings</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>since 5.1, use <CODE>PortletRequest.getPortletSettings</CODE> instead. A single instance
    of a portlet may reference multiple concrete portlets; without a reference to a 
    portlet request, it is not always possible to determine the correct concrete portlet</I>
<P>
<DD>Returns the <CODE>PortletSettings</CODE> object of the concrete portlet.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the PortletSettings object, or NULL if no PortletSettings object is available.</DL>
</DD>
</DL>
<HR>