Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletResponseWrapper.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletResponseWrapper.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletResponseWrapper.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletResponseWrapper.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,473 @@ +<!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>PortletResponseWrapper (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="PortletResponseWrapper (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/PortletResponseWrapper.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/PortletRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/RenderFilter.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/PortletResponseWrapper.html" target="_top">Frames</a></li> +<li><a href="PortletResponseWrapper.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 PortletResponseWrapper" class="title">Class PortletResponseWrapper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.filter.PortletResponseWrapper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter">ActionResponseWrapper</a>, <a href="../../../javax/portlet/filter/EventResponseWrapper.html" title="class in javax.portlet.filter">EventResponseWrapper</a>, <a href="../../../javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a>, <a href="../../../javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PortletResponseWrapper</span> +extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></pre> +<div class="block">The <code>PortletResponseWrapper</code> provides a convenient + implementation of the <code>PortletResponse</code> interface + and is extended by other response wrappers. + 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/PortletResponse.html" title="interface in javax.portlet"><code>PortletResponse</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PortletResponseWrapper.html#PortletResponseWrapper(javax.portlet.PortletResponse)">PortletResponseWrapper</a></strong>(<a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response)</code> +<div class="block">Creates an <code>ActionResponse</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletResponseWrapper.html#addProperty(javax.servlet.http.Cookie)">addProperty</a></strong>(javax.servlet.http.Cookie cookie)</code> +<div class="block">The default behavior of this method is to call + <code>addProperty()</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/PortletResponseWrapper.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</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> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a> element)</code> +<div class="block">The default behavior of this method is to call + <code>addProperty()</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/PortletResponseWrapper.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</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> key, + <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> value)</code> +<div class="block">The default behavior of this method is to call + <code>addProperty(key, value)</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/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletResponseWrapper.html#createElement(java.lang.String)">createElement</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> tagName)</code> +<div class="block">The default behavior of this method is to call + <code>createElement()</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/PortletResponseWrapper.html#encodeURL(java.lang.String)">encodeURL</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> path)</code> +<div class="block">The default behavior of this method is to call + <code>encodeURL(path)</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/PortletResponseWrapper.html#getNamespace()">getNamespace</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getNamespace()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletResponseWrapper.html#getResponse()">getResponse</a></strong>()</code> +<div class="block">Return 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/PortletResponseWrapper.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</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> key, + <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> value)</code> +<div class="block">The default behavior of this method is to call + <code>setProperty(key, value)</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/PortletResponseWrapper.html#setResponse(javax.portlet.PortletResponse)">setResponse</a></strong>(<a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response)</code> +<div class="block">Sets the response object being wrapped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PortletResponseWrapper(javax.portlet.PortletResponse)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PortletResponseWrapper</h4> +<pre>public PortletResponseWrapper(<a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response)</pre> +<div class="block">Creates an <code>ActionResponse</code> adaptor + wrapping the given response object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>response</code> - the action 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="addProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public void addProperty(<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> key, + <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> value)</pre> +<div class="block">The default behavior of this method is to call + <code>addProperty(key, value)</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property to be returned to the portal</dd><dd><code>value</code> - the value of the property to be returned to the portal</dd></dl> +</li> +</ul> +<a name="encodeURL(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeURL</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> encodeURL(<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> path)</pre> +<div class="block">The default behavior of this method is to call + <code>encodeURL(path)</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)">encodeURL</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the URI path to the resource. This must be either an absolute + URL (e.g. + <code>http://my.co/myportal/mywebap/myfolder/myresource.gif</code>) + or a full path URI (e.g. + <code>/myportal/mywebap/myfolder/myresource.gif</code>).</dd> +<dt><span class="strong">Returns:</span></dt><dd>the encoded resource URL as string, may not be a valid URL</dd></dl> +</li> +</ul> +<a name="getNamespace()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamespace</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> getNamespace()</pre> +<div class="block">The default behavior of this method is to call + <code>getNamespace()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#getNamespace()">getNamespace</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the namespace</dd></dl> +</li> +</ul> +<a name="setProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>public void setProperty(<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> key, + <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> value)</pre> +<div class="block">The default behavior of this method is to call + <code>setProperty(key, value)</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property to be returned to the portal</dd><dd><code>value</code> - the value of the property to be returned to the portal</dd></dl> +</li> +</ul> +<a name="getResponse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponse</h4> +<pre>public <a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> getResponse()</pre> +<div class="block">Return the wrapped response object.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the wrapped response</dd></dl> +</li> +</ul> +<a name="setResponse(javax.portlet.PortletResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setResponse</h4> +<pre>public void setResponse(<a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</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="addProperty(java.lang.String, org.w3c.dom.Element)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public void addProperty(<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> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a> element)</pre> +<div class="block">The default behavior of this method is to call + <code>addProperty()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property to be returned to the portal</dd><dd><code>element</code> - the XML DOM element to be added to the response</dd></dl> +</li> +</ul> +<a name="createElement(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createElement</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a> createElement(<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> tagName)</pre> +<div class="block">The default behavior of this method is to call + <code>createElement()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#createElement(java.lang.String)">createElement</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tagName</code> - name of the element type to instantiate</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new Element object with the nodeName attribute set to tagName, + and localName, prefix, and namespaceURI set to null.</dd></dl> +</li> +</ul> +<a name="addProperty(javax.servlet.http.Cookie)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public void addProperty(javax.servlet.http.Cookie cookie)</pre> +<div class="block">The default behavior of this method is to call + <code>addProperty()</code> on the wrapped response object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty</a></code> in interface <code><a href="../../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>cookie</code> - the cookie to be added to the response</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/PortletResponseWrapper.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/PortletRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/RenderFilter.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/PortletResponseWrapper.html" target="_top">Frames</a></li> +<li><a href="PortletResponseWrapper.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/RenderFilter.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderFilter.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderFilter.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderFilter.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>RenderFilter (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="RenderFilter (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/RenderFilter.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/PortletResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/RenderRequestWrapper.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/RenderFilter.html" target="_top">Frames</a></li> +<li><a href="RenderFilter.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 RenderFilter" class="title">Interface RenderFilter</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">RenderFilter</span> +extends <a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></pre> +<div class="block">The <code>RenderFilter</code> is an object that performs filtering + tasks on either the render request to a portlet, or on the render 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/RenderFilter.html#doFilter(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse,%20javax.portlet.filter.FilterChain)">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, + <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 render request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain.</div> +</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.RenderRequest, javax.portlet.RenderResponse, javax.portlet.filter.FilterChain)"> +<!-- --> +</a> +<ul class="blockListLast"> +<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, + <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 render 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 render 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>RenderRequestWrapper</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>RenderResponseWrapper</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 render request</dd><dd><code>response</code> - the current render 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/RenderFilter.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/PortletResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/RenderRequestWrapper.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/RenderFilter.html" target="_top">Frames</a></li> +<li><a href="RenderFilter.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/RenderRequestWrapper.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderRequestWrapper.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderRequestWrapper.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/RenderRequestWrapper.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,385 @@ +<!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>RenderRequestWrapper (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="RenderRequestWrapper (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/RenderRequestWrapper.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/RenderFilter.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/RenderResponseWrapper.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/RenderRequestWrapper.html" target="_top">Frames</a></li> +<li><a href="RenderRequestWrapper.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 RenderRequestWrapper" class="title">Class RenderRequestWrapper</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/PortletRequestWrapper.html" title="class in javax.portlet.filter">javax.portlet.filter.PortletRequestWrapper</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.filter.RenderRequestWrapper</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/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a>, <a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RenderRequestWrapper</span> +extends <a href="../../../javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a> +implements <a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></pre> +<div class="block">The <code>RenderRequestWrapper</code> provides a convenient + implementation of the <code>RenderRequest</code> interface + that can be subclassed by developers wishing to adapt the request. + This class implements the Wrapper or Decorator pattern. + Methods default to calling through to the wrapped request 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/RenderRequest.html" title="interface in javax.portlet"><code>RenderRequest</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_javax.portlet.PortletRequest"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface javax.portlet.<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet">PortletRequest.P3PUserInfos</a></code></li> +</ul> +</li> +</ul> +<!-- =========== 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.RenderRequest"> +<!-- --> +</a> +<h3>Fields inherited from interface javax.portlet.<a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></h3> +<code><a href="../../../javax/portlet/RenderRequest.html#ETAG">ETAG</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_javax.portlet.PortletRequest"> +<!-- --> +</a> +<h3>Fields inherited from interface javax.portlet.<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../../javax/portlet/PortletRequest.html#ACTION_PHASE">ACTION_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#ACTION_SCOPE_ID">ACTION_SCOPE_ID</a>, <a href="../../../javax/portlet/PortletRequest.html#BASIC_AUTH">BASIC_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#CCPP_PROFILE">CCPP_PROFILE</a>, <a href="../../../javax/portlet/PortletRequest.html#CLIENT_CERT_AUTH">CLIENT_CERT_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#DIGEST_AUTH">DIGEST_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#EVENT_PHASE">EVENT_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#FORM_AUTH">FORM_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#LIFECYCLE_PHASE">LIFECYCLE_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#RENDER_HEADERS">RENDER_HEADERS</a>, <a href="../../../javax/portlet/PortletRequest.html#RENDER_MARKUP">RENDER_MARKUP</a>, <a href="../../../javax/portlet/PortletRequest.html#REN DER_PART">RENDER_PART</a>, <a href="../../../javax/portlet/PortletRequest.html#RENDER_PHASE">RENDER_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#RESOURCE_PHASE">RESOURCE_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#USER_INFO">USER_INFO</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/RenderRequestWrapper.html#RenderRequestWrapper(javax.portlet.RenderRequest)">RenderRequestWrapper</a></strong>(<a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</code> +<div class="block">Creates an <code>RenderRequest</code> adaptor + wrapping the given request 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="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/RenderRequestWrapper.html#getETag()">getETag</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getETag()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderRequestWrapper.html#getRequest()">getRequest</a></strong>()</code> +<div class="block">Return the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/RenderRequestWrapper.html#setRequest(javax.portlet.RenderRequest)">setRequest</a></strong>(<a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</code> +<div class="block">Sets the request object being wrapped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.filter.PortletRequestWrapper"> +<!-- --> +</a> +<h3>Methods inherited from class javax.portlet.filter.<a href="../../../javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></h3> +<code><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getAttribute(java.lang.String)">getAttribute</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getAttributeNames()">getAttributeNames</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getAuthType()">getAuthType</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getContextPath()">getContextPath</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getCookies()">getCookies</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getLocale()">getLocale</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getLocales()">getLocales</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getParameter(java.lang.String)">getParameter</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getParameterMap()">getParameterMap</a>, <a href="../../../javax/portlet/filter/PortletRequestWr apper.html#getParameterNames()">getParameterNames</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getParameterValues(java.lang.String)">getParameterValues</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPortalContext()">getPortalContext</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPortletMode()">getPortletMode</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPortletSession()">getPortletSession</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPortletSession(boolean)">getPortletSession</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPreferences()">getPreferences</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPrivateParameterMap()">getPrivateParameterMap</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getProperties(java.lang.String)">getProperties</a>, <a href="../../../javax/portlet/f ilter/PortletRequestWrapper.html#getProperty(java.lang.String)">getProperty</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPropertyNames()">getPropertyNames</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getPublicParameterMap()">getPublicParameterMap</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getRemoteUser()">getRemoteUser</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getRequestedSessionId()">getRequestedSessionId</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getResponseContentType()">getResponseContentType</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getResponseContentTypes()">getResponseContentTypes</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getScheme()">getScheme</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getServerName()">getServerName</a>, <a href="../../../javax/portlet/ filter/PortletRequestWrapper.html#getServerPort()">getServerPort</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getUserPrincipal()">getUserPrincipal</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getWindowID()">getWindowID</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getWindowState()">getWindowState</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isPortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isSecure()">isSecure</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isUserInRole(java.lang.String)">isUserInRole</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</a>, < a href="../../../javax/portlet/filter/PortletRequestWrapper.html#removeAttribute(java.lang.String)">removeAttribute</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</a>, <a href="../../../javax/portlet/filter/PortletRequestWrapper.html#setRequest(javax.portlet.PortletRequest)">setRequest</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.PortletRequest"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../../javax/portlet/PortletRequest.html#getAttribute(java.lang.String)">getAttribute</a>, <a href="../../../javax/portlet/PortletRequest.html#getAttributeNames()">getAttributeNames</a>, <a href="../../../javax/portlet/PortletRequest.html#getAuthType()">getAuthType</a>, <a href="../../../javax/portlet/PortletRequest.html#getContextPath()">getContextPath</a>, <a href="../../../javax/portlet/PortletRequest.html#getCookies()">getCookies</a>, <a href="../../../javax/portlet/PortletRequest.html#getLocale()">getLocale</a>, <a href="../../../javax/portlet/PortletRequest.html#getLocales()">getLocales</a>, <a href="../../../javax/portlet/PortletRequest.html#getParameter(java.lang.String)">getParameter</a>, <a href="../../../javax/portlet/PortletRequest.html#getParameterMap()">getParameterMap</a>, <a href="../../../javax/portlet/PortletRequest.html#getParameterNames()">getParameterNames</a>, <a href="../../../javax/portlet/PortletRequest.html#getParameterValues(java.lang.Stri ng)">getParameterValues</a>, <a href="../../../javax/portlet/PortletRequest.html#getPortalContext()">getPortalContext</a>, <a href="../../../javax/portlet/PortletRequest.html#getPortletMode()">getPortletMode</a>, <a href="../../../javax/portlet/PortletRequest.html#getPortletSession()">getPortletSession</a>, <a href="../../../javax/portlet/PortletRequest.html#getPortletSession(boolean)">getPortletSession</a>, <a href="../../../javax/portlet/PortletRequest.html#getPreferences()">getPreferences</a>, <a href="../../../javax/portlet/PortletRequest.html#getPrivateParameterMap()">getPrivateParameterMap</a>, <a href="../../../javax/portlet/PortletRequest.html#getProperties(java.lang.String)">getProperties</a>, <a href="../../../javax/portlet/PortletRequest.html#getProperty(java.lang.String)">getProperty</a>, <a href="../../../javax/portlet/PortletRequest.html#getPropertyNames()">getPropertyNames</a>, <a href="../../../javax/portlet/PortletRequest.html#getPublicParameterMap()">getPublicParam eterMap</a>, <a href="../../../javax/portlet/PortletRequest.html#getRemoteUser()">getRemoteUser</a>, <a href="../../../javax/portlet/PortletRequest.html#getRequestedSessionId()">getRequestedSessionId</a>, <a href="../../../javax/portlet/PortletRequest.html#getResponseContentType()">getResponseContentType</a>, <a href="../../../javax/portlet/PortletRequest.html#getResponseContentTypes()">getResponseContentTypes</a>, <a href="../../../javax/portlet/PortletRequest.html#getScheme()">getScheme</a>, <a href="../../../javax/portlet/PortletRequest.html#getServerName()">getServerName</a>, <a href="../../../javax/portlet/PortletRequest.html#getServerPort()">getServerPort</a>, <a href="../../../javax/portlet/PortletRequest.html#getUserPrincipal()">getUserPrincipal</a>, <a href="../../../javax/portlet/PortletRequest.html#getWindowID()">getWindowID</a>, <a href="../../../javax/portlet/PortletRequest.html#getWindowState()">getWindowState</a>, <a href="../../../javax/portlet/PortletRequest.html#is PortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</a>, <a href="../../../javax/portlet/PortletRequest.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</a>, <a href="../../../javax/portlet/PortletRequest.html#isSecure()">isSecure</a>, <a href="../../../javax/portlet/PortletRequest.html#isUserInRole(java.lang.String)">isUserInRole</a>, <a href="../../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</a>, <a href="../../../javax/portlet/PortletRequest.html#removeAttribute(java.lang.String)">removeAttribute</a>, <a href="../../../javax/portlet/PortletRequest.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</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="RenderRequestWrapper(javax.portlet.RenderRequest)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RenderRequestWrapper</h4> +<pre>public RenderRequestWrapper(<a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</pre> +<div class="block">Creates an <code>RenderRequest</code> adaptor + wrapping the given request object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the render request 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 request 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="getRequest()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequest</h4> +<pre>public <a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> getRequest()</pre> +<div class="block">Return the wrapped request object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getRequest()">getRequest</a></code> in class <code><a href="../../../javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the wrapped request</dd></dl> +</li> +</ul> +<a name="setRequest(javax.portlet.RenderRequest)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequest</h4> +<pre>public void setRequest(<a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request)</pre> +<div class="block">Sets the request object being wrapped.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the request 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 request is null.</dd></dl> +</li> +</ul> +<a name="getETag()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getETag</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> getETag()</pre> +<div class="block">The default behavior of this method is to call + <code>getETag()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/RenderRequest.html#getETag()">getETag</a></code> in interface <code><a href="../../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the validation tag if the portlet container + has a cached response for this validation tag, or + <code>null</code> if no cached response exists.</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/RenderRequestWrapper.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/RenderFilter.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/RenderResponseWrapper.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/RenderRequestWrapper.html" target="_top">Frames</a></li> +<li><a href="RenderRequestWrapper.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>
