genericportlet.html.svn-base

portal越来越流行了

 set on the portal application level.
 <p>
 The map returned from this method will provide the subset the
 portlet container supports of the options the portlet has specified 
 in the <code>portlet.xml</code>. Options that the portlet container
 does not support will not be returned in this map.
 <p>
 The map will contain name of the runtime option as key of type String
 and the runtime options as values of type String array (<code>String[]</code>)
 with the values specified in the <code>portlet.xml</code> deployment descriptor.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getContainerRuntimeOptions()">getContainerRuntimeOptions</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing portlet
          container runtime options names as keys and the 
          container runtime values as map values, or an empty <code>Map</code>
          if no portlet container runtime options are set
          in the <code>portlet.xml</code> or supported by this portlet container. 
          The keys in the map are of type String. The values in the map are of type
          String array (<code>String[]</code>).</DL>
</DD>
</DL>
<HR>

<A NAME="serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)"><!-- --></A><H3>
serveResource</H3>
<PRE>
public void <B>serveResource</B>(<A HREF="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</A>&nbsp;request,
                          <A HREF="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</A>&nbsp;response)
                   throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
                          java.io.IOException</PRE>
<DL>
<DD>Default resource serving.
 <p>
 The default implemention of this method is to call a
 RequestDispatcher.foward with the ResourceID of the ResourceRequest.
 <p>
 If no ResourceID is set on the resource URL the default implementation
 does nothing.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/ResourceServingPortlet.html#serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)">serveResource</A></CODE> in interface <CODE><A HREF="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet">ResourceServingPortlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the resource request<DD><CODE>response</CODE> - the resource response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet has problems fulfilling the
              rendering 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>Since:</B></DT>
  <DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)"><!-- --></A><H3>
processEvent</H3>
<PRE>
public void <B>processEvent</B>(<A HREF="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</A>&nbsp;request,
                         <A HREF="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</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 tries to dispatch to a method
 annotated with <code>@ProcessEvent</name> that matches the 
 event name or, if no
 such method is found just sets the current render parameters on
 the response.<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/EventPortlet.html#processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)">processEvent</A></CODE> in interface <CODE><A HREF="../../javax/portlet/EventPortlet.html" title="interface in javax.portlet">EventPortlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the event request<DD><CODE>response</CODE> - the event response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the portlet has problems 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 event 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>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/EventPortlet.html#processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)"><CODE>EventPortlet.processEvent(javax.portlet.EventRequest,
      javax.portlet.EventResponse)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="doHeaders(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doHeaders</H3>
<PRE>
protected void <B>doHeaders</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)</PRE>
<DL>
<DD>Used by the render method to set the response properties and headers.
 <p>
 The portlet should override this method and set its response header using
 this method in order to ensure that they are set before anything is
 written to the output stream.
 <p>
 The default implemention of this method is emtpy.
<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>Since:</B></DT>
  <DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getNextPossiblePortletModes(javax.portlet.RenderRequest)"><!-- --></A><H3>
getNextPossiblePortletModes</H3>
<PRE>
protected java.util.Collection&lt;<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A>&gt; <B>getNextPossiblePortletModes</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 set the next possible portlet modes.
 <p>
 The portlet should override this method and set the next possible portlet
 modes using this method in order to ensure that they are set before
 anything is written to the output stream.
 <p>
 The default implemention of this method returns <code>null</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPublicRenderParameterNames()"><!-- --></A><H3>
getPublicRenderParameterNames</H3>
<PRE>
public java.util.Enumeration&lt;java.lang.String&gt; <B>getPublicRenderParameterNames</B>()</PRE>
<DL>
<DD>Returns the names of the public render parameters supported by the
 portlet as an <code>Enumeration</code> of String objects, or an empty
 <code>Enumeration</code> if the portlet has no public render
 parameters.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getPublicRenderParameterNames()">getPublicRenderParameterNames</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>String</code> objects
         containing the names of the public render parameters, or an empty
         <code>Enumeration</code> if the portlet does not define any
         public render parameters.<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletConfig.html#getPublicRenderParameterNames()"><CODE>PortletConfig.getPublicRenderParameterNames()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultNamespace()"><!-- --></A><H3>
getDefaultNamespace</H3>
<PRE>
public java.lang.String <B>getDefaultNamespace</B>()</PRE>
<DL>
<DD>Returns the default namespace for events and public parameters. This
 namespace is defined in the portlet deployment descriptor with the
 <code>default-namespace</code> element.
 <p>
 If no default namespace is defined in the portlet deployment descriptor
 this methods returns the XML default namespace
 <code>XMLConstants.NULL_NS_URI</code>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getDefaultNamespace()">getDefaultNamespace</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the default namespace defined in the portlet deployment
         descriptor, or <code>XMLConstants.NULL_NS_URI</code> is non is
         defined.<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletConfig.html#getDefaultNamespace()"><CODE>PortletConfig.getDefaultNamespace()</CODE></A></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=2 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;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/GenericPortlet.html"><FONT CLASS="NavBarFont1"><B>Use</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="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.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="../../javax/portlet/EventResponse.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html?javax/portlet/GenericPortlet.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="GenericPortlet.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;FIELD&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;FIELD&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>