Added: portals/site-live/portlet-api/portlet-api-2.1.0/index.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/index.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/index.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/index.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc on Thu Jul 16 17:20:28 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Java Portlet Specification V2.1.0 1.0 API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionRequest.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionRequest.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionRequest.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionRequest.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,277 @@ +<!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:26 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ActionRequest (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="ActionRequest (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/ActionRequest.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>Prev Class</li> +<li><a href="../../javax/portlet/ActionResponse.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/ActionRequest.html" target="_top">Frames</a></li> +<li><a href="ActionRequest.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li>Method</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 ActionRequest" class="title">Interface ActionRequest</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/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ActionRequest</span> +extends <a href="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a></pre> +<div class="block">The <CODE>ActionRequest</CODE> represents the request sent to the portlet + to handle an action.<br> + It extends the ClientDataRequest interface and provides action request + information to portlets. + <p> + The portlet container creates an <CODE>ActionRequest</CODE> object and + passes it as argument to the portlet's <CODE>processAction</CODE> method.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet"><code>ClientDataRequest</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/ActionRequest.html#ACTION_NAME">ACTION_NAME</a></strong></code> +<div class="block">Predefined action name for usage with the + <code>@ProcessAction</code> annotation.</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> +<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#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#isPortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</a>, <a href="../../javax/po rtlet/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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ACTION_NAME"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ACTION_NAME</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> ACTION_NAME</pre> +<div class="block">Predefined action name for usage with the + <code>@ProcessAction</code> annotation.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ActionRequest.ACTION_NAME">Constant Field Values</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/ActionRequest.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>Prev Class</li> +<li><a href="../../javax/portlet/ActionResponse.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/ActionRequest.html" target="_top">Frames</a></li> +<li><a href="ActionRequest.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li>Method</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/ActionResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ActionResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,320 @@ +<!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:26 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ActionResponse (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="ActionResponse (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/ActionResponse.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/ActionRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/BaseURL.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/ActionResponse.html" target="_top">Frames</a></li> +<li><a href="ActionResponse.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 ActionResponse" class="title">Interface ActionResponse</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a>, <a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter">ActionResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ActionResponse</span> +extends <a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></pre> +<div class="block">The <CODE>ActionResponse</CODE> interface represents the portlet + response to an action request. + It extends the <CODE>StateAwareResponse</CODE> interface to provide specific + action response functionality to portlets.<br> + The portlet container creates an <CODE>ActionResponse</CODE> object and + passes it as argument to the portlet's <CODE>processAction</CODE> method.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><code>StateAwareResponse</code></a>, +<a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><code>PortletResponse</code></a>, +<a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet"><code>ActionRequest</code></a></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/ActionResponse.html#sendRedirect(java.lang.String)">sendRedirect</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> location)</code> +<div class="block">Instructs the portlet container to send a redirect response + to the client using the specified redirect location URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ActionResponse.html#sendRedirect(java.lang.String,%20java.lang.String)">sendRedirect</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> location, + <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> renderUrlParamName)</code> +<div class="block">Instructs the portlet container to send a redirect response + to the client using the specified redirect location URL and + encode a render URL as parameter on the redirect URL.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.StateAwareResponse"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></h3> +<code><a href="../../javax/portlet/StateAwareResponse.html#getPortletMode()">getPortletMode</a>, <a href="../../javax/portlet/StateAwareResponse.html#getRenderParameterMap()">getRenderParameterMap</a>, <a href="../../javax/portlet/StateAwareResponse.html#getWindowState()">getWindowState</a>, <a href="../../javax/portlet/StateAwareResponse.html#removePublicRenderParameter(java.lang.String)">removePublicRenderParameter</a>, <a href="../../javax/portlet/StateAwareResponse.html#setEvent(javax.xml.namespace.QName,%20java.io.Serializable)">setEvent</a>, <a href="../../javax/portlet/StateAwareResponse.html#setEvent(java.lang.String,%20java.io.Serializable)">setEvent</a>, <a href="../../javax/portlet/StateAwareResponse.html#setPortletMode(javax.portlet.PortletMode)">setPortletMode</a>, <a href="../../javax/portlet/StateAwareResponse.html#setRenderParameter(java.lang.String,%20java.lang.String)">setRenderParameter</a>, <a href="../../javax/portlet/StateAwareResponse.html#setRenderParameter(j ava.lang.String,%20java.lang.String[])">setRenderParameter</a>, <a href="../../javax/portlet/StateAwareResponse.html#setRenderParameters(java.util.Map)">setRenderParameters</a>, <a href="../../javax/portlet/StateAwareResponse.html#setWindowState(javax.portlet.WindowState)">setWindowState</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="sendRedirect(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendRedirect</h4> +<pre>void sendRedirect(<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> location) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Instructs the portlet container to send a redirect response + to the client using the specified redirect location URL. + <p> + This method only accepts 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>). + If required, + the portlet container may encode the given URL before the + redirection is issued to the client. + <p> + The sendRedirect method can not be invoked after any of the + following methods of the ActionResponse interface has been called: + <ul> + <li>setPortletMode</li> + <li>setWindowState</li> + <li>setRenderParameter</li> + <li>setRenderParameters</li> + <li>removePublicRenderParamter</li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the redirect location URL</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an input or output exception occurs.</dd> +<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 a relative path URL is given</dd> +<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 method is invoked after any of above mentioned methods of + the ActionResponse interface has been called.</dd></dl> +</li> +</ul> +<a name="sendRedirect(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sendRedirect</h4> +<pre>void sendRedirect(<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> location, + <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> renderUrlParamName) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Instructs the portlet container to send a redirect response + to the client using the specified redirect location URL and + encode a render URL as parameter on the redirect URL. + <p> + This method only accepts 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>). + If required, + the portlet container may encode the given URL before the + redirection is issued to the client. + <p> + The portlet container will attach a render URL with the currently set portlet mode, window state + and render parameters on the <code>ActionResponse</code> and the current public render parameters. + The attached URL will be available as query parameter value under the key provided with the + <code>renderUrlParamName</code> parameter. + <p> + New values for + <ul> + <li>setPortletMode + <li>setWindowState + <li>setRenderParameter + <li>setRenderParameters + </ul> + are only used for creating the render URL and not remembered after the redirect + is issued.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the redirect location URL</dd><dd><code>renderUrlParamName</code> - name of the query parameter under which the portlet container should + store a render URL to this portlet</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an input or output exception occurs.</dd> +<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 a relative path URL is given</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</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/ActionResponse.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/ActionRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/BaseURL.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/ActionResponse.html" target="_top">Frames</a></li> +<li><a href="ActionResponse.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/BaseURL.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/BaseURL.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/BaseURL.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/BaseURL.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,511 @@ +<!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:26 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BaseURL (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="BaseURL (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/BaseURL.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/ActionResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/CacheControl.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/BaseURL.html" target="_top">Frames</a></li> +<li><a href="BaseURL.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 BaseURL" class="title">Interface BaseURL</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a>, <a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">BaseURL</span></pre> +<div class="block">The <CODE>BaseURL</CODE> defines the basic capabilities + of a portlet URL pointing back to the portlet.</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/BaseURL.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">Adds a String property to an existing key on the URL.</div> +</td> +</tr> +<tr class="rowColor"> +<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/BaseURL.html#getParameterMap()">getParameterMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the parameters + currently set on this portlet URL via the + <code>setParameter</code> or <code>setParameters</code> + methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.html#setParameter(java.lang.String,%20java.lang.String)">setParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <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">Sets the given String parameter to this URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.html#setParameter(java.lang.String,%20java.lang.String[])">setParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <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>[] values)</code> +<div class="block">Sets the given String array parameter to this URL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.html#setParameters(java.util.Map)">setParameters</a></strong>(<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>[]> parameters)</code> +<div class="block">Sets a parameter map for this URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.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">Sets a String property on the URL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.html#setSecure(boolean)">setSecure</a></strong>(boolean secure)</code> +<div class="block">Indicated the security setting for this URL.</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/BaseURL.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the portlet URL string representation to be embedded in the + markup.<br> + Note that the returned String may not be a valid URL, as it may + be rewritten by the portal/portlet-container before returning the + markup to the client.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.html#write(java.io.Writer)">write</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out)</code> +<div class="block">Writes the portlet URL to the output stream using the provided writer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/BaseURL.html#write(java.io.Writer,%20boolean)">write</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + boolean escapeXML)</code> +<div class="block">Writes the portlet URL to the output stream using the provided writer.</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="setParameter(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setParameter</h4> +<pre>void setParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <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">Sets the given String parameter to this URL. + <p> + This method replaces all parameters with the given key. + <p> + The <code>PortletURL</code> implementation 'x-www-form-urlencoded' encodes + all parameter names and values. Developers should not encode them. + <p> + A portlet container may prefix the attribute names internally + in order to preserve a unique namespace for the portlet. + <p> + A parameter value of <code>null</code> indicates that this + parameter should be removed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the parameter name</dd><dd><code>value</code> - the parameter value</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 name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="setParameter(java.lang.String, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setParameter</h4> +<pre>void setParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <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>[] values)</pre> +<div class="block">Sets the given String array parameter to this URL. + <p> + This method replaces all parameters with the given key. + <p> + The <code>PortletURL</code> implementation 'x-www-form-urlencoded' encodes + all parameter names and values. Developers should not encode them. + <p> + A portlet container may prefix the attribute names internally + in order to preserve a unique namespace for the portlet.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the parameter name</dd><dd><code>values</code> - the parameter values</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 name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="setParameters(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setParameters</h4> +<pre>void setParameters(<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>[]> parameters)</pre> +<div class="block">Sets a parameter map for this URL. + <p> + All previously set parameters are cleared. + <p> + The <code>PortletURL</code> implementation 'x-www-form-urlencoded' encodes + all parameter names and values. Developers should not encode them. + <p> + A portlet container may prefix the attribute names internally, + in order to preserve a unique namespace for the portlet.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameters</code> - Map containing parameter names for + the render phase as + keys and parameter values as map + values. The keys in the parameter + map must be of type String. The values + in the parameter map must be of type + String array (<code>String[]</code>).</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 parameters is <code>null</code>, if + any of the keys in the Map are <code>null</code>, + if any of the keys is not a String, or if any of + the values is not a String array.</dd></dl> +</li> +</ul> +<a name="setSecure(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSecure</h4> +<pre>void setSecure(boolean secure) + throws <a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></pre> +<div class="block">Indicated the security setting for this URL. + <p> + Secure set to <code>true</code> indicates that the portlet requests + a secure connection between the client and the portlet window for + this URL. Secure set to <code>false</code> indicates that the portlet + does not need a secure connection for this URL. If the security is not + set for a URL, it should stay the same as the current request.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>secure</code> - true, if portlet requests to have a secure connection + between its portlet window and the client; false, if + the portlet does not require a secure connection.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the run-time environment does + not support the indicated setting</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</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> toString()</pre> +<div class="block">Returns the portlet URL string representation to be embedded in the + markup.<br> + Note that the returned String may not be a valid URL, as it may + be rewritten by the portal/portlet-container before returning the + markup to the client. + <p> + The returned URL is not XML escaped. + <p> + For writing URLs to an output stream the <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer)"><code>write(java.io.Writer)</code></a> or + <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer,%20boolean)"><code>write(java.io.Writer, boolean)</code></a> method should be used as these are + more efficient.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the encoded URL as a string</dd></dl> +</li> +</ul> +<a name="getParameterMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterMap</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>[]> getParameterMap()</pre> +<div class="block">Returns a <code>Map</code> of the parameters + currently set on this portlet URL via the + <code>setParameter</code> or <code>setParameters</code> + methods. + <p> + The values in the returned <code>Map</code> are from type + String array (<code>String[]</code>). + <p> + If no parameters exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>Map</code> containing parameter names as + keys and parameter values as map values, or an empty <code>Map</code> + if no 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><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="write(java.io.Writer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>void write(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Writes the portlet URL to the output stream using the provided writer. + <p> + Note that the URL written to the output stream may not be a valid URL, as it may + be rewritten by the portal/portlet-container before returning the + markup to the client. + <p> + The URL written to the output stream is always XML escaped. For writing + non-escaped URLs use <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer,%20boolean)"><code>write(java.io.Writer, boolean)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the writer to write the portlet URL to</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 I/O error occured while writing the URL</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="write(java.io.Writer, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>void write(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + boolean escapeXML) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Writes the portlet URL to the output stream using the provided writer. + If the parameter escapeXML is set to true the URL will be escaped to be + valid XML characters, i.e. <, >, &, ', " will get converted + into their corresponding character entity codes (< to &<, > to &>, + & to &&, ' to &', " to &"). + If escapeXML is set to false no escaping will be done. + <p> + Note that the URL written to the output stream may not be a valid URL, as it may + be rewritten by the portal/portlet-container before returning the + markup to the client.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the writer to write the portlet URL to</dd><dd><code>escapeXML</code> - denotes if the URL should be XML escaped before written to the output + stream or not</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 I/O error occurred while writing the URL</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="addProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>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">Adds a String property to an existing key on the URL. + <p> + This method allows URL properties to have multiple values. + <p> + Properties can be used by portlets to provide vendor specific information + to the URL.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property</dd><dd><code>value</code> - the value of the property</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 key is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="setProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>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">Sets a String property on the URL. + <p> + Properties can be used by portlets to provide vendor specific information + to the URL. + <p> + This method resets all properties previously added with the same key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property</dd><dd><code>value</code> - the value of the property</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 key is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</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/BaseURL.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/ActionResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/CacheControl.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/BaseURL.html" target="_top">Frames</a></li> +<li><a href="BaseURL.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/CacheControl.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/CacheControl.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/CacheControl.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/CacheControl.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,419 @@ +<!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:26 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CacheControl (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="CacheControl (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/CacheControl.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/BaseURL.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ClientDataRequest.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/CacheControl.html" target="_top">Frames</a></li> +<li><a href="CacheControl.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 CacheControl" class="title">Interface CacheControl</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">CacheControl</span></pre> +<div class="block">The <code>CacheControl</code> interface represents cache settings + for a piece of markup. The settings are only valid for the current + request.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#getETag()">getETag</a></strong>()</code> +<div class="block">Returns the ETag for the current response that is + used as validation tag, or <code>null</null> + if no ETag is set on the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#getExpirationTime()">getExpirationTime</a></strong>()</code> +<div class="block">Get the currently set expiration time.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#isPublicScope()">isPublicScope</a></strong>()</code> +<div class="block">Returns a boolean indicating whether the + caching scope is set to public for the current response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#setETag(java.lang.String)">setETag</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> token)</code> +<div class="block">Sets an ETag for the current response that is + used as validation tag.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#setExpirationTime(int)">setExpirationTime</a></strong>(int time)</code> +<div class="block">Sets a new expiration time for the current response + in seconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#setPublicScope(boolean)">setPublicScope</a></strong>(boolean publicScope)</code> +<div class="block">Sets the caching scope for the current response + to public with <code>true</code> as + <code>publicScope</code> and to private with + <code>false</code> as <code>publicScope</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#setUseCachedContent(boolean)">setUseCachedContent</a></strong>(boolean useCachedContent)</code> +<div class="block">Sets the indication whether the cached content + for the provided ETag at the request is still valid or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/CacheControl.html#useCachedContent()">useCachedContent</a></strong>()</code> +<div class="block">Returns a boolean indicating whether the + cached content for the provided ETag at the request + can still be considerated valid.</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="getExpirationTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExpirationTime</h4> +<pre>int getExpirationTime()</pre> +<div class="block">Get the currently set expiration time. + If no expiration time is set on this response the + default defined in the portlet deployment descriptor + with the <code>expiration-cache<code> tag is returned, + or <code>0</code> if no default is defined. + <p> + This call returns the same value as the + <code>getProperty(EXPIRATION_CACHE)</code> + call.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the currently set expiration time in seconds, + or <code>0</code> if no expiration time + is set.</dd></dl> +</li> +</ul> +<a name="setExpirationTime(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExpirationTime</h4> +<pre>void setExpirationTime(int time)</pre> +<div class="block">Sets a new expiration time for the current response + in seconds. + <p> + If the expiration value is set to 0, caching is disabled for this + portlet; if the value is set to -1, the cache does not expire. + <p> + This call is equivalent to calling + <code>setProperty(EXPIRATION_CACHE)</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - expiration time in seconds</dd></dl> +</li> +</ul> +<a name="isPublicScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPublicScope</h4> +<pre>boolean isPublicScope()</pre> +<div class="block">Returns a boolean indicating whether the + caching scope is set to public for the current response. + If no caching scope is set on this response, the default + defined in the deployment descriptor with the + <code>cache-scope</code> tag is returned, + or <code>false</code> if no default is defined. + <p> + Public cache scope indicates that the cache entry can be shared across + users. Non-public, or private cache scope indicates that the cache entry + must not be shared across users. + <p> + This call is equivalent to calling + <code>getProperty(CACHE_SCOPE).equals(PUBLIC_SCOPE)</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the cache scope is public for the + current response.</dd></dl> +</li> +</ul> +<a name="setPublicScope(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPublicScope</h4> +<pre>void setPublicScope(boolean publicScope)</pre> +<div class="block">Sets the caching scope for the current response + to public with <code>true</code> as + <code>publicScope</code> and to private with + <code>false</code> as <code>publicScope</code>. + <p> + Public cache scope indicates that the cache entry can be shared across + users. Non-public, or private cache scope indicates that the cache entry + must not be shared across users. + <p> + This call is equivalent to calling + <code>(publicScope ? setProperty(CACHE_SCOPE, PUBLIC_SCOPE | + setProperty(CACHE_SCOPE, PRIVATE_SCOPE)</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>publicScope</code> - indicating if the cache entry can be shared across users</dd></dl> +</li> +</ul> +<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 ETag for the current response that is + used as validation tag, or <code>null</null> + if no ETag is set on the response. + <p> + This call is equivalent to calling + <code>getProperty(ETAG)</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the ETag for the current response that is + used as validation tag, or <code>null</null> + if no ETag is set.</dd></dl> +</li> +</ul> +<a name="setETag(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setETag</h4> +<pre>void setETag(<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> token)</pre> +<div class="block">Sets an ETag for the current response that is + used as validation tag. If an ETag was already + set it is replaced with the new value. + <p> + This call is equivalent to calling + <code>setProperty(ETAG, token)</code>. + <p> + Setting the ETag to <code>null</code> removes + the currently set ETag.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the ETag token</dd></dl> +</li> +</ul> +<a name="useCachedContent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>useCachedContent</h4> +<pre>boolean useCachedContent()</pre> +<div class="block">Returns a boolean indicating whether the + cached content for the provided ETag at the request + can still be considerated valid. + If not set, the default is <code>false</code>. + <p> + This call is equivalent to calling + <code>getProperty(USE_CACHED_CONTENT)</code> and getting a non-null + value back.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>boolean indicating whether the + caching scope is set to public for the current response</dd></dl> +</li> +</ul> +<a name="setUseCachedContent(boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setUseCachedContent</h4> +<pre>void setUseCachedContent(boolean useCachedContent)</pre> +<div class="block">Sets the indication whether the cached content + for the provided ETag at the request is still valid or not. + If set to <code>true</code> no output should be rendered, + but a new expiration time should be set for the + markup with the given ETag . + <p> + This call is equivalent to calling + <code>setProperty(USE_CACHED_CONTENT, "true")</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>useCachedContent</code> - boolean indication whether the + the cached content is still valid or not</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/CacheControl.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/BaseURL.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ClientDataRequest.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/CacheControl.html" target="_top">Frames</a></li> +<li><a href="CacheControl.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>
