Added: portals/site-live/portlet-api/portlet-api-2.1.0/index-all.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/index-all.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/index-all.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/index-all.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,2962 @@ +<!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:28 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Index (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="Index (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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="./overview-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_J_">J</a> <a href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_N_">N</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> <a name="_A_"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><span class="strong"><a href="./javax/portlet/ActionRequest.html#ACTION_NAME">ACTION_NAME</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a></dt> +<dd> +<div class="block">Predefined action name for usage with the + <code>@ProcessAction</code> annotation.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#ACTION_PHASE">ACTION_PHASE</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">String identifier for the portlet action lifecycle phase.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#ACTION_SCOPE_ID">ACTION_SCOPE_ID</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">The action scope ID that the portlet container uses + for storing the current action scope as render parameter + if the <code>javax.portlet.actionScopedRequestAttributes</code> + container runtime option is used by the portlet.</div> +</dd> +<dt><a href="./javax/portlet/filter/ActionFilter.html" title="interface in javax.portlet.filter"><span class="strong">ActionFilter</span></a> - Interface in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">The <code>ActionFilter</code> is an object that performs filtering + tasks on either the action request to a portlet, or on the action response from + a portlet, or both.</div> +</dd> +<dt><a href="./javax/portlet/ActionRequest.html" title="interface in javax.portlet"><span class="strong">ActionRequest</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>ActionRequest</CODE> represents the request sent to the portlet + to handle an action.<br> + It extends the ClientDataRequest interface and provides action request + information to portlets.</div> +</dd> +<dt><a href="./javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">ActionRequestWrapper</span></a> - Class in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">The <code>ActionRequestWrapper</code> provides a convenient + implementation of the <code>ActionRequest</code> interface + that can be subclassed by developers wishing to adapt the request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionRequestWrapper.html#ActionRequestWrapper(javax.portlet.ActionRequest)">ActionRequestWrapper(ActionRequest)</a></span> - Constructor for class javax.portlet.filter.<a href="./javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a></dt> +<dd> +<div class="block">Creates an <code>ActionRequest</code> adaptor + wrapping the given request object.</div> +</dd> +<dt><a href="./javax/portlet/ActionResponse.html" title="interface in javax.portlet"><span class="strong">ActionResponse</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>ActionResponse</CODE> interface represents the portlet + response to an action request.</div> +</dd> +<dt><a href="./javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">ActionResponseWrapper</span></a> - Class in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">The <code>ActionResponseWrapper</code> provides a convenient + implementation of the <code>ActionResponse</code> interface + that can be subclassed by developers wishing to adapt the response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionResponseWrapper.html#ActionResponseWrapper(javax.portlet.ActionResponse)">ActionResponseWrapper(ActionResponse)</a></span> - Constructor for class javax.portlet.filter.<a href="./javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter">ActionResponseWrapper</a></dt> +<dd> +<div class="block">Creates an <code>ActionResponse</code> adaptor + wrapping the given response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/BaseURL.html#addProperty(java.lang.String,%20java.lang.String)">addProperty(String, String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></dt> +<dd> +<div class="block">Adds a String property to an existing key on the URL.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletResponseWrapper.html#addProperty(java.lang.String,%20java.lang.String)">addProperty(String, String)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>addProperty(key, value)</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletResponseWrapper.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty(String, Element)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>addProperty()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletResponseWrapper.html#addProperty(javax.servlet.http.Cookie)">addProperty(Cookie)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>addProperty()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20java.lang.String)">addProperty(String, String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dt> +<dd> +<div class="block">Adds a String property to an existing key to be returned to the portal.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty(Cookie)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dt> +<dd> +<div class="block">Adds a HTTP Cookie property to the response.<br> + The portlet should note that the cookie may not make + it to the client, but may be stored at the portal.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty(String, Element)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dt> +<dd> +<div class="block">Adds an XML DOM element property to the response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#APPLICATION_SCOPE">APPLICATION_SCOPE</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">This constant defines an application wide scope for the session attribute.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#AUTOMATIC_RESOURCE_DISPATCH">AUTOMATIC_RESOURCE_DISPATCH</a></span> - Static variable in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">This property is set by the container if the container + has a cached response for the given validation tag.</div> +</dd> +</dl> +<a name="_B_"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><a href="./javax/portlet/BaseURL.html" title="interface in javax.portlet"><span class="strong">BaseURL</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>BaseURL</CODE> defines the basic capabilities + of a portlet URL pointing back to the portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#BASIC_AUTH">BASIC_AUTH</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">String identifier for Basic authentication.</div> +</dd> +</dl> +<a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#CACHE_SCOPE">CACHE_SCOPE</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Property to set the cache scope for this response using the + <code>setProperty</code> method intended to be used in + forwarded or included servlets/JSPs.</div> +</dd> +<dt><a href="./javax/portlet/CacheControl.html" title="interface in javax.portlet"><span class="strong">CacheControl</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <code>CacheControl</code> interface represents cache settings + for a piece of markup.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#CCPP_PROFILE">CCPP_PROFILE</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Used to retrieve an instance of the <code>javax.ccpp.Profile</code> + with the <code>getAttribute</code> call.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#CLIENT_CERT_AUTH">CLIENT_CERT_AUTH</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">String identifier for Certification based authentication.</div> +</dd> +<dt><a href="./javax/portlet/ClientDataRequest.html" title="interface in javax.portlet"><span class="strong">ClientDataRequest</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>ClientDataRequest</CODE> represents the request information + of the HTTP request issued from the client to the portal.<BR> + It extends the PortletRequest interface.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#createActionURL()">createActionURL()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createActionURL()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#createActionURL()">createActionURL()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createActionURL()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#createActionURL()">createActionURL()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceResponse.html#createActionURL()">createActionURL()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletResponseWrapper.html#createElement(java.lang.String)">createElement(String)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createElement()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletResponse.html#createElement(java.lang.String)">createElement(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dt> +<dd> +<div class="block">Creates an element of the type specified to be used in the + <a href="./javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)"><code>PortletResponse.addProperty(String,Element)</code></a> method.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#createRenderURL()">createRenderURL()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createRenderURL()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#createRenderURL()">createRenderURL()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createRenderURL()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#createRenderURL()">createRenderURL()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceResponse.html#createRenderURL()">createRenderURL()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#createResourceURL()">createResourceURL()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createResourceURL()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#createResourceURL()">createResourceURL()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>createResourceURL()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#createResourceURL()">createResourceURL()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceResponse.html#createResourceURL()">createResourceURL()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a></dt> +<dd> </dd> +</dl> +<a name="_D_"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><span class="strong"><a href="./javax/portlet/PortletSessionUtil.html#decodeAttributeName(java.lang.String)">decodeAttributeName(String)</a></span> - Static method in class javax.portlet.<a href="./javax/portlet/PortletSessionUtil.html" title="class in javax.portlet">PortletSessionUtil</a></dt> +<dd> +<div class="block">Returns the attribute name of an attribute in the + <code>PORTLET_SCOPE</code>.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSessionUtil.html#decodeScope(java.lang.String)">decodeScope(String)</a></span> - Static method in class javax.portlet.<a href="./javax/portlet/PortletSessionUtil.html" title="class in javax.portlet">PortletSessionUtil</a></dt> +<dd> +<div class="block">Returns the portlet attribute scope from an encoded portlet + attribute.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletFilter.html#destroy()">destroy()</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></dt> +<dd> +<div class="block">Called by the portlet container to indicate to a filter that it is + being taken out of service.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#destroy()">destroy()</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Called by the portlet container to indicate to a portlet that the portlet + is being taken out of service.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/Portlet.html#destroy()">destroy()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</a></dt> +<dd> +<div class="block">Called by the portlet container to indicate to a portlet that the + portlet is being taken out of service.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#DIGEST_AUTH">DIGEST_AUTH</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">String identifier for Digest based authentication.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#doDispatch(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doDispatch(RenderRequest, RenderResponse)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#doEdit(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doEdit(RenderRequest, RenderResponse)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Helper method to serve up the <code>edit</code> mode.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionFilter.html#doFilter(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse,%20javax.portlet.filter.FilterChain)">doFilter(ActionRequest, ActionResponse, FilterChain)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/ActionFilter.html" title="interface in javax.portlet.filter">ActionFilter</a></dt> +<dd> +<div class="block">The <code>doFilter</code> method of the Filter is called by the + portlet container each time a action request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/EventFilter.html#doFilter(javax.portlet.EventRequest,%20javax.portlet.EventResponse,%20javax.portlet.filter.FilterChain)">doFilter(EventRequest, EventResponse, FilterChain)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/EventFilter.html" title="interface in javax.portlet.filter">EventFilter</a></dt> +<dd> +<div class="block">The <code>doFilter</code> method of the Filter is called by the + portlet container each time a event request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse)">doFilter(ActionRequest, ActionResponse)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a></dt> +<dd> +<div class="block">Causes the next filter in the chain to be invoked, + or if the calling filter is the last filter in the chain, + causes the portlet at the end of the chain to be invoked.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.EventRequest,%20javax.portlet.EventResponse)">doFilter(EventRequest, EventResponse)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a></dt> +<dd> +<div class="block">Causes the next filter in the chain to be invoked, + or if the calling filter is the last filter in the chain, + causes the portlet at the end of the chain to be invoked.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doFilter(RenderRequest, RenderResponse)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a></dt> +<dd> +<div class="block">Causes the next filter in the chain to be invoked, + or if the calling filter is the last filter in the chain, + causes the portlet at the end of the chain to be invoked.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse)">doFilter(ResourceRequest, ResourceResponse)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a></dt> +<dd> +<div class="block">Causes the next filter in the chain to be invoked, + or if the calling filter is the last filter in the chain, + causes the portlet at the end of the chain to be invoked.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderFilter.html#doFilter(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse,%20javax.portlet.filter.FilterChain)">doFilter(RenderRequest, RenderResponse, FilterChain)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/RenderFilter.html" title="interface in javax.portlet.filter">RenderFilter</a></dt> +<dd> +<div class="block">The <code>doFilter</code> method of the Filter is called by the + portlet container each time a render request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceFilter.html#doFilter(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse,%20javax.portlet.filter.FilterChain)">doFilter(ResourceRequest, ResourceResponse, FilterChain)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/ResourceFilter.html" title="interface in javax.portlet.filter">ResourceFilter</a></dt> +<dd> +<div class="block">The <code>doFilter</code> method of the Filter is called by the + portlet container each time a resource request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#doHeaders(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doHeaders(RenderRequest, RenderResponse)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Used by the render method to set the response properties and headers.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#doHelp(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doHelp(RenderRequest, RenderResponse)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Helper method to serve up the <code>help</code> mode.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#doView(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doView(RenderRequest, RenderResponse)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Helper method to serve up the mandatory <code>view</code> mode.</div> +</dd> +</dl> +<a name="_E_"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><span class="strong"><a href="./javax/portlet/PortletMode.html#EDIT">EDIT</a></span> - Static variable in class javax.portlet.<a href="./javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a></dt> +<dd> +<div class="block">Within the <code>EDIT</code> portlet mode, a portlet should provide + content and logic that lets a user customize the behavior of the portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletResponseWrapper.html#encodeURL(java.lang.String)">encodeURL(String)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>encodeURL(path)</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletResponse.html#encodeURL(java.lang.String)">encodeURL(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dt> +<dd> +<div class="block">Returns the encoded URL of the resource, like servlets, JSPs, images and + other static files, at the given path.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletMode.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a></dt> +<dd> +<div class="block">Compares the specified object with this portlet mode + for equality.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/WindowState.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></dt> +<dd> +<div class="block">Compares the specified object with this window state + for equality.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#ETAG">ETAG</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Property to tell the portlet container the new ETag for this response + intended to be used in forwarded or included servlets/JSPs.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/RenderRequest.html#ETAG">ETAG</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></dt> +<dd> +<div class="block">This property is set by the container if the portlet container + has a cached response for the given validation tag.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceRequest.html#ETAG">ETAG</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a></dt> +<dd> +<div class="block">This property is set by the container if the container + has a cached response for the given validation tag.</div> +</dd> +<dt><a href="./javax/portlet/Event.html" title="interface in javax.portlet"><span class="strong">Event</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <code>Event</code> interface represents an event that the portlet has received + in the event processing phase.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#EVENT_PHASE">EVENT_PHASE</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">String identifier for the portlet event lifecycle phase.</div> +</dd> +<dt><a href="./javax/portlet/filter/EventFilter.html" title="interface in javax.portlet.filter"><span class="strong">EventFilter</span></a> - Interface in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">The <code>EventFilter</code> is an object that performs filtering + tasks on either the event request to a portlet, or on the event response from + a portlet, or both.</div> +</dd> +<dt><a href="./javax/portlet/EventPortlet.html" title="interface in javax.portlet"><span class="strong">EventPortlet</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <code>EventPortlet</code> interface allows + portlets receiving events.</div> +</dd> +<dt><a href="./javax/portlet/EventRequest.html" title="interface in javax.portlet"><span class="strong">EventRequest</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>EventRequest</CODE> represents the request sent to the portlet + to handle an event.</div> +</dd> +<dt><a href="./javax/portlet/filter/EventRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">EventRequestWrapper</span></a> - Class in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">The <code>EventRequestWrapper</code> provides a convenient + implementation of the <code>EventRequest</code> interface + that can be subclassed by developers wishing to adapt the request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/EventRequestWrapper.html#EventRequestWrapper(javax.portlet.EventRequest)">EventRequestWrapper(EventRequest)</a></span> - Constructor for class javax.portlet.filter.<a href="./javax/portlet/filter/EventRequestWrapper.html" title="class in javax.portlet.filter">EventRequestWrapper</a></dt> +<dd> +<div class="block">Creates an <code>EventRequest</code> adaptor + wrapping the given request object.</div> +</dd> +<dt><a href="./javax/portlet/EventResponse.html" title="interface in javax.portlet"><span class="strong">EventResponse</span></a> - Interface in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>EventResponse</CODE> interface represents the portlet + response to an event request.</div> +</dd> +<dt><a href="./javax/portlet/filter/EventResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">EventResponseWrapper</span></a> - Class in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">The <code>EventResponseWrapper</code> provides a convenient + implementation of the <code>EventResponse</code> interface + that can be subclassed by developers wishing to adapt the response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/EventResponseWrapper.html#EventResponseWrapper(javax.portlet.EventResponse)">EventResponseWrapper(EventResponse)</a></span> - Constructor for class javax.portlet.filter.<a href="./javax/portlet/filter/EventResponseWrapper.html" title="class in javax.portlet.filter">EventResponseWrapper</a></dt> +<dd> +<div class="block">Creates an <code>EventResponse</code> adaptor + wrapping the given response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#EXPIRATION_CACHE">EXPIRATION_CACHE</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Property to set the expiration time in seconds for this response using + the <code>setProperty</code> method intended to be used in + forwarded or included servlets/JSPs.</div> +</dd> +</dl> +<a name="_F_"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><span class="strong"><a href="./javax/portlet/PortletURLGenerationListener.html#filterActionURL(javax.portlet.PortletURL)">filterActionURL(PortletURL)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletURLGenerationListener.html" title="interface in javax.portlet">PortletURLGenerationListener</a></dt> +<dd> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on action URLs.</div> +</dd> +<dt><a href="./javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter"><span class="strong">FilterChain</span></a> - Interface in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">A <code>FilterChain</code> is an object provided by the portlet container + to the developer giving a view into the invocation chain of a + filtered request for a portlet.</div> +</dd> +<dt><a href="./javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter"><span class="strong">FilterConfig</span></a> - Interface in <a href="./javax/portlet/filter/package-summary.html">javax.portlet.filter</a></dt> +<dd> +<div class="block">A filter configuration object used by a portlet container + to pass information to a filter during initialization.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletURLGenerationListener.html#filterRenderURL(javax.portlet.PortletURL)">filterRenderURL(PortletURL)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletURLGenerationListener.html" title="interface in javax.portlet">PortletURLGenerationListener</a></dt> +<dd> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on render URLs.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletURLGenerationListener.html#filterResourceURL(javax.portlet.ResourceURL)">filterResourceURL(ResourceURL)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletURLGenerationListener.html" title="interface in javax.portlet">PortletURLGenerationListener</a></dt> +<dd> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on resource URLs.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#flushBuffer()">flushBuffer()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>flushBuffer()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#flushBuffer()">flushBuffer()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>flushBuffer()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#flushBuffer()">flushBuffer()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Forces any content in the buffer to be written to the underlying output stream.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#FORM_AUTH">FORM_AUTH</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">String identifier for Form based authentication.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequestDispatcher.html#forward(javax.portlet.PortletRequest,%20javax.portlet.PortletResponse)">forward(PortletRequest, PortletResponse)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet">PortletRequestDispatcher</a></dt> +<dd> +<div class="block">Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) + on the server.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceURL.html#FULL">FULL</a></span> - Static variable in interface javax.portlet.<a href="./javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a></dt> +<dd> +<div class="block">The URL of type <code>FULL</code> does not need to contain the current + state of the page or the current render parameters, portlet mode, or + window state of the portlet.</div> +</dd> +</dl> +<a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet"><span class="strong">GenericPortlet</span></a> - Class in <a href="./javax/portlet/package-summary.html">javax.portlet</a></dt> +<dd> +<div class="block">The <CODE>GenericPortlet</CODE> class provides a default implementation for + the <CODE>Portlet</CODE> interface.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#GenericPortlet()">GenericPortlet()</a></span> - Constructor for class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Does nothing.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getAttribute(java.lang.String)">getAttribute(String)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getAttribute(String name)</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getAttribute(java.lang.String)">getAttribute(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns the portlet container attribute with the given name, + or null if there is no attribute by that name.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getAttribute(java.lang.String)">getAttribute(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns the value of the named attribute as an <code>Object</code>, + or <code>null</code> if no attribute of the given name exists.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getAttribute(java.lang.String)">getAttribute(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns the object bound with the specified name in this session + under the <code>PORTLET_SCOPE</code>, or <code>null</code> if no + object is bound under the name in that scope.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getAttribute(java.lang.String,%20int)">getAttribute(String, int)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns the object bound with the specified name in this session, + or <code>null</code> if no object is bound under the name in the given scope.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getAttributeMap()">getAttributeMap()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns a <code>Map</code> of the session attributes in + the portlet session scope.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getAttributeMap(int)">getAttributeMap(int)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns a <code>Map</code> of the session attributes in + the given session scope.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getAttributeNames()">getAttributeNames()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getAttributeNames()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getAttributeNames()">getAttributeNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns an <code>Enumeration</code> containing the attribute names + available within this portlet context, or an empty + <code>Enumeration</code> if no attributes are available.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getAttributeNames()">getAttributeNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns an <code>Enumeration</code> containing the + names of the attributes available to this request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getAttributeNames()">getAttributeNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns an <code>Enumeration</code> of String objects containing the names of + all the objects bound to this session under the <code>PORTLET_SCOPE</code>, or an + empty <code>Enumeration</code> if no attributes are available.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getAttributeNames(int)">getAttributeNames(int)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns an <code>Enumeration</code> of String objects containing the names of + all the objects bound to this session in the given scope, or an + empty <code>Enumeration</code> if no attributes are available in the + given scope.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getAuthType()">getAuthType()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getAuthType()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getAuthType()">getAuthType()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns the name of the authentication scheme used for the + connection between client and portal, + for example, <code>BASIC_AUTH</code>, <code>CLIENT_CERT_AUTH</code>, + a custom one or <code>null</code> if there was no authentication.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#getBufferSize()">getBufferSize()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getBufferSize()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#getBufferSize()">getBufferSize()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getBufferSize()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#getBufferSize()">getBufferSize()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Returns the actual buffer size used for the response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceRequestWrapper.html#getCacheability()">getCacheability()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCacheability()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceRequest.html#getCacheability()">getCacheability()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a></dt> +<dd> +<div class="block">Returns the cache level of this resource request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceURL.html#getCacheability()">getCacheability()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a></dt> +<dd> +<div class="block">Returns the cache level of this resource URL.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#getCacheControl()">getCacheControl()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCacheControl()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#getCacheControl()">getCacheControl()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCacheControl()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#getCacheControl()">getCacheControl()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Returns the cache control object allowing to set + specific cache settings valid for the markup + returned in this response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ClientDataRequest.html#getCharacterEncoding()">getCharacterEncoding()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></dt> +<dd> +<div class="block">Returns the name of the character encoding used in the body of this request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionRequestWrapper.html#getCharacterEncoding()">getCharacterEncoding()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCharacterEncoding()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#getCharacterEncoding()">getCharacterEncoding()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCharacterEncoding()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceRequestWrapper.html#getCharacterEncoding()">getCharacterEncoding()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCharacterEncoding()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#getCharacterEncoding()">getCharacterEncoding()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCharacterEncoding()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#getCharacterEncoding()">getCharacterEncoding()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Returns the name of the charset used for the MIME body sent in this + response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getContainerRuntimeOptions()">getContainerRuntimeOptions()</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/portlet/PortletConfig.html#getContainerRuntimeOptions()">getContainerRuntimeOptions()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></dt> +<dd> +<div class="block">Returns the container runtime options + and values for this portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getContainerRuntimeOptions()">getContainerRuntimeOptions()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns the container container runtime options + keys supported by this portlet container.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ClientDataRequest.html#getContentLength()">getContentLength()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></dt> +<dd> +<div class="block">Returns the length, in bytes, of the request body + which is made available by the input stream, or -1 if the + length is not known.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionRequestWrapper.html#getContentLength()">getContentLength()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContentLength()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceRequestWrapper.html#getContentLength()">getContentLength()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContentLength()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ClientDataRequest.html#getContentType()">getContentType()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></dt> +<dd> +<div class="block">Returns the MIME type of the body of the request, + or null if the type is not known.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionRequestWrapper.html#getContentType()">getContentType()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContentType()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#getContentType()">getContentType()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContentType()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceRequestWrapper.html#getContentType()">getContentType()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContentType()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#getContentType()">getContentType()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContentType()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#getContentType()">getContentType()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Returns the MIME type that can be used to contribute markup to the render + response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getContextPath()">getContextPath()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getContextPath()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getContextPath()">getContextPath()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns the context path which is the path prefix associated with the deployed + portlet application.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getCookies()">getCookies()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getCookies()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getCookies()">getCookies()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns an array containing all of the Cookie properties.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getCreationTime()">getCreationTime()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns the time when this session was created, measured in + milliseconds since midnight January 1, 1970 GMT.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getDefaultNamespace()">getDefaultNamespace()</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Returns the default namespace for events and public parameters.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletConfig.html#getDefaultNamespace()">getDefaultNamespace()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></dt> +<dd> +<div class="block">Returns the default namespace for events and public render parameters.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/CacheControl.html#getETag()">getETag()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/CacheControl.html" title="interface in javax.portlet">CacheControl</a></dt> +<dd> +<div class="block">Returns the ETag for the current response that is + used as validation tag, or <code>null</null> + if no ETag is set on the response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderRequestWrapper.html#getETag()">getETag()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderRequestWrapper.html" title="class in javax.portlet.filter">RenderRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getETag()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceRequestWrapper.html#getETag()">getETag()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getETag()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/RenderRequest.html#getETag()">getETag()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></dt> +<dd> +<div class="block">Returns the validation tag if the portlet container + has a cached response for this validation tag, or + <code>null</code> if no cached response exists.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ResourceRequest.html#getETag()">getETag()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a></dt> +<dd> +<div class="block">Returns the validation tag if the portlet container + has a cached response for this validation tag, or + <code>null</code> if no cached response exists.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/EventRequest.html#getEvent()">getEvent()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a></dt> +<dd> +<div class="block">Returns the event that triggered the call to the processEvent method.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/EventRequestWrapper.html#getEvent()">getEvent()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/EventRequestWrapper.html" title="class in javax.portlet.filter">EventRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getEvent()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/CacheControl.html#getExpirationTime()">getExpirationTime()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/CacheControl.html" title="interface in javax.portlet">CacheControl</a></dt> +<dd> +<div class="block">Get the currently set expiration time.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ValidatorException.html#getFailedKeys()">getFailedKeys()</a></span> - Method in exception javax.portlet.<a href="./javax/portlet/ValidatorException.html" title="class in javax.portlet">ValidatorException</a></dt> +<dd> +<div class="block">Returns the keys that failed the validation.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterConfig.html#getFilterName()">getFilterName()</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter">FilterConfig</a></dt> +<dd> +<div class="block">Returns the filter-name of this filter as defined in the + portlet deployment descriptor.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getId()">getId()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns a string containing the unique identifier assigned to this session.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterConfig.html#getInitParameter(java.lang.String)">getInitParameter(String)</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter">FilterConfig</a></dt> +<dd> +<div class="block">Returns a String containing the value of the named + initialization parameter, or <code>null</code> if the parameter does not exist.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getInitParameter(java.lang.String)">getInitParameter(String)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Returns a String containing the value of the named initialization * parameter, or null if the parameter does not exist.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></dt> +<dd> +<div class="block">Returns a String containing the value of the named initialization parameter, + or null if the parameter does not exist.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getInitParameter(java.lang.String)">getInitParameter(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns a String containing the value of the named context-wide + initialization parameter, or <code>null</code> if the parameter does not exist.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterConfig.html#getInitParameterNames()">getInitParameterNames()</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter">FilterConfig</a></dt> +<dd> +<div class="block">Returns the names of the filter's initialization parameters + as an Enumeration of String objects, or an empty Enumeration + if the filter has no initialization parameters.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getInitParameterNames()">getInitParameterNames()</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></dt> +<dd> +<div class="block">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.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getInitParameterNames()">getInitParameterNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">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.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getLastAccessedTime()">getLastAccessedTime()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns the last time the client sent a request associated with this session, + as the number of milliseconds since midnight January 1, 1970 GMT.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getLocale()">getLocale()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/RenderResponseWrapper.html#getLocale()">getLocale()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceResponseWrapper.html#getLocale()">getLocale()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/MimeResponse.html#getLocale()">getLocale()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></dt> +<dd> +<div class="block">Returns the locale assigned to the response.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getLocale()">getLocale()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns the preferred Locale in which the portal will accept content.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getLocales()">getLocales()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getLocales()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getLocales()">getLocales()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns an Enumeration of Locale objects indicating, in decreasing + order starting with the preferred locale in which the portal will + accept content for this request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getMajorVersion()">getMajorVersion()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns the major version of the Portlet API that this portlet + container supports.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletPreferences.html#getMap()">getMap()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletPreferences.html" title="interface in javax.portlet">PortletPreferences</a></dt> +<dd> +<div class="block">Returns a <code>Map</code> of the preferences.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getMaxInactiveInterval()">getMaxInactiveInterval()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns the maximum time interval, in seconds, for which the portlet container + keeps this session open between client accesses.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/ClientDataRequest.html#getMethod()">getMethod()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></dt> +<dd> +<div class="block">Returns the name of the HTTP method with which this request was made, + for example, GET, POST, or PUT.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/EventRequest.html#getMethod()">getMethod()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a></dt> +<dd> +<div class="block">Returns the name of the HTTP method with which the original action request was made, + for example, POST, or PUT.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ActionRequestWrapper.html#getMethod()">getMethod()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getMethod()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/EventRequestWrapper.html#getMethod()">getMethod()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/EventRequestWrapper.html" title="class in javax.portlet.filter">EventRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getMethod()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/ResourceRequestWrapper.html#getMethod()">getMethod()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getMethod()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getMimeType(java.lang.String)">getMimeType(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns the MIME type of the specified file, or <code>null</code> if + the MIME type is not known.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getMinorVersion()">getMinorVersion()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns the minor version of the Portlet API that this portlet + container supports.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletModeException.html#getMode()">getMode()</a></span> - Method in exception javax.portlet.<a href="./javax/portlet/PortletModeException.html" title="class in javax.portlet">PortletModeException</a></dt> +<dd> +<div class="block">Returns the unsupported portlet mode causing this exception.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/Event.html#getName()">getName()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/Event.html" title="interface in javax.portlet">Event</a></dt> +<dd> +<div class="block">Get the local part of the event name.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getNamedDispatcher(java.lang.String)">getNamedDispatcher(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd> +<div class="block">Returns a <a href="./javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a> object that acts + as a wrapper for the named servlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletPreferences.html#getNames()">getNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletPreferences.html" title="interface in javax.portlet">PortletPreferences</a></dt> +<dd> +<div class="block">Returns all of the keys that have an associated value, + or an empty <code>Enumeration</code> if no keys are + available.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletResponseWrapper.html#getNamespace()">getNamespace()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getNamespace()</code> on the wrapped response object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletResponse.html#getNamespace()">getNamespace()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dt> +<dd> +<div class="block">The value returned by this method should be prefixed or appended to + elements, such as JavaScript variables or function names, to ensure they + are unique in the context of the portal page.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getNextPossiblePortletModes(javax.portlet.RenderRequest)">getNextPossiblePortletModes(RenderRequest)</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Used by the render method to set the next possible portlet modes.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getParameter(java.lang.String)">getParameter(String)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getParameter(String name)</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getParameter(java.lang.String)">getParameter(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns the value of a request parameter as a <code>String</code>, + or <code>null</code> if the parameter does not exist.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/BaseURL.html#getParameterMap()">getParameterMap()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></dt> +<dd> +<div class="block">Returns a <code>Map</code> of the parameters + currently set on this portlet URL via the + <code>setParameter</code> or <code>setParameters</code> + methods.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getParameterMap()">getParameterMap()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getParameterMap()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getParameterMap()">getParameterMap()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns a <code>Map</code> of the parameters of this request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getParameterNames()">getParameterNames()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getParameterNames()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getParameterNames()">getParameterNames()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns an <code>Enumeration</code> of <code>String</code> + objects containing the names of the parameters contained + in this request.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getParameterValues(java.lang.String)">getParameterValues(String)</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getParameterValues(name)</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getParameterValues(java.lang.String)">getParameterValues(String)</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns an array of <code>String</code> objects containing + all of the values the given request parameter has, or + <code>null</code> if the parameter does not exist.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/PortletRequestWrapper.html#getPortalContext()">getPortalContext()</a></span> - Method in class javax.portlet.filter.<a href="./javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></dt> +<dd> +<div class="block">The default behavior of this method is to call + <code>getPortalContext()</code> on the wrapped request object.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletRequest.html#getPortalContext()">getPortalContext()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dt> +<dd> +<div class="block">Returns the context of the calling portal.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortalContext.html#getPortalInfo()">getPortalInfo()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortalContext.html" title="interface in javax.portlet">PortalContext</a></dt> +<dd> +<div class="block">Returns information about the portal like vendor, version, etc.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getPortletConfig()">getPortletConfig()</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Returns the PortletConfig object of this portlet.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/filter/FilterConfig.html#getPortletContext()">getPortletContext()</a></span> - Method in interface javax.portlet.filter.<a href="./javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter">FilterConfig</a></dt> +<dd> +<div class="block">Returns a reference to the <code>PortletContext</code> in which the caller is executing.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/GenericPortlet.html#getPortletContext()">getPortletContext()</a></span> - Method in class javax.portlet.<a href="./javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dt> +<dd> +<div class="block">Returns the <code>PortletContext</code> of the portlet application the + portlet is in.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a></dt> +<dd> +<div class="block">Returns the <code>PortletContext</code> of the portlet application + the portlet is in.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletSession.html#getPortletContext()">getPortletContext()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></dt> +<dd> +<div class="block">Returns the portlet application context associated with this session.</div> +</dd> +<dt><span class="strong"><a href="./javax/portlet/PortletContext.html#getPortletContextName()">getPortletContextName()</a></span> - Method in interface javax.portlet.<a href="./javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></dt> +<dd>
[... 1850 lines stripped ...]
