You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by es...@apache.org on 2008/05/17 02:57:33 UTC
svn commit: r657263 [4/9] - in
/portals/pluto/branches/pluto-1.1.x/src/site/resources: ./
portlet-1.0-apidocs/ portlet-1.0-apidocs/javax/
portlet-1.0-apidocs/javax/portlet/
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/Portlet.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/Portlet.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/Portlet.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/Portlet.html Fri May 16 17:57:32 2008
@@ -0,0 +1,320 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Interface Portlet
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/PortalContext.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletConfig.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="Portlet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface Portlet</H2>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../javax/portlet/GenericPortlet.html">GenericPortlet</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public interface <B>Portlet</B></DL>
+
+<P>
+The <CODE>Portlet</CODE> interface is used by the portlet container to
+ invoke the portlets. Every portlet has to implement this interface,
+ either by directly implementing it, or by using an existing class
+ implementing the Portlet interface.
+ <P>
+ A portlet is a Java technology-based web component. It is managed by the portlet container and
+ processes requests and generates dynamic content as response. Portlets are used by portals as
+ pluggable user interface components.
+ <p>
+ The content generated by a portlet is called a fragment. A fragment is a piece of
+ markup (e.g. HTML, XHTML, WML) adhering to certain rules and can be aggregated
+ with other fragments into a complete document. The content of a portlet is normally
+ aggregated with the content of other portlets into the portal page.
+ <P>
+ The portlet container instanciates portlets, manages their lifecycle
+ and invoking them to process requests. The lifecycle consists of:
+ <ul>
+ <li>initializing the portlet using using the <code>init</code> method
+ <li>request processsing
+ <li>taking the portlet out of service using the <code>destroy</code> method
+ </ul>
+ <p>
+ Request processing is divided into two types:
+ <ul>
+ <li>action requests handled through the <code>processAction</code> method,
+ to perform actions targeted to the portlet
+ <li>render requests handled through the <code>render</code> method,
+ to perform the render operation
+ </ul>
+<P>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/Portlet.html#destroy()">destroy</A></B>()</CODE>
+
+<BR>
+ Called by the portlet container to indicate to a portlet that the
+ portlet is being taken out of service.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/Portlet.html#init(javax.portlet.PortletConfig)">init</A></B>(<A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A> config)</CODE>
+
+<BR>
+ Called by the portlet container to indicate to a portlet that the
+ portlet is being placed into service.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/Portlet.html#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)">processAction</A></B>(<A HREF="../../javax/portlet/ActionRequest.html">ActionRequest</A> request,
+ <A HREF="../../javax/portlet/ActionResponse.html">ActionResponse</A> response)</CODE>
+
+<BR>
+ Called by the portlet container to allow the portlet to process
+ an action request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/Portlet.html#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">render</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)</CODE>
+
+<BR>
+ Called by the portlet container to allow the portlet to generate
+ the content of the response based on its current state.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="init(javax.portlet.PortletConfig)"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>(<A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A> config)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A></PRE>
+<DL>
+<DD>Called by the portlet container to indicate to a portlet that the
+ portlet is being placed into service.
+
+ <p>The portlet container calls the <code>init</code>
+ method exactly once after instantiating the portlet.
+ The <code>init</code> method must complete successfully
+ before the portlet can receive any requests.
+
+ <p>The portlet container cannot place the portlet into service
+ if the <code>init</code> method
+ <ol>
+ <li>Throws a <code>PortletException</code>
+ <li>Does not return within a time period defined by the portlet container.
+ </ol><DD><DL>
+<DT><B>Parameters:</B><DD><CODE>config</CODE> - a <code>PortletConfig</code> object
+ containing the portlet's
+ configuration and initialization parameters<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if an exception has occurred that
+ interferes with the portlet's normal
+ operation.<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet cannot perform the initialization at this time.</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">ActionRequest</A> request,
+ <A HREF="../../javax/portlet/ActionResponse.html">ActionResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">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>
+ Typically, in response to an action request, a portlet updates state
+ based on the information sent in the action request parameters.
+ In an action the portlet may:
+ <ul>
+ <li>issue a redirect
+ <li>change its window state
+ <li>change its portlet mode
+ <li>modify its persistent state
+ <li>set render parameters
+ </ul>
+ <p>
+ A client request triggered by an action URL translates into one
+ action request and many render requests, one per portlet in the portal page.
+ The action processing must be finished before the render requests
+ can be issued.<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">PortletException</A></CODE> - if the portlet has problems fulfilling the
+ request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to process the action at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>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">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>Called by the portlet container to allow the portlet to generate
+ the content of the response based on its current state.<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">PortletException</A></CODE> - if the portlet has problems fulfilling the
+ rendering request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">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="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>
+ Before the portlet container calls the destroy method, it should
+ allow any threads that are currently processing requests within
+ the portlet object to complete execution. To avoid
+ waiting forever, the portlet container can optionally wait for
+ a predefined time before destroying the portlet object.
+
+ <p>This method enables the portlet to do the following:
+ <ul>
+ <li>clean up any resources that it holds (for example, memory,
+ file handles, threads)
+ <li>make sure that any persistent state is
+ synchronized with the portlet current state in memory.
+ </ul></DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/PortalContext.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletConfig.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="Portlet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/Portlet.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/Portlet.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletConfig.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletConfig.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletConfig.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletConfig.html Fri May 16 17:57:32 2008
@@ -0,0 +1,281 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Interface PortletConfig
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/Portlet.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletContext.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="PortletConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface PortletConfig</H2>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../javax/portlet/GenericPortlet.html">GenericPortlet</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public interface <B>PortletConfig</B></DL>
+
+<P>
+The <CODE>PortletConfig</CODE> interface provides the portlet with
+ its configuration. The configuration holds information about the
+ portlet that is valid for all users. The configuration is retrieved
+ from the portlet definition in the deployment descriptor.
+ The portlet can only read the configuration data.
+ <p>
+ The configuration information contains the portlet name, the portlet
+ initialization parameters, the portlet resource bundle and the portlet
+ application context.
+<P>
+<DL>
+<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/Portlet.html"><CODE>Portlet</CODE></A></DL>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns a String containing the value of the named initialization parameter,
+ or null if the parameter does not exist.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames</A></B>()</CODE>
+
+<BR>
+ Returns the names of the portlet initialization parameters as an
+ <code>Enumeration</code> of String objects, or an empty <code>Enumeration</code> if the
+ portlet has no initialization parameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/PortletContext.html">PortletContext</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</A></B>()</CODE>
+
+<BR>
+ Returns the <code>PortletContext</code> of the portlet application
+ the portlet is in.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPortletName()">getPortletName</A></B>()</CODE>
+
+<BR>
+ Returns the name of the portlet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.ResourceBundle</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></B>(java.util.Locale locale)</CODE>
+
+<BR>
+ Gets the resource bundle for the given locale based on the
+ resource bundle defined in the deployment descriptor
+ with <code>resource-bundle</code> tag or the inlined resources
+ defined in the deployment descriptor.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="getPortletName()"><!-- --></A><H3>
+getPortletName</H3>
+<PRE>
+public java.lang.String <B>getPortletName</B>()</PRE>
+<DL>
+<DD>Returns the name of the portlet.
+ <P>
+ The name may be provided via server administration, assigned in the
+ portlet application deployment descriptor with the <code>portlet-name</code>
+ tag.<DD><DL>
+<DT><B>Returns:</B><DD>the portlet name</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortletContext()"><!-- --></A><H3>
+getPortletContext</H3>
+<PRE>
+public <A HREF="../../javax/portlet/PortletContext.html">PortletContext</A> <B>getPortletContext</B>()</PRE>
+<DL>
+<DD>Returns the <code>PortletContext</code> of the portlet application
+ the portlet is in.<DD><DL>
+<DT><B>Returns:</B><DD>a <code>PortletContext</code> object, used by the
+ caller to interact with its portlet container<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html"><CODE>PortletContext</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getResourceBundle(java.util.Locale)"><!-- --></A><H3>
+getResourceBundle</H3>
+<PRE>
+public java.util.ResourceBundle <B>getResourceBundle</B>(java.util.Locale locale)</PRE>
+<DL>
+<DD>Gets the resource bundle for the given locale based on the
+ resource bundle defined in the deployment descriptor
+ with <code>resource-bundle</code> tag or the inlined resources
+ defined in the deployment descriptor.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which to retrieve the resource bundle<DT><B>Returns:</B><DD>the resource bundle for the given locale</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
+getInitParameter</H3>
+<PRE>
+public java.lang.String <B>getInitParameter</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns a String containing the value of the named initialization parameter,
+ or null if the parameter does not exist.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
+ of the initialization parameter<DT><B>Returns:</B><DD>a <code>String</code> containing the value
+ of the initialization parameter<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameterNames()"><!-- --></A><H3>
+getInitParameterNames</H3>
+<PRE>
+public java.util.Enumeration <B>getInitParameterNames</B>()</PRE>
+<DL>
+<DD>Returns the names of the portlet initialization parameters as an
+ <code>Enumeration</code> of String objects, or an empty <code>Enumeration</code> if the
+ portlet has no initialization parameters.<DD><DL>
+<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>String</code>
+ objects containing the names of the portlet
+ initialization parameters, or an empty <code>Enumeration</code> if the
+ portlet has no initialization parameters.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/Portlet.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletContext.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="PortletConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletConfig.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletConfig.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletContext.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletContext.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletContext.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletContext.html Fri May 16 17:57:32 2008
@@ -0,0 +1,726 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Interface PortletContext
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/PortletConfig.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletPreferences.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="PortletContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface PortletContext</H2>
+<HR>
+<DL>
+<DT>public interface <B>PortletContext</B></DL>
+
+<P>
+The <CODE>PortletContext</CODE> interface defines a portlet view
+ of the portlet container.
+ The <CODE>PortletContext</CODE> also makes resources available
+ to the portlet. Using the context, a portlet can access
+ the portlet log, and obtain URL references to resources.
+
+ <p>There is one context per "portlet application" per Java Virtual Machine. (A
+ "portlet application" is a collection of portlets, servlets, and content installed
+ under a specific subset of the server URL namespace, such as <code>/catalog</code>.
+ They are possibly installed via a <code>.war</code> file.)
+ As a web application, a portlet application also has a servlet context.
+ The portlet context leverages most of its functionality from the
+ servlet context of the portlet application.
+ <p>
+ Attibutes stored in the context are global for <I>all</I> users and <I>all</I>
+ components in the portlet application.
+ <p>
+ In the case of a web
+ application marked "distributed" in its deployment descriptor, there will
+ be one context instance for each virtual machine. In this situation, the
+ context cannot be used as a location to share global information (because
+ the information is not truly global). Use an external resource, such as
+ a database to achieve sharing on a global scope.
+<P>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns the portlet container attribute with the given name,
+ or null if there is no attribute by that name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getAttributeNames()">getAttributeNames</A></B>()</CODE>
+
+<BR>
+ Returns an <code>Enumeration</code> containing the attribute names
+ available within this portlet context, or an emtpy
+ <code>Enumeration</code> if no attributes are available.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getInitParameter(java.lang.String)">getInitParameter</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns a String containing the value of the named context-wide
+ initialization parameter, or <code>null</code> if the parameter does not exist.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getInitParameterNames()">getInitParameterNames</A></B>()</CODE>
+
+<BR>
+ Returns the names of the context initialization parameters as an
+ <code>Enumeration</code> of String objects, or an empty Enumeration if the context
+ has no initialization parameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getMajorVersion()">getMajorVersion</A></B>()</CODE>
+
+<BR>
+ Returns the major version of the Portlet API that this portlet
+ container supports.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getMimeType(java.lang.String)">getMimeType</A></B>(java.lang.String file)</CODE>
+
+<BR>
+ Returns the MIME type of the specified file, or <code>null</code> if
+ the MIME type is not known.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getMinorVersion()">getMinorVersion</A></B>()</CODE>
+
+<BR>
+ Returns the minor version of the Portlet API that this portlet
+ container supports.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/PortletRequestDispatcher.html">PortletRequestDispatcher</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getNamedDispatcher(java.lang.String)">getNamedDispatcher</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns a <A HREF="../../javax/portlet/PortletRequestDispatcher.html"><CODE>PortletRequestDispatcher</CODE></A> object that acts
+ as a wrapper for the named servlet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getPortletContextName()">getPortletContextName</A></B>()</CODE>
+
+<BR>
+ Returns the name of this portlet application correponding to this PortletContext as specified
+ in the <code>web.xml</code> deployment descriptor for this web application by the
+ <code>display-name</code> element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getRealPath(java.lang.String)">getRealPath</A></B>(java.lang.String path)</CODE>
+
+<BR>
+ Returns a <code>String</code> containing the real path
+ for a given virtual path.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/PortletRequestDispatcher.html">PortletRequestDispatcher</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getRequestDispatcher(java.lang.String)">getRequestDispatcher</A></B>(java.lang.String path)</CODE>
+
+<BR>
+ Returns a <A HREF="../../javax/portlet/PortletRequestDispatcher.html"><CODE>PortletRequestDispatcher</CODE></A> object that acts
+ as a wrapper for the resource located at the given path.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.net.URL</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getResource(java.lang.String)">getResource</A></B>(java.lang.String path)</CODE>
+
+<BR>
+ Returns a URL to the resource that is mapped to a specified
+ path.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.io.InputStream</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getResourceAsStream(java.lang.String)">getResourceAsStream</A></B>(java.lang.String path)</CODE>
+
+<BR>
+ Returns the resource located at the given path as an InputStream object.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Set</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getResourcePaths(java.lang.String)">getResourcePaths</A></B>(java.lang.String path)</CODE>
+
+<BR>
+ Returns a directory-like listing of all the paths to resources within
+ the web application longest sub-path of which
+ matches the supplied path argument.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#getServerInfo()">getServerInfo</A></B>()</CODE>
+
+<BR>
+ Returns the name and version of the portlet container in which the
+ portlet is running.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#log(java.lang.String)">log</A></B>(java.lang.String msg)</CODE>
+
+<BR>
+ Writes the specified message to a portlet log file, usually an event log.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#log(java.lang.String, java.lang.Throwable)">log</A></B>(java.lang.String message,
+ java.lang.Throwable throwable)</CODE>
+
+<BR>
+ Writes an explanatory message and a stack trace for a given
+ Throwable exception to the portlet log file.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#removeAttribute(java.lang.String)">removeAttribute</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Removes the attribute with the given name from the portlet context.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletContext.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></B>(java.lang.String name,
+ java.lang.Object object)</CODE>
+
+<BR>
+ Binds an object to a given attribute name in this portlet context.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="getServerInfo()"><!-- --></A><H3>
+getServerInfo</H3>
+<PRE>
+public java.lang.String <B>getServerInfo</B>()</PRE>
+<DL>
+<DD>Returns the name and version of the portlet container in which the
+ portlet is running.
+
+ <P>
+ The form of the returned string is <code>containername/versionnumber</code>.<DD><DL>
+<DT><B>Returns:</B><DD>the string containing at least name and version number</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRequestDispatcher(java.lang.String)"><!-- --></A><H3>
+getRequestDispatcher</H3>
+<PRE>
+public <A HREF="../../javax/portlet/PortletRequestDispatcher.html">PortletRequestDispatcher</A> <B>getRequestDispatcher</B>(java.lang.String path)</PRE>
+<DL>
+<DD>Returns a <A HREF="../../javax/portlet/PortletRequestDispatcher.html"><CODE>PortletRequestDispatcher</CODE></A> object that acts
+ as a wrapper for the resource located at the given path.
+ A <code>PortletRequestDispatcher</code> object can be used include the
+ resource in a response. The resource can be dynamic or static.
+
+ <p>The pathname must begin with a slash (<code> / </code>) and is interpreted as relative
+ to the current context root.
+
+ <p>This method returns <code>null</code> if the <code>PortletContext</code>
+ cannot return a <code>PortletRequestDispatcher</code>
+ for any reason.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - a <code>String</code> specifying the pathname
+ to the resource<DT><B>Returns:</B><DD>a <code>PortletRequestDispatcher</code> object
+ that acts as a wrapper for the resource
+ at the specified path.<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletRequestDispatcher.html"><CODE>PortletRequestDispatcher</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNamedDispatcher(java.lang.String)"><!-- --></A><H3>
+getNamedDispatcher</H3>
+<PRE>
+public <A HREF="../../javax/portlet/PortletRequestDispatcher.html">PortletRequestDispatcher</A> <B>getNamedDispatcher</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns a <A HREF="../../javax/portlet/PortletRequestDispatcher.html"><CODE>PortletRequestDispatcher</CODE></A> object that acts
+ as a wrapper for the named servlet.
+
+ <p>Servlets (and also JSP pages) may be given names via server
+ administration or via a web application deployment descriptor.
+
+ <p>This method returns <code>null</code> if the
+ <code>PortletContext</code> cannot return a
+ <code>PortletRequestDispatcher</code> for any reason.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
+ of a servlet to be wrapped<DT><B>Returns:</B><DD>a <code>PortletRequestDispatcher</code> object
+ that acts as a wrapper for the named servlet<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletRequestDispatcher.html"><CODE>PortletRequestDispatcher</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getResourceAsStream(java.lang.String)"><!-- --></A><H3>
+getResourceAsStream</H3>
+<PRE>
+public java.io.InputStream <B>getResourceAsStream</B>(java.lang.String path)</PRE>
+<DL>
+<DD>Returns the resource located at the given path as an InputStream object.
+ The data in the InputStream can be of any type or length. The method returns
+ null if no resource exists at the given path.
+ <p>
+ In order to access protected resources the path has to be prefixed with
+ <code>/WEB-INF/</code> (for example <code>/WEB-INF/myportlet/myportlet.jsp</code>).
+ Otherwise, the direct path is used
+ (for example <code>/myportlet/myportlet.jsp</code>).<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path to the resource<DT><B>Returns:</B><DD>the input stream</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMajorVersion()"><!-- --></A><H3>
+getMajorVersion</H3>
+<PRE>
+public int <B>getMajorVersion</B>()</PRE>
+<DL>
+<DD>Returns the major version of the Portlet API that this portlet
+ container supports.<DD><DL>
+<DT><B>Returns:</B><DD>the major version<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html#getMinorVersion()"><CODE>getMinorVersion()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMinorVersion()"><!-- --></A><H3>
+getMinorVersion</H3>
+<PRE>
+public int <B>getMinorVersion</B>()</PRE>
+<DL>
+<DD>Returns the minor version of the Portlet API that this portlet
+ container supports.<DD><DL>
+<DT><B>Returns:</B><DD>the minor version<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html#getMajorVersion()"><CODE>getMajorVersion()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMimeType(java.lang.String)"><!-- --></A><H3>
+getMimeType</H3>
+<PRE>
+public java.lang.String <B>getMimeType</B>(java.lang.String file)</PRE>
+<DL>
+<DD>Returns the MIME type of the specified file, or <code>null</code> if
+ the MIME type is not known. The MIME type is determined
+ by the configuration of the portlet container and may be specified
+ in a web application deployment descriptor. Common MIME
+ types are <code>text/html</code> and <code>image/gif</code>.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>file</CODE> - a <code>String</code> specifying the name
+ of a file<DT><B>Returns:</B><DD>a <code>String</code> specifying the MIME type of the file</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRealPath(java.lang.String)"><!-- --></A><H3>
+getRealPath</H3>
+<PRE>
+public java.lang.String <B>getRealPath</B>(java.lang.String path)</PRE>
+<DL>
+<DD>Returns a <code>String</code> containing the real path
+ for a given virtual path. For example, the path <code>/index.html</code>
+ returns the absolute file path of the portlet container file system.
+
+ <p>The real path returned will be in a form
+ appropriate to the computer and operating system on
+ which the portlet container is running, including the
+ proper path separators. This method returns <code>null</code>
+ if the portlet container cannot translate the virtual path
+ to a real path for any reason (such as when the content is
+ being made available from a <code>.war</code> archive).<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - a <code>String</code> specifying a virtual path<DT><B>Returns:</B><DD>a <code>String</code> specifying the real path,
+ or null if the transformation cannot be performed.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getResourcePaths(java.lang.String)"><!-- --></A><H3>
+getResourcePaths</H3>
+<PRE>
+public java.util.Set <B>getResourcePaths</B>(java.lang.String path)</PRE>
+<DL>
+<DD>Returns a directory-like listing of all the paths to resources within
+ the web application longest sub-path of which
+ matches the supplied path argument. Paths indicating subdirectory paths
+ end with a slash (<code>/</code>). The returned paths are all
+ relative to the root of the web application and have a leading slash.
+ For example, for a web application
+ containing<br><br>
+ <code>
+ /welcome.html<br>
+ /catalog/index.html<br>
+ /catalog/products.html<br>
+ /catalog/offers/books.html<br>
+ /catalog/offers/music.html<br>
+ /customer/login.jsp<br>
+ /WEB-INF/web.xml<br>
+ /WEB-INF/classes/com.acme.OrderPortlet.class,<br><br>
+ </code>
+
+ <code>getResourcePaths("/")</code> returns
+ <code>{"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}</code><br>
+ <code>getResourcePaths("/catalog/")</code> returns
+ <code>{"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}</code>.<br><DD><DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - the partial path used to match the resources, which must start with a slash<DT><B>Returns:</B><DD>a Set containing the directory listing, or <code>null</code> if there
+ are no resources in the web application of which the path
+ begins with the supplied path.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getResource(java.lang.String)"><!-- --></A><H3>
+getResource</H3>
+<PRE>
+public java.net.URL <B>getResource</B>(java.lang.String path)
+ throws java.net.MalformedURLException</PRE>
+<DL>
+<DD>Returns a URL to the resource that is mapped to a specified
+ path. The path must begin with a slash (<code>/</code>) and is interpreted
+ as relative to the current context root.
+
+ <p>This method allows the portlet container to make a resource
+ available to portlets from any source. Resources
+ can be located on a local or remote
+ file system, in a database, or in a <code>.war</code> file.
+
+ <p>The portlet container must implement the URL handlers
+ and <code>URLConnection</code> objects that are necessary
+ to access the resource.
+
+ <p>This method returns <code>null</code>
+ if no resource is mapped to the pathname.
+
+ <p>Some containers may allow writing to the URL returned by
+ this method using the methods of the URL class.
+
+ <p>The resource content is returned directly, so be aware that
+ requesting a <code>.jsp</code> page returns the JSP source code.
+ Use a <code>RequestDispatcher</code> instead to include results of
+ an execution.
+
+ <p>This method has a different purpose than
+ <code>java.lang.Class.getResource</code>,
+ which looks up resources based on a class loader. This
+ method does not use class loaders.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - a <code>String</code> specifying
+ the path to the resource<DT><B>Returns:</B><DD>the resource located at the named path,
+ or <code>null</code> if there is no resource
+ at that path<DT><B>Throws:</B><DD><CODE>MalformedURLException</CODE> - if the pathname is not given in
+ the correct form</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
+getAttribute</H3>
+<PRE>
+public java.lang.Object <B>getAttribute</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns the portlet container attribute with the given name,
+ or null if there is no attribute by that name.
+ An attribute allows a portlet container to give the
+ portlet additional information not
+ already provided by this interface.
+ A list of supported attributes can be retrieved using
+ <code>getAttributeNames</code>.
+
+ <p>The attribute is returned as a <code>java.lang.Object</code>
+ or some subclass.
+ Attribute names should follow the same convention as package
+ names. The Java Portlet API specification reserves names
+ matching <code>java.*</code>, <code>javax.*</code>,
+ and <code>sun.*</code>.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
+ of the attribute<DT><B>Returns:</B><DD>an <code>Object</code> containing the value
+ of the attribute, or <code>null</code>
+ if no attribute exists matching the given
+ name<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html#getAttributeNames()"><CODE>getAttributeNames()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAttributeNames()"><!-- --></A><H3>
+getAttributeNames</H3>
+<PRE>
+public java.util.Enumeration <B>getAttributeNames</B>()</PRE>
+<DL>
+<DD>Returns an <code>Enumeration</code> containing the attribute names
+ available within this portlet context, or an emtpy
+ <code>Enumeration</code> if no attributes are available. Use the
+ <A HREF="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)"><CODE>getAttribute(java.lang.String)</CODE></A> method with an attribute name
+ to get the value of an attribute.<DD><DL>
+<DT><B>Returns:</B><DD>an <code>Enumeration</code> of attribute names<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)"><CODE>getAttribute(java.lang.String)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
+getInitParameter</H3>
+<PRE>
+public java.lang.String <B>getInitParameter</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns a String containing the value of the named context-wide
+ initialization parameter, or <code>null</code> if the parameter does not exist.
+ This method provides configuration information which may be useful for
+ an entire "portlet application".<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> containing the name of the
+ requested parameter<DT><B>Returns:</B><DD>a <code>String</code> containing the value
+ of the initialization parameter, or
+ <code>null</code> if the parameter does not exist.<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html#getInitParameterNames()"><CODE>getInitParameterNames()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameterNames()"><!-- --></A><H3>
+getInitParameterNames</H3>
+<PRE>
+public java.util.Enumeration <B>getInitParameterNames</B>()</PRE>
+<DL>
+<DD>Returns the names of the context initialization parameters as an
+ <code>Enumeration</code> of String objects, or an empty Enumeration if the context
+ has no initialization parameters.<DD><DL>
+<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>String</code>
+ objects containing the names of the context
+ initialization parameters<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletContext.html#getInitParameter(java.lang.String)"><CODE>getInitParameter(java.lang.String)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="log(java.lang.String)"><!-- --></A><H3>
+log</H3>
+<PRE>
+public void <B>log</B>(java.lang.String msg)</PRE>
+<DL>
+<DD>Writes the specified message to a portlet log file, usually an event log.
+ The name and type of the portlet log file is specific to the portlet container.
+ <p>
+ This method mapps to the <code>ServletContext.log</code> method.
+ The portlet container may in addition log this message in a
+ portlet container specific log file.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>msg</CODE> - a <code>String</code> specifying the
+ message to be written to the log file</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="log(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
+log</H3>
+<PRE>
+public void <B>log</B>(java.lang.String message,
+ java.lang.Throwable throwable)</PRE>
+<DL>
+<DD>Writes an explanatory message and a stack trace for a given
+ Throwable exception to the portlet log file.
+ The name and type of the portlet log file is specific to the
+ portlet container, usually an event log.
+ <p>
+ This method is mapped to the <code>ServletContext.log</code> method.
+ The portlet container may in addition log this message in a
+ portlet container specific log file.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> that
+ describes the error or exception<DD><CODE>throwable</CODE> - the <code>Throwable</code> error
+ or exception</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
+removeAttribute</H3>
+<PRE>
+public void <B>removeAttribute</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Removes the attribute with the given name from the portlet context.
+ After removal, subsequent calls to
+ <A HREF="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)"><CODE>getAttribute(java.lang.String)</CODE></A> to retrieve the attribute's value
+ will return <code>null</code>.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
+ of the attribute to be removed<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
+setAttribute</H3>
+<PRE>
+public void <B>setAttribute</B>(java.lang.String name,
+ java.lang.Object object)</PRE>
+<DL>
+<DD>Binds an object to a given attribute name in this portlet context.
+ If the name specified is already used for an attribute, this method
+ removes the old attribute and binds the name to the new attribute.
+ <p>
+ If a null value is passed, the effect is the same as calling
+ <code>removeAttribute()</code>.
+
+ <p>Attribute names should follow the same convention as package
+ names. The Java Portlet API specification reserves names
+ matching <code>java.*</code>, <code>javax.*</code>, and
+ <code>sun.*</code>.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
+ of the attribute<DD><CODE>object</CODE> - an <code>Object</code> representing the
+ attribute to be bound<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortletContextName()"><!-- --></A><H3>
+getPortletContextName</H3>
+<PRE>
+public java.lang.String <B>getPortletContextName</B>()</PRE>
+<DL>
+<DD>Returns the name of this portlet application correponding to this PortletContext as specified
+ in the <code>web.xml</code> deployment descriptor for this web application by the
+ <code>display-name</code> element.<DD><DL>
+<DT><B>Returns:</B><DD>The name of the web application or null if no name has been declared in the deployment descriptor.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/PortletConfig.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletPreferences.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="PortletContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletContext.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletContext.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletException.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletException.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletException.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletException.html Fri May 16 17:57:32 2008
@@ -0,0 +1,371 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Class PortletException
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../javax/portlet/PortletModeException.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="PortletException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Class PortletException</H2>
+<PRE>
+java.lang.Object
+ |
+ +--java.lang.Throwable
+ |
+ +--java.lang.Exception
+ |
+ +--<B>javax.portlet.PortletException</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
+<DL>
+<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../javax/portlet/PortletModeException.html">PortletModeException</A>, <A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A>, <A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A>, <A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A>, <A HREF="../../javax/portlet/ValidatorException.html">ValidatorException</A>, <A HREF="../../javax/portlet/WindowStateException.html">WindowStateException</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public class <B>PortletException</B><DT>extends java.lang.Exception</DL>
+
+<P>
+The <CODE>PortletException</CODE> class defines a general exception
+ that a portlet can throw when it is unable to perform its operation
+ successfully.
+<P>
+<DL>
+<DT><B>See Also: </B><DD><A HREF="../../serialized-form.html#javax.portlet.PortletException">Serialized Form</A></DL>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#PortletException()">PortletException</A></B>()</CODE>
+
+<BR>
+ Constructs a new portlet exception.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#PortletException(java.lang.String)">PortletException</A></B>(java.lang.String text)</CODE>
+
+<BR>
+ Constructs a new portlet exception with the given text.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#PortletException(java.lang.String, java.lang.Throwable)">PortletException</A></B>(java.lang.String text,
+ java.lang.Throwable cause)</CODE>
+
+<BR>
+ Constructs a new portlet exception when the portlet needs to do
+ the following:
+
+ throw an exception
+ include the "root cause" exception
+ include a description message
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#PortletException(java.lang.Throwable)">PortletException</A></B>(java.lang.Throwable cause)</CODE>
+
+<BR>
+ Constructs a new portlet exception when the portlet needs to throw an
+ exception.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Throwable</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#getCause()">getCause</A></B>()</CODE>
+
+<BR>
+ Returns the cause of this throwable or <code>null</code> if the
+ cause is nonexistent or unknown.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#printStackTrace()">printStackTrace</A></B>()</CODE>
+
+<BR>
+ Prints the stack trace of this exception to the standard error stream.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#printStackTrace(java.io.PrintStream)">printStackTrace</A></B>(java.io.PrintStream out)</CODE>
+
+<BR>
+ Prints the stack trace of this exception to the specified print stream.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletException.html#printStackTrace(java.io.PrintWriter)">printStackTrace</A></B>(java.io.PrintWriter out)</CODE>
+
+<BR>
+ Prints the stack trace of this exception to the specified print writer.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.lang.Throwable</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>fillInStackTrace, getLocalizedMessage, getMessage, toString</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.lang.Object</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="PortletException()"><!-- --></A><H3>
+PortletException</H3>
+<PRE>
+public <B>PortletException</B>()</PRE>
+<DL>
+<DD>Constructs a new portlet exception.</DL>
+<HR>
+
+<A NAME="PortletException(java.lang.String)"><!-- --></A><H3>
+PortletException</H3>
+<PRE>
+public <B>PortletException</B>(java.lang.String text)</PRE>
+<DL>
+<DD>Constructs a new portlet exception with the given text. The
+ portlet container may use the text write it to a log.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="PortletException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
+PortletException</H3>
+<PRE>
+public <B>PortletException</B>(java.lang.String text,
+ java.lang.Throwable cause)</PRE>
+<DL>
+<DD>Constructs a new portlet exception when the portlet needs to do
+ the following:
+ <ul>
+ <li>throw an exception
+ <li>include the "root cause" exception
+ <li>include a description message
+ </ul><DD><DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text<DD><CODE>cause</CODE> - the root cause</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="PortletException(java.lang.Throwable)"><!-- --></A><H3>
+PortletException</H3>
+<PRE>
+public <B>PortletException</B>(java.lang.Throwable cause)</PRE>
+<DL>
+<DD>Constructs a new portlet exception when the portlet needs to throw an
+ exception. The exception's message is based on the localized message
+ of the underlying exception.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>cause</CODE> - the root cause</DL>
+</DD>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="printStackTrace()"><!-- --></A><H3>
+printStackTrace</H3>
+<PRE>
+public void <B>printStackTrace</B>()</PRE>
+<DL>
+<DD>Prints the stack trace of this exception to the standard error stream.<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>printStackTrace</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="printStackTrace(java.io.PrintStream)"><!-- --></A><H3>
+printStackTrace</H3>
+<PRE>
+public void <B>printStackTrace</B>(java.io.PrintStream out)</PRE>
+<DL>
+<DD>Prints the stack trace of this exception to the specified print stream.<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>printStackTrace</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>out</CODE> - the <code>PrintStream</code> to be used for output</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="printStackTrace(java.io.PrintWriter)"><!-- --></A><H3>
+printStackTrace</H3>
+<PRE>
+public void <B>printStackTrace</B>(java.io.PrintWriter out)</PRE>
+<DL>
+<DD>Prints the stack trace of this exception to the specified print writer.<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>printStackTrace</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>out</CODE> - the <code>PrintWriter</code> to be used for output</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCause()"><!-- --></A><H3>
+getCause</H3>
+<PRE>
+public java.lang.Throwable <B>getCause</B>()</PRE>
+<DL>
+<DD>Returns the cause of this throwable or <code>null</code> if the
+ cause is nonexistent or unknown. (The cause is the throwable that
+ caused this throwable to get thrown.)
+
+ <p>This implementation returns the cause that was supplied via one of
+ the constructors requiring a <tt>Throwable</tt>.<DD><DL>
+<DT><B>Returns:</B><DD>the cause of this throwable or <code>null</code> if the
+ cause is nonexistent or unknown.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../javax/portlet/PortletModeException.html"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
+ <A HREF="PortletException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletException.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletException.html
------------------------------------------------------------------------------
svn:mime-type = text/html