Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/RenderResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/RenderResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/RenderResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/RenderResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,324 @@ +<!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>RenderResponse (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="RenderResponse (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/RenderResponse.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/RenderRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/RenderResponse.html" target="_top">Frames</a></li> +<li><a href="RenderResponse.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</div> +<h2 title="Interface RenderResponse" class="title">Interface RenderResponse</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</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></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RenderResponse</span> +extends <a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></pre> +<div class="block">The <CODE>RenderResponse</CODE> defines an object to assist a portlet in + sending a response to the portal. It extends the <CODE>MimeResponse</CODE> + interface to provide specific render response functionality to portlets.<br> + The portlet container creates a <CODE>RenderResponse</CODE> object and + passes it as argument to the portlet's <CODE>render</CODE> method.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet"><code>RenderRequest</code></a>, +<a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><code>PortletResponse</code></a>, +<a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet"><code>MimeResponse</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> +<!-- ========== 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/RenderResponse.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">Sets the MIME type for the render response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/RenderResponse.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">This method allows the portlet to tell the portal the next possible + portlet modes that the make sense from the portlet point of view.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/RenderResponse.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">This method sets the title of the portlet.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.MimeResponse"> +<!-- --> +</a> +<h3>Methods 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#createActionURL()">createActionURL</a>, <a href="../../javax/portlet/MimeResponse.html#createRenderURL()">createRenderURL</a>, <a href="../../javax/portlet/MimeResponse.html#createResourceURL()">createResourceURL</a>, <a href="../../javax/portlet/MimeResponse.html#flushBuffer()">flushBuffer</a>, <a href="../../javax/portlet/MimeResponse.html#getBufferSize()">getBufferSize</a>, <a href="../../javax/portlet/MimeResponse.html#getCacheControl()">getCacheControl</a>, <a href="../../javax/portlet/MimeResponse.html#getCharacterEncoding()">getCharacterEncoding</a>, <a href="../../javax/portlet/MimeResponse.html#getContentType()">getContentType</a>, <a href="../../javax/portlet/MimeResponse.html#getLocale()">getLocale</a>, <a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()">getPortletOutputStream</a>, <a href="../../javax/portlet/MimeResponse.html#getWriter()">getWriter</a>, <a href="../../javax/portlet/MimeResponse.ht ml#isCommitted()">isCommitted</a>, <a href="../../javax/portlet/MimeResponse.html#reset()">reset</a>, <a href="../../javax/portlet/MimeResponse.html#resetBuffer()">resetBuffer</a>, <a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)">setBufferSize</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setTitle(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTitle</h4> +<pre>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">This method sets the title of the portlet. + <p> + The value can be a text String</div> +<dl><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="setNextPossiblePortletModes(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNextPossiblePortletModes</h4> +<pre>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">This method allows the portlet to tell the portal the next possible + portlet modes that the make sense from the portlet point of view. + <p> + If set, the portal should honor these enumeration of portlet modes and + only provide the end user with choices to the provided portlet modes or a + subset of these modes based on access control considerations. + <p> + If the portlet does not set any next possible portlet modes the default + is that all portlet modes that the portlet has defined supporting in the + portlet deployment descriptor are meaningful new portlet modes.</div> +<dl><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><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="setContentType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setContentType</h4> +<pre>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">Sets the MIME type for the render response. The portlet should set the + content type before calling <a href="../../javax/portlet/MimeResponse.html#getWriter()"><code>MimeResponse.getWriter()</code></a> or + <a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()"><code>MimeResponse.getPortletOutputStream()</code></a>. + <p> + Calling <code>setContentType</code> after <code>getWriter</code> or + <code>getOutputStream</code> does not change the content type. + <p> + The portlet container will ignore any character encoding + specified as part of the content type for <code>render</code> + calls.</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><span class="strong">Parameters:</span></dt><dd><code>type</code> - the content MIME type</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 given type is not in the list + returned by <code>PortletRequest.getResponseContentTypes</code></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> +</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/RenderResponse.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/RenderRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/RenderResponse.html" target="_top">Frames</a></li> +<li><a href="RenderResponse.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/ResourceRequest.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceRequest.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceRequest.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceRequest.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,459 @@ +<!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>ResourceRequest (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="ResourceRequest (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/ResourceRequest.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/RenderResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceRequest.html" target="_top">Frames</a></li> +<li><a href="ResourceRequest.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>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</div> +<h2 title="Interface ResourceRequest" class="title">Interface ResourceRequest</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a>, <a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceRequest</span> +extends <a href="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></pre> +<div class="block">The <code>ResourceRequest</code> interface represents the request + send to the portlet for rendering resources. + + It extends the ClientDataRequest interface and provides resource request + information to portlets. + <p> + The portlet container creates an <CODE>ResourceRequest</CODE> object and + passes it as argument to the portlet's <CODE>serveResource</CODE> method. + <p> + The <code>ResourceRequest</code> is provided with the current portlet mode, window state, + and render parameters that the portlet can access via the + <code>PortletResourceRequest</code> with <code>getPortletMode</code> and, + <code>getWindowState</code>, or one of the <code>getParameter</code> methods. + ResourceURLs cannot change the current portlet mode, window state or + render parameters. Parameters set on a resource URL are not render parameters + but parameters for serving this resource and will last only for only + this the current serveResource request.<br> + If a parameter is set that has the same name as a render parameter that this + resource URL contains, the render parameter must be the last entry in the + parameter value array.</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/ClientDataRequest.html" title="interface in javax.portlet"><code>ClientDataRequest</code></a>, +<a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet"><code>ResourceServingPortlet</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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceRequest.html#ETAG">ETAG</a></strong></code> +<div class="block">This property is set by the container if the container + has a cached response for the given validation tag.</div> +</td> +</tr> +</table> +<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#RENDER_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> +<!-- ========== 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/ResourceRequest.html#getCacheability()">getCacheability</a></strong>()</code> +<div class="block">Returns the cache level of this resource request.</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/ResourceRequest.html#getETag()">getETag</a></strong>()</code> +<div class="block">Returns the validation tag if the portlet container + has a cached response for this validation tag, or + <code>null</code> if no cached response exists.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceRequest.html#getPrivateRenderParameterMap()">getPrivateRenderParameterMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the private render parameters of this request.</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/ResourceRequest.html#getResourceID()">getResourceID</a></strong>()</code> +<div class="block">Returns the resource ID set on the ResourceURL or <code>null</code> + if no resource ID was set on the URL.</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/ResourceRequest.html#getResponseContentType()">getResponseContentType</a></strong>()</code> +<div class="block">Returns the portal preferred content type for the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceRequest.html#getResponseContentTypes()">getResponseContentTypes</a></strong>()</code> +<div class="block">Gets a list of content types which the portal accepts for the response.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.ClientDataRequest"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></h3> +<code><a href="../../javax/portlet/ClientDataRequest.html#getCharacterEncoding()">getCharacterEncoding</a>, <a href="../../javax/portlet/ClientDataRequest.html#getContentLength()">getContentLength</a>, <a href="../../javax/portlet/ClientDataRequest.html#getContentType()">getContentType</a>, <a href="../../javax/portlet/ClientDataRequest.html#getMethod()">getMethod</a>, <a href="../../javax/portlet/ClientDataRequest.html#getPortletInputStream()">getPortletInputStream</a>, <a href="../../javax/portlet/ClientDataRequest.html#getReader()">getReader</a>, <a href="../../javax/portlet/ClientDataRequest.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</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.String)">getParameterValues</a>, <a h ref="../../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()">getPublicParameterMap</a>, <a href="../../javax/portlet/PortletRequest.html#g etRemoteUser()">getRemoteUser</a>, <a href="../../javax/portlet/PortletRequest.html#getRequestedSessionId()">getRequestedSessionId</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#isPortletModeAllowed(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.htm l#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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ETAG"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ETAG</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ETAG</pre> +<div class="block">This property is set by the container if the container + has a cached response for the given validation tag. The property can be + retrieved using the <code>getProperty</code> method. + <P> + The value is <code>"portlet.ETag "</code>.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ResourceRequest.ETAG">Constant Field Values</a></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="getETag()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getETag</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getETag()</pre> +<div class="block">Returns the validation tag if the portlet container + has a cached response for this validation tag, or + <code>null</code> if no cached response exists. + <p> + This call returns the same value as + <code>ResourceRequest.getProperty(ResourceRequest.ETAG)</code>.</div> +<dl><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> +<a name="getResourceID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceID</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getResourceID()</pre> +<div class="block">Returns the resource ID set on the ResourceURL or <code>null</code> + if no resource ID was set on the URL. + <p> + Note that if the resource ID is to be used as the target for a + <code>PortletRequestDispatcher</code> forward or include, it should be checked for + validity before use.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the resource ID set on the ResourceURL,or <code>null</code> + if no resource ID was set on the URL.</dd></dl> +</li> +</ul> +<a name="getPrivateRenderParameterMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrivateRenderParameterMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getPrivateRenderParameterMap()</pre> +<div class="block">Returns a <code>Map</code> of the private render parameters of this request. + Private parameters are not shared with other portlets or components. + The returned parameters are "x-www-form-urlencoded" decoded. + <p> + The parameters returned do not include the resource parameters that + the portlet may have set on the resource URL triggering this + <code>serveResource</code> call. + <p> + The values in the returned <code>Map</code> are from type + String array (<code>String[]</code>). + <p> + If no private parameters exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing private parameter names as + keys and private parameter values as map values, or an empty <code>Map</code> + if no private parameters exist. The keys in the parameter + map are of type String. The values in the parameter map are of type + String array (<code>String[]</code>).</dd></dl> +</li> +</ul> +<a name="getResponseContentType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseContentType</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getResponseContentType()</pre> +<div class="block">Returns the portal preferred content type for the response. + <p> + The returned content type should be based on the HTTP Accept header + provided by the client.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletRequest.html#getResponseContentType()">getResponseContentType</a></code> in interface <code><a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>preferred content type of the response</dd></dl> +</li> +</ul> +<a name="getResponseContentTypes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseContentTypes</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getResponseContentTypes()</pre> +<div class="block">Gets a list of content types which the portal accepts for the response. + This list is ordered with the most preferable types listed first. + <p> + The returned content types should be based on the HTTP Accept header + provided by the client.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../javax/portlet/PortletRequest.html#getResponseContentTypes()">getResponseContentTypes</a></code> in interface <code><a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>ordered list of content types for the response</dd></dl> +</li> +</ul> +<a name="getCacheability()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCacheability</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getCacheability()</pre> +<div class="block">Returns the cache level of this resource request. + <p> + Possible return values are: + <code>ResourceURL.FULL, ResourceURL.PORTLET</code> + or <code>ResourceURL.PAGE</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cache level of this resource request.</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/ResourceRequest.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/RenderResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceRequest.html" target="_top">Frames</a></li> +<li><a href="ResourceRequest.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>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/ResourceResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,466 @@ +<!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>ResourceResponse (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="ResourceResponse (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/ResourceResponse.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/ResourceRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceResponse.html" target="_top">Frames</a></li> +<li><a href="ResourceResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>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</div> +<h2 title="Interface ResourceResponse" class="title">Interface ResourceResponse</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</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></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceResponse</span> +extends <a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a></pre> +<div class="block">The <CODE>ResourceResponse</CODE> defines an object to assist a portlet + for rendering a resource. + <p> + The difference between the <CODE>RenderResponse</CODE> is that for the + <CODE>ResourceResponse</CODE> the output of this response is delivered + directly to the client without any additional markup added by the portal. + It is therefore allowed for the portlet to return binary content in this + response. + <p> + A portlet can set HTTP headers for the response via the setProperty or + addProperty call in the <CODE>ResourceResponse</CODE>. + To be successfully transmitted back to the client, headers must be set + before the response is committed. Headers set after the response is + committed will be ignored by the portlet container. + <p> + The portlet container creates a <CODE>ResourceResponse</CODE> object and + passes it as argument to the portlet's <CODE>serveResource</CODE> method.</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/ResourceServingPortlet.html" title="interface in javax.portlet"><code>ResourceServingPortlet</code></a>, +<a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet"><code>MimeResponse</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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceResponse.html#HTTP_STATUS_CODE">HTTP_STATUS_CODE</a></strong></code> +<div class="block">Constant for setting the HTTP status code via the + <code>setProperty</code> method.</div> +</td> +</tr> +</table> +<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> +<!-- ========== 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/ResourceResponse.html#createActionURL()">createActionURL</a></strong>()</code> +<div class="block">Creates a portlet URL targeting the portlet.</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/ResourceResponse.html#createRenderURL()">createRenderURL</a></strong>()</code> +<div class="block">Creates a portlet URL targeting the portlet.</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/ResourceResponse.html#createResourceURL()">createResourceURL</a></strong>()</code> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceResponse.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</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> charset)</code> +<div class="block">Sets the character encoding (MIME charset) of the response being + sent to the client, for example, to UTF-8.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceResponse.html#setContentLength(int)">setContentLength</a></strong>(int len)</code> +<div class="block">Sets the length of the content body in the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceResponse.html#setLocale(java.util.Locale)">setLocale</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> loc)</code> +<div class="block">Sets the locale of the response, setting the headers + (including the Content-Type's charset) as appropriate.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.MimeResponse"> +<!-- --> +</a> +<h3>Methods 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#flushBuffer()">flushBuffer</a>, <a href="../../javax/portlet/MimeResponse.html#getBufferSize()">getBufferSize</a>, <a href="../../javax/portlet/MimeResponse.html#getCacheControl()">getCacheControl</a>, <a href="../../javax/portlet/MimeResponse.html#getCharacterEncoding()">getCharacterEncoding</a>, <a href="../../javax/portlet/MimeResponse.html#getContentType()">getContentType</a>, <a href="../../javax/portlet/MimeResponse.html#getLocale()">getLocale</a>, <a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()">getPortletOutputStream</a>, <a href="../../javax/portlet/MimeResponse.html#getWriter()">getWriter</a>, <a href="../../javax/portlet/MimeResponse.html#isCommitted()">isCommitted</a>, <a href="../../javax/portlet/MimeResponse.html#reset()">reset</a>, <a href="../../javax/portlet/MimeResponse.html#resetBuffer()">resetBuffer</a>, <a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)">setBufferSize</a> , <a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)">setContentType</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="HTTP_STATUS_CODE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HTTP_STATUS_CODE</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> HTTP_STATUS_CODE</pre> +<div class="block">Constant for setting the HTTP status code via the + <code>setProperty</code> method.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ResourceResponse.HTTP_STATUS_CODE">Constant Field Values</a></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="setLocale(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocale</h4> +<pre>void setLocale(<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> loc)</pre> +<div class="block">Sets the locale of the response, setting the headers + (including the Content-Type's charset) as appropriate. + This method should be called before a call to getWriter(). + By default, the response locale is the default locale provided + by the portlet container.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>loc</code> - the new locale of the response</dd></dl> +</li> +</ul> +<a name="setCharacterEncoding(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCharacterEncoding</h4> +<pre>void setCharacterEncoding(<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> charset)</pre> +<div class="block">Sets the character encoding (MIME charset) of the response being + sent to the client, for example, to UTF-8. If the character encoding + has already been set by either the portlet container, + <code>setContentType(java.lang.String)</code> or + <code>setLocale(java.util.Locale)</code>, this method overrides it. Calling + <code>setContentType(java.lang.String)</code> with the String of + <code>text/html</code> and calling this method with the String of + <code>UTF-8</code> is equivalent with calling <code>setContentType</code> + with the String of <code>text/html; charset=UTF-8</code>. + <p> + This method can be called repeatedly to change the character encoding. + This method has no effect if it is called after getWriter has been called + or after the response has been committed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - a String specifying only the character set defined by + IANA Character Sets (http://www.iana.org/assignments/character-sets)</dd></dl> +</li> +</ul> +<a name="setContentLength(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContentLength</h4> +<pre>void setContentLength(int len)</pre> +<div class="block">Sets the length of the content body in the response.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>len</code> - an integer specifying the length of the content being returned</dd></dl> +</li> +</ul> +<a name="createRenderURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRenderURL</h4> +<pre><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> createRenderURL()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/MimeResponse.html#createRenderURL()">MimeResponse</a></code></strong></div> +<div class="block">Creates a portlet URL targeting the portlet. If no portlet mode, window + state or security modifier is set in the PortletURL the current values + are preserved. If a request is triggered by the PortletURL, it results in + a render request. + <p> + The returned URL can be further extended by adding portlet-specific + parameters and portlet modes and window states. + <p> + The created URL will per default not contain any parameters of the + current render request.</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> - if the cacheability level of the resource URL + triggering this <code>serveResource</code> call + is not <code>PAGE</code> and thus does not allow + for creating render URLs.</dd></dl> +</li> +</ul> +<a name="createActionURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createActionURL</h4> +<pre><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> createActionURL()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/MimeResponse.html#createActionURL()">MimeResponse</a></code></strong></div> +<div class="block">Creates a portlet URL targeting the portlet. If no portlet mode, window + state or security modifier is set in the PortletURL the current values + are preserved. If a request is triggered by the PortletURL, it results in + an action request. + <p> + The returned URL can be further extended by adding portlet-specific + parameters and portlet modes and window states. + <p> + The created URL will per default not contain any parameters of the + current render request.</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> - if the cacheability level of the resource URL + triggering this <code>serveResource</code> call + is not <code>PAGE</code> and thus does not allow + for creating action URLs.</dd></dl> +</li> +</ul> +<a name="createResourceURL()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createResourceURL</h4> +<pre><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a> createResourceURL()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../javax/portlet/MimeResponse.html#createResourceURL()">MimeResponse</a></code></strong></div> +<div class="block">Creates a portlet URL targeting the portlet. If no security modifier is + set in the PortletURL the current values are preserved. The current + render parameters, portlet mode and window state are preserved. + <p> + If a request is triggered by the PortletURL, it results in a serve + resource request of the <code>ResourceServingPortlet</code> interface. + <p> + The returned URL can be further extended by adding portlet-specific + parameters . + <p> + The created URL will per default contain the current + cacheability setting of the parent resource. + If no parent resource is available, <code>PAGE</code> is the default.</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> - if the cacheability level of the resource URL + triggering this <code>serveResource</code> call, + or one of the parent calls, have defined a stricter + cachability level.</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/ResourceResponse.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/ResourceRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceResponse.html" target="_top">Frames</a></li> +<li><a href="ResourceResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>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/ResourceServingPortlet.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceServingPortlet.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceServingPortlet.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceServingPortlet.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,241 @@ +<!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>ResourceServingPortlet (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="ResourceServingPortlet (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/ResourceServingPortlet.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/ResourceResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceServingPortlet.html" target="_top">Frames</a></li> +<li><a href="ResourceServingPortlet.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</div> +<h2 title="Interface ResourceServingPortlet" class="title">Interface ResourceServingPortlet</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceServingPortlet</span></pre> +<div class="block">The <code>ResourceServingPortlet</code> interface allows + serving resources through the portlet. + <p> + The portlet container must call this method for links created by + the <code>RenderResponse.createResourceURL()</code> call. + If the portlet creates resource URLs with <code>RenderResponse.createResourceURL()</code> + it must implement this lifecycle method.</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/ResourceServingPortlet.html#serveResource(javax.portlet.ResourceRequest,%20javax.portlet.ResourceResponse)">serveResource</a></strong>(<a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a> request, + <a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a> response)</code> +<div class="block">Called by the portlet container to allow the portlet to generate + the resource content based on its current state.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>serveResource</h4> +<pre>void serveResource(<a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a> request, + <a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Called by the portlet container to allow the portlet to generate + the resource content based on its current state. + The portal / portlet container must not render any output in addition + to the content returned by the portlet. The portal / portlet container + should expect that the portlet may return binary content for a + <code>renderResource</code> call.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the resource request</dd><dd><code>response</code> - the resource response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet has problems fulfilling the + rendering request</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet is unavailable to perform render at this time</dd> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fullfill this request because of security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></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/ResourceServingPortlet.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/ResourceResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceServingPortlet.html" target="_top">Frames</a></li> +<li><a href="ResourceServingPortlet.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>
