Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/GenericPortlet.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/GenericPortlet.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/GenericPortlet.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/GenericPortlet.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,1193 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>GenericPortlet (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="GenericPortlet (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GenericPortlet.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/GenericPortlet.html" target="_top">Frames</a></li> +<li><a href="GenericPortlet.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Class GenericPortlet" class="title">Class GenericPortlet</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.GenericPortlet</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../javax/portlet/EventPortlet.html" title="interface in javax.portlet">EventPortlet</a>, <a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a>, <a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a>, <a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet">ResourceServingPortlet</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">GenericPortlet</span> +extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a>, <a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a>, <a href="../../javax/portlet/EventPortlet.html" title="interface in javax.portlet">EventPortlet</a>, <a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet">ResourceServingPortlet</a></pre> +<div class="block">The <CODE>GenericPortlet</CODE> class provides a default implementation for + the <CODE>Portlet</CODE> interface. + <p> + It provides an abstract class to be subclassed to create portlets. A subclass + of <CODE>GenericPortlet</CODE> should either use one of the following annotations: + <ul> + <li><code>@ProcessAction</code></li> + <li><code>@ProcessEvent</code></li> + <li><code>@RenderMode</code></li> + </ul> + or override at least one method, usually + one of the following: + <ul> + <li>processAction, to handle action requests</li> + <li>doView, to handle render requests when in VIEW mode</li> + <li>doEdit, to handle render requests when in EDIT mode</li> + <li>doHelp, to handle render request when in HELP mode</li> + <li>init and destroy, to manage resources that are held for the life of the + servlet</li> + </ul> + <p> + Normally there is no need to override the render or the doDispatch methods. + Render handles render requests setting the title of the portlet in the + response and invoking doDispatch. doDispatch dispatches the request to one of + the doView, doEdit or doHelp method depending on the portlet mode indicated + in the request. + <p> + Portlets typically run on multithreaded servers, so please note that a + portlet must handle concurrent requests and be careful to synchronize access + to shared resources. Shared resources include in-memory data such as instance + or class variables and external objects such as files, database connections, + and network connections.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#AUTOMATIC_RESOURCE_DISPATCH">AUTOMATIC_RESOURCE_DISPATCH</a></strong></code> +<div class="block">This property is set by the container if the container + has a cached response for the given validation tag.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/GenericPortlet.html#GenericPortlet()">GenericPortlet</a></strong>()</code> +<div class="block">Does nothing.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#destroy()">destroy</a></strong>()</code> +<div class="block">Called by the portlet container to indicate to a portlet that the portlet + is being taken out of service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#doDispatch(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doDispatch</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">The default implementation of this method routes the render request to: + + + method annotated with <code>@RenderMode</code> and the name of the portlet mode + + + a set of helper methods depending on the current portlet mode the portlet + is currently in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#doEdit(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doEdit</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Helper method to serve up the <code>edit</code> mode.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#doHeaders(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doHeaders</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Used by the render method to set the response properties and headers.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#doHelp(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doHelp</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Helper method to serve up the <code>help</code> mode.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#doView(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doView</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Helper method to serve up the mandatory <code>view</code> mode.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getContainerRuntimeOptions()">getContainerRuntimeOptions</a></strong>()</code> +<div class="block">Returns the container runtime options + and values for this portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getDefaultNamespace()">getDefaultNamespace</a></strong>()</code> +<div class="block">Returns the default namespace for events and public parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getInitParameter(java.lang.String)">getInitParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns a String containing the value of the named initialization * parameter, or null if the parameter does not exist.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getInitParameterNames()">getInitParameterNames</a></strong>()</code> +<div class="block">Returns the names of the portlet initialization parameters as an + Enumeration of String objects, or an empty Enumeration if the portlet has + no initialization parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getNextPossiblePortletModes(javax.portlet.RenderRequest)">getNextPossiblePortletModes</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</code> +<div class="block">Used by the render method to set the next possible portlet modes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getPortletConfig()">getPortletConfig</a></strong>()</code> +<div class="block">Returns the PortletConfig object of this portlet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getPortletContext()">getPortletContext</a></strong>()</code> +<div class="block">Returns the <code>PortletContext</code> of the portlet application the + portlet is in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getPortletName()">getPortletName</a></strong>()</code> +<div class="block">Returns the name of this portlet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getProcessingEventQNames()">getProcessingEventQNames</a></strong>()</code> +<div class="block">Returns the QNames of the processing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any processing events.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getPublicRenderParameterNames()">getPublicRenderParameterNames</a></strong>()</code> +<div class="block">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.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getPublishingEventQNames()">getPublishingEventQNames</a></strong>()</code> +<div class="block">Returns the QNames of the publishing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any publishing events.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/ResourceBundle.html?is-external=true"; title="class or interface in java.util">ResourceBundle</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getResourceBundle(java.util.Locale)">getResourceBundle</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> +<div class="block">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.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getSupportedLocales()">getSupportedLocales</a></strong>()</code> +<div class="block">Returns the locales supported by the portlet + as an <code>Enumeration</code> of <code>Locale</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any supported locales.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#getTitle(javax.portlet.RenderRequest)">getTitle</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</code> +<div class="block">Used by the render method to get the title.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#init()">init</a></strong>()</code> +<div class="block">A convenience method which can be overridden so that there's no need to + call <code>super.init(config)</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)">init</a></strong>(<a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a> config)</code> +<div class="block">Called by the portlet container to indicate to a portlet that the portlet + is being placed into service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#processAction(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse)">processAction</a></strong>(<a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a> request, + <a href="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a> response)</code> +<div class="block">Called by the portlet container to allow the portlet to process an action + request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#processEvent(javax.portlet.EventRequest,%20javax.portlet.EventResponse)">processEvent</a></strong>(<a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a> request, + <a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</a> response)</code> +<div class="block">The default implementation tries to dispatch to a method + annotated with <code>@ProcessEvent</code> 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>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#render(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">render</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">The default implementation of this method sets the headers using the + <code>doHeaders</code> method, sets the title using the + <code>getTitle</code> method and invokes the <code>doDispatch</code> + method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/GenericPortlet.html#serveResource(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse)">serveResource</a></strong>(<a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a> request, + <a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a> response)</code> +<div class="block">Default resource serving.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="AUTOMATIC_RESOURCE_DISPATCH"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AUTOMATIC_RESOURCE_DISPATCH</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> AUTOMATIC_RESOURCE_DISPATCH</pre> +<div class="block">This property is set by the container if the container + has a cached response for the given validation tag. The property can be + retrieved using the <code>getProperty</code> method. + <P> + The value is <code>"javax.portlet.automaticResourceDispatching"</code>.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.GenericPortlet.AUTOMATIC_RESOURCE_DISPATCH">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GenericPortlet()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GenericPortlet</h4> +<pre>public GenericPortlet()</pre> +<div class="block">Does nothing.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(javax.portlet.PortletConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public void init(<a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a> config) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<div class="block">Called by the portlet container to indicate to a portlet that the portlet + is being placed into service. + <p> + The default implementation stores the <code>PortletConfig</code> object + and checks for annotated methods with the annotations + <ul> + <li>@ProcessAction</li> + <li>@ProcessEvent</li> + <li>@RenderMode</li> + </ul> + and stores these in a hashmap for later dispatching. + <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 does one of the following: + <ol> + <li>it throws a <code>PortletException</code> + <li>it does not return within a time period defined by the Web server + </ol></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/Portlet.html#init(javax.portlet.PortletConfig)">init</a></code> in interface <code><a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - a <code>PortletConfig</code> object containing the portlet + configuration and initialization parameters</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if an exception has occurred that interferes with the + portlet normal operation.</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet cannot perform the initialization at this + time.</dd></dl> +</li> +</ul> +<a name="init()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public void init() + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<div class="block">A convenience method which can be overridden so that there's no need to + call <code>super.init(config)</code>. + + <p> + Instead of overriding <a href="../../javax/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)"><code>init(PortletConfig)</code></a>, simply override this + method and it will be called by + <code>GenericPortlet.init(PortletConfig config)</code>. The + <code>PortletConfig</code> object can still be retrieved via <a href="../../javax/portlet/GenericPortlet.html#getPortletConfig()"><code>getPortletConfig()</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if an exception has occurred that interferes with the + portlet normal operation.</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet is unavailable to perform init</dd></dl> +</li> +</ul> +<a name="processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processAction</h4> +<pre>public void processAction(<a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a> request, + <a href="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Called by the portlet container to allow the portlet to process an action + request. This method is called if the client request was originated by a + URL created (by the portlet) with the + <code>RenderResponse.createActionURL()</code> method. + <p> + The default implementation tries to dispatch to a method + annotated with <code>@ProcessAction</code> that matches the action parameter + value <code>ActionRequest.ACTION_NAME</code> or, if no + such method is found throws a <code>PortletException</code>.<br> + Note that the annotated methods needs to be public in order + to be allowed to be called by <code>GenericPortlet</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/Portlet.html#processAction(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse)">processAction</a></code> in interface <code><a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the action request</dd><dd><code>response</code> - the action response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet cannot fulfill the request</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet is unavailable to process the action at + this time</dd> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fulfill this request due to + security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></dl> +</li> +</ul> +<a name="render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>render</h4> +<pre>public void render(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">The default implementation of this method sets the headers using the + <code>doHeaders</code> method, sets the title using the + <code>getTitle</code> method and invokes the <code>doDispatch</code> + method. + <p> + It also evaluates the <code>RENDER_PART</code> request attribute and if + set calls the <code>doHeaders, getNextPossiblePortletModes</code> and + <code>getTitle</code> methods for the <code>RENDER_HEADERS</code> + part and the <code>doDispatch</code> method for the + <code>RENDER_MARKUP</code> part.<br> + If the <code>RENDER_PART</code> request attribute is not set all of the + above methods will be called.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/Portlet.html#render(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">render</a></code> in interface <code><a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the render request</dd><dd><code>response</code> - the render response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet cannot fulfill the request</dd> +<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> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fulfill this request due to + security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></dl> +</li> +</ul> +<a name="getTitle(javax.portlet.RenderRequest)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTitle</h4> +<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTitle(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</pre> +<div class="block">Used by the render method to get the title. + <p> + The default implementation gets the title from the ResourceBundle of the + PortletConfig of the portlet. The title is retrieved using the + 'javax.portlet.title' resource name. + <p> + Portlets can overwrite this method to provide dynamic titles (e.g. based + on locale, client, and session information). Examples are: + <UL> + <LI>language-dependent titles for multi-lingual portals</li> + <LI>shorter titles for WAP phones</li> + <LI>the number of messages in a mailbox portlet</li> + </UL></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet title for this window</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if no portlet config object is available</dd></dl> +</li> +</ul> +<a name="doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doDispatch</h4> +<pre>protected void doDispatch(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">The default implementation of this method routes the render request to: + <ol> + <li> + method annotated with <code>@RenderMode</code> and the name of the portlet mode + </li> + <li> + a set of helper methods depending on the current portlet mode the portlet + is currently in. These methods are: + <ul> + <li><code>doView</code> for handling <code>view</code> requests</li> + <li><code>doEdit</code> for handling <code>edit</code> requests</li> + <li><code>doHelp</code> for handling <code>help</code> requests</li> + </ul> + </li> + </ol> + <p> + If the window state of this portlet is <code>minimized</code>, this + method does not invoke any of the portlet mode rendering methods. + <p> + For handling custom portlet modes the portlet should either use the + <code>@RenderMode</code> annotation or override this + method. Note that the annotated methods needs to be public in order + to be allowed to be called by <code>GenericPortlet</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the render request</dd><dd><code>response</code> - the render response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet cannot fulfill the request</dd> +<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> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fulfill this request due to + security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/GenericPortlet.html#doView(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)"><code>doView(RenderRequest, RenderResponse)</code></a>, +<a href="../../javax/portlet/GenericPortlet.html#doEdit(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)"><code>doEdit(RenderRequest, RenderResponse)</code></a>, +<a href="../../javax/portlet/GenericPortlet.html#doHelp(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)"><code>doHelp(RenderRequest, RenderResponse)</code></a></dd></dl> +</li> +</ul> +<a name="doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doView</h4> +<pre>protected void doView(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Helper method to serve up the mandatory <code>view</code> mode. + <p> + The default implementation throws an exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the portlet request</dd><dd><code>response</code> - the render response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet cannot fulfill the request</dd> +<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> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fulfill this request due to + security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></dl> +</li> +</ul> +<a name="doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doEdit</h4> +<pre>protected void doEdit(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Helper method to serve up the <code>edit</code> mode. + <p> + The default implementation throws an exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the portlet request</dd><dd><code>response</code> - the render response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet cannot fulfill the request</dd> +<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> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fulfill this request due to + security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></dl> +</li> +</ul> +<a name="doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doHelp</h4> +<pre>protected void doHelp(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Helper method to serve up the <code>help</code> mode. + <p> + The default implementation throws an exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the portlet request</dd><dd><code>response</code> - the render response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet cannot fulfill the request</dd> +<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> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fulfill this request due to + security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></dl> +</li> +</ul> +<a name="getPortletConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletConfig</h4> +<pre>public <a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a> getPortletConfig()</pre> +<div class="block">Returns the PortletConfig object of this portlet.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the PortletConfig object of this portlet</dd></dl> +</li> +</ul> +<a name="destroy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>destroy</h4> +<pre>public void destroy()</pre> +<div class="block">Called by the portlet container to indicate to a portlet that the portlet + is being taken out of service. + <p> + The default implementation does nothing.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/Portlet.html#destroy()">destroy</a></code> in interface <code><a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a></code></dd> +</dl> +</li> +</ul> +<a name="getPortletName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletName</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getPortletName()</pre> +<div class="block">Returns the name of this portlet.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getPortletName()">getPortletName</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the portlet name</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletConfig.html#getPortletName()"><code>PortletConfig.getPortletName()</code></a></dd></dl> +</li> +</ul> +<a name="getPortletContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletContext</h4> +<pre>public <a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a> getPortletContext()</pre> +<div class="block">Returns the <code>PortletContext</code> of the portlet application the + portlet is in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the portlet application context</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><code>PortletContext</code></a></dd></dl> +</li> +</ul> +<a name="getResourceBundle(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceBundle</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/ResourceBundle.html?is-external=true"; title="class or interface in java.util">ResourceBundle</a> getResourceBundle(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</pre> +<div class="block">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.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the locale for which to retrieve the resource bundle</dd> +<dt><span class="strong">Returns:</span></dt><dd>the resource bundle for the given locale</dd></dl> +</li> +</ul> +<a name="getInitParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameter</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getInitParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns a String containing the value of the named initialization * parameter, or null if the parameter does not exist.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name of the + initialization parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the value of the + initialization parameter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getInitParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameterNames</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getInitParameterNames()</pre> +<div class="block">Returns the names of the portlet initialization parameters as an + Enumeration of String objects, or an empty Enumeration if the portlet has + no initialization parameters.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> objects + containing the names of the portlet initialization parameters, or + an empty Enumeration if the portlet has no initialization + parameters.</dd></dl> +</li> +</ul> +<a name="getProcessingEventQNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProcessingEventQNames</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>> getProcessingEventQNames()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">PortletConfig</a></code></strong></div> +<div class="block">Returns the QNames of the processing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any processing events. + <p> + Processing events are defined in the portlet deployment descriptor + with the <code>supported-processing-event</code> element. + <p> + If the event was defined using the <code>name</code> element instead of + the <code>qname</code> element the defined default namespace + is added as namespace for the returned QName.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">getProcessingEventQNames</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>QName</code> + objects containing the names of the processing events, + or an empty <code>Enumeration</code> if the + portlet has not defined any support for processing events in + the deployment descriptor.</dd></dl> +</li> +</ul> +<a name="getPublishingEventQNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPublishingEventQNames</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>> getPublishingEventQNames()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">PortletConfig</a></code></strong></div> +<div class="block">Returns the QNames of the publishing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any publishing events. + <p> + Publishing events are defined in the portlet deployment descriptor + with the <code>supported-publishing-event</code> element. + <p> + Note that this call does not return any events published that have not been + declared in the deployment descriptor as supported. + <p> + If the event was defined using the <code>name</code> element instead of + the <code>qname</code> element the defined default namespace + is added as namespace for the returned QName.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">getPublishingEventQNames</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>QName</code> + objects containing the names of the publishing events, + or an empty <code>Enumeration</code> if the + portlet has not defined any support for publishing events in + the deployment descriptor.</dd></dl> +</li> +</ul> +<a name="getSupportedLocales()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedLocales</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a>> getSupportedLocales()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/PortletConfig.html#getSupportedLocales()">PortletConfig</a></code></strong></div> +<div class="block">Returns the locales supported by the portlet + as an <code>Enumeration</code> of <code>Locale</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any supported locales. + <p> + Supported locales are defined in the portlet deployment descriptor + with the <code>supported-locale</code> element.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletConfig.html#getSupportedLocales()">getSupportedLocales</a></code> in interface <code><a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>Locale</code> + objects containing the supported locales, + or an empty <code>Enumeration</code> if the + portlet has not defined any supported locales in + the deployment descriptor.</dd></dl> +</li> +</ul> +<a name="getContainerRuntimeOptions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContainerRuntimeOptions</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getContainerRuntimeOptions()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/PortletConfig.html#getContainerRuntimeOptions()">PortletConfig</a></code></strong></div> +<div class="block">Returns the container runtime options + and values for this portlet. + <p> + The portlet can set container runtime + options in the <code>portlet.xml</code> via the + <code>container-runtime-option</code> element with a name and a + value on the application and portlet level.<br> + If a container runtime option is set on the portlet application + level and on the portlet level with the same name the setting + on the portlet level takes precedence and overwrites the one + 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.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<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></dd> +<dt><span class="strong">Returns:</span></dt><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>).</dd></dl> +</li> +</ul> +<a name="serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serveResource</h4> +<pre>public void serveResource(<a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a> request, + <a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Default resource serving. + <p> + The default implementation of this method does nothing. + <p> + However, if the reserved portlet initialization parameter + <a href="../../javax/portlet/GenericPortlet.html#AUTOMATIC_RESOURCE_DISPATCH"><code>AUTOMATIC_RESOURCE_DISPATCH</code></a> + (= "javax.portlet.automaticResourceDispatching") + is set to <code>true</code>, the default + implementation will perform a + <code>PortletRequestDispatcher.forward</code> to the location designated by + the ResourceID of the ResourceRequest. + If no ResourceID is set on the resource URL the default implementation + does nothing.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/ResourceServingPortlet.html#serveResource(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse)">serveResource</a></code> in interface <code><a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet">ResourceServingPortlet</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the resource request</dd><dd><code>response</code> - the resource response</dd> +<dt><span class="strong">Throws:</span></dt> +<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> +<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> +<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> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processEvent</h4> +<pre>public void processEvent(<a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a> request, + <a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">The default implementation tries to dispatch to a method + annotated with <code>@ProcessEvent</code> 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>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/EventPortlet.html#processEvent(javax.portlet.EventRequest,%20javax.portlet.EventResponse)">processEvent</a></code> in interface <code><a href="../../javax/portlet/EventPortlet.html" title="interface in javax.portlet">EventPortlet</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the event request</dd><dd><code>response</code> - the event response</dd> +<dt><span class="strong">Throws:</span></dt> +<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> +<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> +<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> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/EventPortlet.html#processEvent(javax.portlet.EventRequest,%20javax.portlet.EventResponse)"><code>EventPortlet.processEvent(javax.portlet.EventRequest, + javax.portlet.EventResponse)</code></a></dd></dl> +</li> +</ul> +<a name="doHeaders(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doHeaders</h4> +<pre>protected void doHeaders(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the render request</dd><dd><code>response</code> - the render response</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getNextPossiblePortletModes(javax.portlet.RenderRequest)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextPossiblePortletModes</h4> +<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a>> getNextPossiblePortletModes(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</pre> +<div class="block">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>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getPublicRenderParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPublicRenderParameterNames</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getPublicRenderParameterNames()</pre> +<div class="block">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.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<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></dd> +<dt><span class="strong">Returns:</span></dt><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.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletConfig.html#getPublicRenderParameterNames()"><code>PortletConfig.getPublicRenderParameterNames()</code></a></dd></dl> +</li> +</ul> +<a name="getDefaultNamespace()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDefaultNamespace</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getDefaultNamespace()</pre> +<div class="block">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>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<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></dd> +<dt><span class="strong">Returns:</span></dt><dd>the default namespace defined in the portlet deployment + descriptor, or <code>XMLConstants.NULL_NS_URI</code> is non is + defined.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletConfig.html#getDefaultNamespace()"><code>PortletConfig.getDefaultNamespace()</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GenericPortlet.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/GenericPortlet.html" target="_top">Frames</a></li> +<li><a href="GenericPortlet.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
