Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderResponseWrapper.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderResponseWrapper.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderResponseWrapper.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderResponseWrapper.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,781 @@ +<!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>RenderResponseWrapper (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="RenderResponseWrapper (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/RenderResponseWrapper.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/RenderRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/ResourceFilter.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/RenderResponseWrapper.html" target="_top">Frames</a></li> +<li><a href="RenderResponseWrapper.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet.filter</div> +<h2 title="Class RenderResponseWrapper" class="title">Class RenderResponseWrapper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">javax.portlet.filter.PortletResponseWrapper</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.filter.RenderResponseWrapper</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a>, <a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a>, <a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RenderResponseWrapper</span> +extends <a href="../../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a> +implements <a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a></pre> +<div class="block">The <code>RenderResponseWrapper</code> provides a convenient + implementation of the <code>RenderResponse</code> interface + that can be subclassed by developers wishing to adapt the response. + This class implements the Wrapper or Decorator pattern. + Methods default to calling through to the wrapped response object.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet"><code>RenderResponse</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_javax.portlet.MimeResponse"> +<!-- --> +</a> +<h3>Fields inherited from interface javax.portlet.<a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></h3> +<code><a href="../../../javax/portlet/MimeResponse.html#CACHE_SCOPE">CACHE_SCOPE</a>, <a href="../../../javax/portlet/MimeResponse.html#ETAG">ETAG</a>, <a href="../../../javax/portlet/MimeResponse.html#EXPIRATION_CACHE">EXPIRATION_CACHE</a>, <a href="../../../javax/portlet/MimeResponse.html#MARKUP_HEAD_ELEMENT">MARKUP_HEAD_ELEMENT</a>, <a href="../../../javax/portlet/MimeResponse.html#NAMESPACED_RESPONSE">NAMESPACED_RESPONSE</a>, <a href="../../../javax/portlet/MimeResponse.html#PRIVATE_SCOPE">PRIVATE_SCOPE</a>, <a href="../../../javax/portlet/MimeResponse.html#PUBLIC_SCOPE">PUBLIC_SCOPE</a>, <a href="../../../javax/portlet/MimeResponse.html#USE_CACHED_CONTENT">USE_CACHED_CONTENT</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#RenderResponseWrapper(javax.portlet.RenderResponse)">RenderResponseWrapper</a></strong>(<a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Creates an <code>RenderResponse</code> adaptor + wrapping the given response object.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#createActionURL()">createActionURL</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>createActionURL()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#createRenderURL()">createRenderURL</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>createRenderURL()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#createResourceURL()">createResourceURL</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>createResourceURL()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#flushBuffer()">flushBuffer</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>flushBuffer()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getBufferSize()">getBufferSize</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getBufferSize()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/CacheControl.html" title="interface in javax.portlet">CacheControl</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getCacheControl()">getCacheControl</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getCacheControl()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getCharacterEncoding()">getCharacterEncoding</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getCharacterEncoding()</code> on the wrapped response object.</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/RenderResponseWrapper.html#getContentType()">getContentType</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getContentType()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getLocale()">getLocale</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getPortletOutputStream()">getPortletOutputStream</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPortletOutputStream()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getResponse()">getResponse</a></strong>()</code> +<div class="block">Return the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#getWriter()">getWriter</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getWriter()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#isCommitted()">isCommitted</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>isCommitted()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#reset()">reset</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>reset()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#resetBuffer()">resetBuffer</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>resetBuffer()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#setBufferSize(int)">setBufferSize</a></strong>(int size)</code> +<div class="block">The default behavior of this method is to call + <code>setBufferSize(size)</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#setContentType(java.lang.String)">setContentType</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> type)</code> +<div class="block">The default behavior of this method is to call + <code>setContentType(type)</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#setNextPossiblePortletModes(java.util.Collection)">setNextPossiblePortletModes</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a>> portletModes)</code> +<div class="block">The default behavior of this method is to call + <code>setNextPossiblePortletModes()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#setResponse(javax.portlet.RenderResponse)">setResponse</a></strong>(<a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Sets the response object being wrapped.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderResponseWrapper.html#setTitle(java.lang.String)">setTitle</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> title)</code> +<div class="block">The default behavior of this method is to call + <code>setTitle(title)</code> on the wrapped response object.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.filter.PortletResponseWrapper"> +<!-- --> +</a> +<h3>Methods inherited from class javax.portlet.filter.<a href="../../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></h3> +<code><a href="../../../javax/portlet/filter/PortletResponseWrapper.html#addProperty(javax.servlet.http.Cookie)">addProperty</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#createElement(java.lang.String)">createElement</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#encodeURL(java.lang.String)">encodeURL</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#getNamespace()">getNamespace</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a>, <a href="../../../javax/portlet/filter/PortletResponseWrapper.html#setResponse(javax.portlet.PortletResponse)">setResponse</a></ code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.PortletResponse"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></h3> +<code><a href="../../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty</a>, <a href="../../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</a>, <a href="../../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</a>, <a href="../../../javax/portlet/PortletResponse.html#createElement(java.lang.String)">createElement</a>, <a href="../../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)">encodeURL</a>, <a href="../../../javax/portlet/PortletResponse.html#getNamespace()">getNamespace</a>, <a href="../../../javax/portlet/PortletResponse.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RenderResponseWrapper(javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RenderResponseWrapper</h4> +<pre>public RenderResponseWrapper(<a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</pre> +<div class="block">Creates an <code>RenderResponse</code> adaptor + wrapping the given response object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>response</code> - the event response to wrap</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the response is <code>null</code></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="flushBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flushBuffer</h4> +<pre>public void flushBuffer() + 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></pre> +<div class="block">The default behavior of this method is to call + <code>flushBuffer()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#flushBuffer()">flushBuffer</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></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 error occurred when writing the output</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>MimeResponse.setBufferSize(int)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getBufferSize()"><code>MimeResponse.getBufferSize()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#isCommitted()"><code>MimeResponse.isCommitted()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#reset()"><code>MimeResponse.reset()</code></a></dd></dl> +</li> +</ul> +<a name="getBufferSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBufferSize</h4> +<pre>public int getBufferSize()</pre> +<div class="block">The default behavior of this method is to call + <code>getBufferSize()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getBufferSize()">getBufferSize</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the actual buffer size used</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>MimeResponse.setBufferSize(int)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#flushBuffer()"><code>MimeResponse.flushBuffer()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#isCommitted()"><code>MimeResponse.isCommitted()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#reset()"><code>MimeResponse.reset()</code></a></dd></dl> +</li> +</ul> +<a name="getCharacterEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCharacterEncoding</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getCharacterEncoding()</pre> +<div class="block">The default behavior of this method is to call + <code>getCharacterEncoding()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getCharacterEncoding()">getCharacterEncoding</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the name of the charset, for + example, <code>ISO-8859-1</code></dd></dl> +</li> +</ul> +<a name="getContentType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContentType</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getContentType()</pre> +<div class="block">The default behavior of this method is to call + <code>getContentType()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getContentType()">getContentType</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the MIME type of the response, or <code>null</code> if no + content type is set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>MimeResponse.setContentType(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getLocale()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocale</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> getLocale()</pre> +<div class="block">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getLocale()">getLocale</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Locale of this response</dd></dl> +</li> +</ul> +<a name="getPortletOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletOutputStream</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> getPortletOutputStream() + 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></pre> +<div class="block">The default behavior of this method is to call + <code>getPortletOutputStream()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getPortletOutputStream()">getPortletOutputStream</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>OutputStream</code> for writing binary data</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 input or output exception occurred</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>MimeResponse.setContentType(java.lang.String)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getWriter()"><code>MimeResponse.getWriter()</code></a></dd></dl> +</li> +</ul> +<a name="getWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriter</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> getWriter() + 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></pre> +<div class="block">The default behavior of this method is to call + <code>getWriter()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getWriter()">getWriter</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>PrintWriter</code> object that can return character + data to the portal</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 input or output exception occurred</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>MimeResponse.setContentType(java.lang.String)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getPortletOutputStream()"><code>MimeResponse.getPortletOutputStream()</code></a></dd></dl> +</li> +</ul> +<a name="isCommitted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCommitted</h4> +<pre>public boolean isCommitted()</pre> +<div class="block">The default behavior of this method is to call + <code>isCommitted()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#isCommitted()">isCommitted</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a boolean indicating if the response has been committed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>MimeResponse.setBufferSize(int)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getBufferSize()"><code>MimeResponse.getBufferSize()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#flushBuffer()"><code>MimeResponse.flushBuffer()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#reset()"><code>MimeResponse.reset()</code></a></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public void reset()</pre> +<div class="block">The default behavior of this method is to call + <code>reset()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#reset()">reset</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>MimeResponse.setBufferSize(int)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getBufferSize()"><code>MimeResponse.getBufferSize()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#flushBuffer()"><code>MimeResponse.flushBuffer()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#isCommitted()"><code>MimeResponse.isCommitted()</code></a></dd></dl> +</li> +</ul> +<a name="resetBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetBuffer</h4> +<pre>public void resetBuffer()</pre> +<div class="block">The default behavior of this method is to call + <code>resetBuffer()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#resetBuffer()">resetBuffer</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>MimeResponse.setBufferSize(int)</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getBufferSize()"><code>MimeResponse.getBufferSize()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#isCommitted()"><code>MimeResponse.isCommitted()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#reset()"><code>MimeResponse.reset()</code></a></dd></dl> +</li> +</ul> +<a name="setBufferSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBufferSize</h4> +<pre>public void setBufferSize(int size)</pre> +<div class="block">The default behavior of this method is to call + <code>setBufferSize(size)</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#setBufferSize(int)">setBufferSize</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - the preferred buffer size</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/MimeResponse.html#getBufferSize()"><code>MimeResponse.getBufferSize()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#flushBuffer()"><code>MimeResponse.flushBuffer()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#isCommitted()"><code>MimeResponse.isCommitted()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#reset()"><code>MimeResponse.reset()</code></a></dd></dl> +</li> +</ul> +<a name="setContentType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContentType</h4> +<pre>public void setContentType(<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> type)</pre> +<div class="block">The default behavior of this method is to call + <code>setContentType(type)</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)">setContentType</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/RenderResponse.html#setContentType(java.lang.String)">setContentType</a></code> in interface <code><a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the content MIME type</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/PortletRequest.html#getResponseContentTypes()"><code>PortletRequest.getResponseContentTypes()</code></a>, +<a href="../../../javax/portlet/MimeResponse.html#getContentType()"><code>MimeResponse.getContentType()</code></a></dd></dl> +</li> +</ul> +<a name="setTitle(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTitle</h4> +<pre>public void setTitle(<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> title)</pre> +<div class="block">The default behavior of this method is to call + <code>setTitle(title)</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/RenderResponse.html#setTitle(java.lang.String)">setTitle</a></code> in interface <code><a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - portlet title as text String or resource URI</dd></dl> +</li> +</ul> +<a name="getCacheControl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheControl</h4> +<pre>public <a href="../../../javax/portlet/CacheControl.html" title="interface in javax.portlet">CacheControl</a> getCacheControl()</pre> +<div class="block">The default behavior of this method is to call + <code>getCacheControl()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#getCacheControl()">getCacheControl</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Cache control for the current response.</dd></dl> +</li> +</ul> +<a name="setNextPossiblePortletModes(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNextPossiblePortletModes</h4> +<pre>public void setNextPossiblePortletModes(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a>> portletModes)</pre> +<div class="block">The default behavior of this method is to call + <code>setNextPossiblePortletModes()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/RenderResponse.html#setNextPossiblePortletModes(java.util.Collection)">setNextPossiblePortletModes</a></code> in interface <code><a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>portletModes</code> - <code>Enumeration</code> of <code>PortletMode</code> objects with the + next possible portlet modes that the make sense from the + portlet point of view, must not be <code>null</code> or an + empty enumeration.</dd></dl> +</li> +</ul> +<a name="getResponse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponse</h4> +<pre>public <a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> getResponse()</pre> +<div class="block">Return the wrapped response object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../javax/portlet/filter/PortletResponseWrapper.html#getResponse()">getResponse</a></code> in class <code><a href="../../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the wrapped response</dd></dl> +</li> +</ul> +<a name="setResponse(javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setResponse</h4> +<pre>public void setResponse(<a href="../../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</pre> +<div class="block">Sets the response object being wrapped.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>response</code> - the response to set</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the response is null.</dd></dl> +</li> +</ul> +<a name="createActionURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createActionURL</h4> +<pre>public <a href="../../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> createActionURL() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></pre> +<div class="block">The default behavior of this method is to call + <code>createActionURL()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#createActionURL()">createActionURL</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a portlet action URL</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code></dd></dl> +</li> +</ul> +<a name="createRenderURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRenderURL</h4> +<pre>public <a href="../../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> createRenderURL() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></pre> +<div class="block">The default behavior of this method is to call + <code>createRenderURL()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#createRenderURL()">createRenderURL</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a portlet render URL</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code></dd></dl> +</li> +</ul> +<a name="createResourceURL()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createResourceURL</h4> +<pre>public <a href="../../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a> createResourceURL() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></pre> +<div class="block">The default behavior of this method is to call + <code>createResourceURL()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/MimeResponse.html#createResourceURL()">createResourceURL</a></code> in interface <code><a href="../../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a portlet resource URL</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code></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/RenderResponseWrapper.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/RenderRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/ResourceFilter.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/RenderResponseWrapper.html" target="_top">Frames</a></li> +<li><a href="RenderResponseWrapper.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ResourceFilter.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ResourceFilter.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ResourceFilter.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ResourceFilter.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,297 @@ +<!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>ResourceFilter (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="ResourceFilter (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/ResourceFilter.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/RenderResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/ResourceRequestWrapper.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/ResourceFilter.html" target="_top">Frames</a></li> +<li><a href="ResourceFilter.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 ResourceFilter" class="title">Interface ResourceFilter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceFilter</span> +extends <a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></pre> +<div class="block">The <code>ResourceFilter</code> is an object that performs filtering + tasks on either the resource request to a portlet, or on the resource response from + a portlet, or both. + <p> + Filters perform filtering in the <code>doFilter</code> method. Every Filter has + access to a <code>FilterConfig</code> object from which it can obtain + its initialization parameters, a reference to the PortletContext + which it can use, for example, to load resources needed for filtering tasks. + <p> + Filters are configured in the portlet deployment descriptor of a + portlet application.</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/ResourceFilter.html#doFilter(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse,%20javax.portlet.filter.FilterChain)">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, + <a href="../../../javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a> chain)</code> +<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> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.filter.PortletFilter"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.filter.<a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></h3> +<code><a href="../../../javax/portlet/filter/PortletFilter.html#destroy()">destroy</a>, <a href="../../../javax/portlet/filter/PortletFilter.html#init(javax.portlet.filter.FilterConfig)">init</a></code></li> +</ul> +</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.ResourceRequest, javax.portlet.ResourceResponse, javax.portlet.filter.FilterChain)"> +<!-- --> +</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, + <a href="../../../javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a> chain) + 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">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. + <p> + The <code>FilterChain</code> passed in to this method allows + the Filter to pass on the resource request and response to the next + component in the chain. + <p> + The <code>doFilter</code> method of a filter will typically be implemented + following this or some subset of the following pattern: + <ul> + <li>The method examines the request information.</li> + <li>The method may wrap the request object passed in to + its doFilter method with a customized implementation + the request wrapper <code>ResourceRequestWrapper</code> + in order to modify request data.</li> + <li>The method may wrap the response object passed in to its + <code>doFilter</code> method with a customized implementation + of the response wrapper <code>ResourceResponseWrapper</code> + to modify response data.</li> + <li>The filter may invoke the next component in the filter chain. + The next component may be another filter, or if the filter + making the invocation is the last filter configured in the + deployment descriptor for this chain, the next component + is the target method of the portlet. The invocation of the + next component is effected by calling the <code>doFilter</code> + method on the <code>FilterChain</code> object, and passing in + the request and response with which it was called or passing + in wrapped versions it may have created. + The filter chain's implementation of the <code>doFilter</code> + method, provided by the portlet container, must locate the + next component in the filter chain and invoke its <code>doFilter</code> + method, passing in the appropriate request and response objects. + Alternatively, the filter chain can block the request by not + making the call to invoke the next component, leaving the filter + responsible for filling out the response object.</li> + <li>After invocation of the next filter in the chain, the filter + may examine the response data.</li> + <li>Alternatively, the filter may have thrown an exception to + indicate an error in processing. If the filter throws an + <code>UnavailableException</code> during its <code>doFilter</code> + processing, the portlet container must not attempt continued + processing down the filter chain. It may choose to retry the + whole chain at a later time if the exception is not marked permanent.</li> + <li>When the last filter in the chain has been invoked, the next + component accessed is the target method on the portlet at + the end of the chain.</li> + </ul></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><dd><code>chain</code> - the remaining filter chain</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/ResourceFilter.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/RenderResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/ResourceRequestWrapper.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/ResourceFilter.html" target="_top">Frames</a></li> +<li><a href="ResourceFilter.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>
