Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterChain.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterChain.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterChain.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterChain.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,314 @@ +<!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>FilterChain (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="FilterChain (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/FilterChain.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/filter/EventResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/FilterChain.html" target="_top">Frames</a></li> +<li><a href="FilterChain.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.filter</div> +<h2 title="Interface FilterChain" class="title">Interface FilterChain</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">FilterChain</span></pre> +<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. Filters use the <code>FilterChain</code> + to invoke the next filter in the chain, or if the calling filter is the + last filter in the chain, to invoke the portlet at the end of the chain.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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/filter/FilterChain.html#doFilter(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse)">doFilter</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">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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.EventRequest,%20javax.portlet.EventResponse)">doFilter</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">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> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">doFilter</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">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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/FilterChain.html#doFilter(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse)">doFilter</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">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> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="doFilter(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doFilter</h4> +<pre>void doFilter(<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="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>, + <a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<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> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the current action request.</dd><dd><code>response</code> - the current action response</dd> +<dt><span class="strong">Throws:</span></dt> +<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 an IO error occurred in the filter processing</dd> +<dd><code><a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if a portlet exception occurred in the filter processing</dd></dl> +</li> +</ul> +<a name="doFilter(javax.portlet.EventRequest, javax.portlet.EventResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doFilter</h4> +<pre>void doFilter(<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="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>, + <a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<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> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the current event request.</dd><dd><code>response</code> - the current event response.</dd> +<dt><span class="strong">Throws:</span></dt> +<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 an IO error occured in the filter processing</dd> +<dd><code><a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if a portlet exception occured in the filter processing</dd></dl> +</li> +</ul> +<a name="doFilter(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doFilter</h4> +<pre>void doFilter(<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="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>, + <a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<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> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the current render request.</dd><dd><code>response</code> - the current render response.</dd> +<dt><span class="strong">Throws:</span></dt> +<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 an IO error occurred in the filter processing</dd> +<dd><code><a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if a portlet exception occurred in the filter processing</dd></dl> +</li> +</ul> +<a name="doFilter(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>doFilter</h4> +<pre>void doFilter(<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="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>, + <a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<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> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the current resource request.</dd><dd><code>response</code> - the current resource response.</dd> +<dt><span class="strong">Throws:</span></dt> +<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 an IO error occurred in the filter processing</dd> +<dd><code><a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if a portlet exception occurred in the filter processing</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/FilterChain.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/filter/EventResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/FilterChain.html" target="_top">Frames</a></li> +<li><a href="FilterChain.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterConfig.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterConfig.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterConfig.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/FilterConfig.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,281 @@ +<!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>FilterConfig (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="FilterConfig (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/FilterConfig.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/filter/FilterChain.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/FilterConfig.html" target="_top">Frames</a></li> +<li><a href="FilterConfig.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.filter</div> +<h2 title="Interface FilterConfig" class="title">Interface FilterConfig</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">FilterConfig</span></pre> +<div class="block">A filter configuration object used by a portlet container + to pass information to a filter during initialization.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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><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/filter/FilterConfig.html#getFilterName()">getFilterName</a></strong>()</code> +<div class="block">Returns the filter-name of this filter as defined in the + portlet deployment descriptor.</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/filter/FilterConfig.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 <code>null</code> if the parameter does not exist.</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/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/filter/FilterConfig.html#getInitParameterNames()">getInitParameterNames</a></strong>()</code> +<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> +</td> +</tr> +<tr class="rowColor"> +<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/filter/FilterConfig.html#getPortletContext()">getPortletContext</a></strong>()</code> +<div class="block">Returns a reference to the <code>PortletContext</code> in which the caller is executing.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getFilterName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterName</h4> +<pre><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> getFilterName()</pre> +<div class="block">Returns the filter-name of this filter as defined in the + portlet deployment descriptor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the filter name</dd></dl> +</li> +</ul> +<a name="getPortletContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletContext</h4> +<pre><a href="../../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a> getPortletContext()</pre> +<div class="block">Returns a reference to the <code>PortletContext</code> in which the caller is executing.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet context</dd></dl> +</li> +</ul> +<a name="getInitParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameter</h4> +<pre><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 <code>null</code> if the parameter does not exist. + <p> + Initialization parameters are defined in the portlet deployment descriptor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the initialization parameter to return</dd> +<dt><span class="strong">Returns:</span></dt><dd>initialization parameter, or <code>null</code> if the parameter does not exist.</dd></dl> +</li> +</ul> +<a name="getInitParameterNames()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInitParameterNames</h4> +<pre><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 filter's initialization parameters + as an Enumeration of String objects, or an empty Enumeration + if the filter has no initialization parameters. + <p> + Initialization parameters are defined in the portlet deployment descriptor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the filter's initialization parameters, + or an empty Enumeration if the filter has no initialization parameters.</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/FilterConfig.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/filter/FilterChain.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/FilterConfig.html" target="_top">Frames</a></li> +<li><a href="FilterConfig.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletFilter.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletFilter.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletFilter.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletFilter.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,264 @@ +<!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>PortletFilter (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="PortletFilter (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/PortletFilter.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/filter/FilterConfig.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/PortletFilter.html" target="_top">Frames</a></li> +<li><a href="PortletFilter.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.filter</div> +<h2 title="Interface PortletFilter" class="title">Interface PortletFilter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../javax/portlet/filter/ActionFilter.html" title="interface in javax.portlet.filter">ActionFilter</a>, <a href="../../../javax/portlet/filter/EventFilter.html" title="interface in javax.portlet.filter">EventFilter</a>, <a href="../../../javax/portlet/filter/RenderFilter.html" title="interface in javax.portlet.filter">RenderFilter</a>, <a href="../../../javax/portlet/filter/ResourceFilter.html" title="interface in javax.portlet.filter">ResourceFilter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">PortletFilter</span></pre> +<div class="block">The <code>PortletFilter</code> is the base interface for all portlet filters. + It provides the lifecycle methods <code>init</code> and <code>destroy</code> + for putting a portlet filter into and out of service.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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/filter/PortletFilter.html#destroy()">destroy</a></strong>()</code> +<div class="block">Called by the portlet container to indicate to a filter that it is + being taken out of service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletFilter.html#init(javax.portlet.filter.FilterConfig)">init</a></strong>(<a href="../../../javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter">FilterConfig</a> filterConfig)</code> +<div class="block">Called by the portlet container to indicate to a filter + that it is being placed into service.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(javax.portlet.filter.FilterConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../../javax/portlet/filter/FilterConfig.html" title="interface in javax.portlet.filter">FilterConfig</a> filterConfig) + 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 filter + that it is being placed into service. The portlet container + calls the init method exactly once after instantiating the filter. + The init method must complete successfully before the filter + is asked to do any filtering work. + <p> + The portlet container cannot place the filter into service if the init method either + <ul> + <li>throws a PortletException</li> + <li>does not return within a time period defined by the portlet container</li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filterConfig</code> - the filter configuration data defined + in the portlet deployment descriptor</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 error occurs in the filter initialization</dd></dl> +</li> +</ul> +<a name="destroy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>destroy</h4> +<pre>void destroy()</pre> +<div class="block">Called by the portlet container to indicate to a filter that it is + being taken out of service. This method is only called once all threads + within the filter's <code>doFilter</code> method have exited or + after a timeout period has passed. + <p> + After the portlet container calls this method, it will not call the + <code>doFilter</code> method again on this instance of the filter. + <p> + This method gives the filter an opportunity to clean up any resources + that are being held (for example, memory, file handles, threads) and + make sure that any persistent state is synchronized with the + filter's current state in memory.</div> +</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/PortletFilter.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/filter/FilterConfig.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/PortletFilter.html" target="_top">Frames</a></li> +<li><a href="PortletFilter.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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>
