Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ClientDataRequest.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ClientDataRequest.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ClientDataRequest.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ClientDataRequest.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,437 @@ +<!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>ClientDataRequest (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="ClientDataRequest (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/ClientDataRequest.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/CacheControl.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/Event.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/ClientDataRequest.html" target="_top">Frames</a></li> +<li><a href="ClientDataRequest.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 ClientDataRequest" class="title">Interface ClientDataRequest</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a>, <a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</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>, <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">ClientDataRequest</span> +extends <a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></pre> +<div class="block">The <CODE>ClientDataRequest</CODE> represents the request information + of the HTTP request issued from the client to the portal.<BR> + It extends the PortletRequest interface.</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/PortletRequest.html" title="interface in javax.portlet"><code>PortletRequest</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_javax.portlet.PortletRequest"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface javax.portlet.<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet">PortletRequest.P3PUserInfos</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_javax.portlet.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/ClientDataRequest.html#getCharacterEncoding()">getCharacterEncoding</a></strong>()</code> +<div class="block">Returns the name of the character encoding used in the body of this request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ClientDataRequest.html#getContentLength()">getContentLength</a></strong>()</code> +<div class="block">Returns the length, in bytes, of the request body + which is made available by the input stream, or -1 if the + length is not known.</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/ClientDataRequest.html#getContentType()">getContentType</a></strong>()</code> +<div class="block">Returns the MIME type of the body of the request, + or null if the type is not known.</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/ClientDataRequest.html#getMethod()">getMethod</a></strong>()</code> +<div class="block">Returns the name of the HTTP method with which this request was made, + for example, GET, POST, or PUT.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ClientDataRequest.html#getPortletInputStream()">getPortletInputStream</a></strong>()</code> +<div class="block">Retrieves the body of the HTTP request from client to + portal as binary data using + an <CODE>InputStream</CODE>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/BufferedReader.html?is-external=true"; title="class or interface in java.io">BufferedReader</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ClientDataRequest.html#getReader()">getReader</a></strong>()</code> +<div class="block">Retrieves the body of the HTTP request from the client to the portal + as character data using + a <code>BufferedReader</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ClientDataRequest.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> enc)</code> +<div class="block">Overrides the name of the character encoding used in the body of this + request.</div> +</td> +</tr> +</table> +<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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPortletInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletInputStream</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getPortletInputStream() + 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">Retrieves the body of the HTTP request from client to + portal as binary data using + an <CODE>InputStream</CODE>. Either this method or + <a href="../../javax/portlet/ClientDataRequest.html#getReader()"><code>getReader()</code></a> may be called to read the body, but not both. + <p> + For HTTP POST data of type application/x-www-form-urlencoded + this method throws an <code>IllegalStateException</code> + as this data has been already processed by the + portal/portlet-container and is available as request parameters.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an input stream containing the body of the request</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 getReader was already called, or it is a + HTTP POST data of type application/x-www-form-urlencoded</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 an input or output exception occurred</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> enc) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/UnsupportedEncodingException.html?is-external=true"; title="class or interface in java.io">UnsupportedEncodingException</a></pre> +<div class="block">Overrides the name of the character encoding used in the body of this + request. This method must be called prior to reading input + using <a href="../../javax/portlet/ClientDataRequest.html#getReader()"><code>getReader()</code></a> or <a href="../../javax/portlet/ClientDataRequest.html#getPortletInputStream()"><code>getPortletInputStream()</code></a>. + <p> + This method only sets the character set for the Reader that the + <a href="../../javax/portlet/ClientDataRequest.html#getReader()"><code>getReader()</code></a> method returns.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enc</code> - a <code>String</code> containing the name of + the character encoding.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/UnsupportedEncodingException.html?is-external=true"; title="class or interface in java.io">UnsupportedEncodingException</a></code> - if this is not a valid encoding</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 this method is called after + reading request parameters or reading input using + <code>getReader()</code></dd></dl> +</li> +</ul> +<a name="getReader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReader</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/BufferedReader.html?is-external=true"; title="class or interface in java.io">BufferedReader</a> getReader() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/UnsupportedEncodingException.html?is-external=true"; title="class or interface in java.io">UnsupportedEncodingException</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">Retrieves the body of the HTTP request from the client to the portal + as character data using + a <code>BufferedReader</code>. The reader translates the character + data according to the character encoding used on the body. + Either this method or <a href="../../javax/portlet/ClientDataRequest.html#getPortletInputStream()"><code>getPortletInputStream()</code></a> may be called to read the + body, not both. + <p> + For HTTP POST data of type application/x-www-form-urlencoded + this method throws an <code>IllegalStateException</code> + as this data has been already processed by the + portal/portlet-container and is available as request parameters.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>BufferedReader</code> + containing the body of the request</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/UnsupportedEncodingException.html?is-external=true"; title="class or interface in java.io">UnsupportedEncodingException</a></code> - if the character set encoding used is + not supported and the text cannot be decoded</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 <a href="../../javax/portlet/ClientDataRequest.html#getPortletInputStream()"><code>getPortletInputStream()</code></a> method + has been called on this request, it is a + HTTP POST data of type application/x-www-form-urlencoded.</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 an input or output exception occurred</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/ClientDataRequest.html#getPortletInputStream()"><code>getPortletInputStream()</code></a></dd></dl> +</li> +</ul> +<a name="getCharacterEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCharacterEncoding</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> getCharacterEncoding()</pre> +<div class="block">Returns the name of the character encoding used in the body of this request. + This method returns <code>null</code> if the request + does not specify a character encoding.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name of + the character encoding, or <code>null</code> + if the request does not specify a character encoding.</dd></dl> +</li> +</ul> +<a name="getContentType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContentType</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> getContentType()</pre> +<div class="block">Returns the MIME type of the body of the request, + or null if the type is not known.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name + of the MIME type of the request, or null + if the type is not known.</dd></dl> +</li> +</ul> +<a name="getContentLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContentLength</h4> +<pre>int getContentLength()</pre> +<div class="block">Returns the length, in bytes, of the request body + which is made available by the input stream, or -1 if the + length is not known.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an integer containing the length of the + request body or -1 if the length is not known</dd></dl> +</li> +</ul> +<a name="getMethod()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMethod</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> getMethod()</pre> +<div class="block">Returns the name of the HTTP method with which this request was made, + for example, GET, POST, or PUT.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a String specifying the name of the HTTP method with which + this request was made</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/ClientDataRequest.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/CacheControl.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/Event.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/ClientDataRequest.html" target="_top">Frames</a></li> +<li><a href="ClientDataRequest.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/Event.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Event.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Event.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Event.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,258 @@ +<!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>Event (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="Event (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/Event.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/ClientDataRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/EventPortlet.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/Event.html" target="_top">Frames</a></li> +<li><a href="Event.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 Event" class="title">Interface Event</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">Event</span></pre> +<div class="block">The <code>Event</code> interface represents an event that the portlet has received + in the event processing phase. + <p> + The <code>Event</code> interface encapsulates the event name and event payload, + it does not represent the event object itself. + <p> + The portlet must define the events it is able to receive in the portlet deployment + descriptor with the <code>supported-processing-event</code>.</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/EventPortlet.html" title="interface in javax.portlet"><code>EventPortlet</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><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/Event.html#getName()">getName</a></strong>()</code> +<div class="block">Get the local part of the event name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/Event.html#getQName()">getQName</a></strong>()</code> +<div class="block">Get the event QName.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/Event.html#getValue()">getValue</a></strong>()</code> +<div class="block">Get the event payload.</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="getQName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQName</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a> getQName()</pre> +<div class="block">Get the event QName.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the QName of the event, never <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</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> getName()</pre> +<div class="block">Get the local part of the event name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the local part of the event, never <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getValue()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getValue</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a> getValue()</pre> +<div class="block">Get the event payload.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>event payload, must be serializable. + May return <code>null</code> if this event has no payload.</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/Event.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/ClientDataRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/EventPortlet.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/Event.html" target="_top">Frames</a></li> +<li><a href="Event.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/EventPortlet.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventPortlet.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventPortlet.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventPortlet.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,246 @@ +<!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>EventPortlet (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="EventPortlet (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/EventPortlet.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/Event.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/EventRequest.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/EventPortlet.html" target="_top">Frames</a></li> +<li><a href="EventPortlet.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 EventPortlet" class="title">Interface EventPortlet</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">EventPortlet</span></pre> +<div class="block">The <code>EventPortlet</code> interface allows + portlets receiving events. + <p> + Events are part of the action processing and must + be finished before the rendering phase can start. + Portlets can receive events issued by other portlets or + portlet container defined events. + <p> + Portlets should declare the events it would like to receive + via the <code>supported-processing-event</code> tag and events published + via the <code>supported-publishing-event</code> tag in the portlet + deployment descriptor. + <p> + The event model is a loosely coupled model where the wiring between + published and receiving events is done at the portal / portlet container + level.</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/EventPortlet.html#processEvent(javax.portlet.EventRequest,%20javax.portlet.EventResponse)">processEvent</a></strong>(<a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a> request, + <a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</a> response)</code> +<div class="block">Called by the portlet container requesting the portlet + to process a specific event.</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="processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processEvent</h4> +<pre>void processEvent(<a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a> request, + <a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</a> response) + throws <a href="../../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 requesting the portlet + to process a specific event.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the event request</dd><dd><code>response</code> - the event 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 + request</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet is unavailable to process the event 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/EventPortlet.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/Event.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/EventRequest.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/EventPortlet.html" target="_top">Frames</a></li> +<li><a href="EventPortlet.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/EventRequest.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventRequest.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventRequest.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventRequest.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,289 @@ +<!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>EventRequest (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="EventRequest (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/EventRequest.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/EventPortlet.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/EventResponse.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/EventRequest.html" target="_top">Frames</a></li> +<li><a href="EventRequest.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 EventRequest" class="title">Interface EventRequest</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><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/EventRequestWrapper.html" title="class in javax.portlet.filter">EventRequestWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">EventRequest</span> +extends <a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></pre> +<div class="block">The <CODE>EventRequest</CODE> represents the request sent to the portlet + to handle an event. + It extends the PortletRequest interface to provide event request + information to portlets.<br> + The portlet container creates an <CODE>EventRequest</CODE> object and + passes it as argument to the portlet's <CODE>processEvent</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/ActionRequest.html" title="interface in javax.portlet"><code>ActionRequest</code></a>, +<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet"><code>PortletRequest</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_javax.portlet.PortletRequest"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface javax.portlet.<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet">PortletRequest.P3PUserInfos</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_javax.portlet.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="../../javax/portlet/Event.html" title="interface in javax.portlet">Event</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/EventRequest.html#getEvent()">getEvent</a></strong>()</code> +<div class="block">Returns the event that triggered the call to the processEvent method.</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/EventRequest.html#getMethod()">getMethod</a></strong>()</code> +<div class="block">Returns the name of the HTTP method with which the original action request was made, + for example, POST, or PUT.</div> +</td> +</tr> +</table> +<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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getEvent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvent</h4> +<pre><a href="../../javax/portlet/Event.html" title="interface in javax.portlet">Event</a> getEvent()</pre> +<div class="block">Returns the event that triggered the call to the processEvent method.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the event that triggered the current processEvent call.</dd></dl> +</li> +</ul> +<a name="getMethod()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMethod</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> getMethod()</pre> +<div class="block">Returns the name of the HTTP method with which the original action request was made, + for example, POST, or PUT.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a String specifying the name of the HTTP method with which + this request was made</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/EventRequest.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/EventPortlet.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/EventResponse.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/EventRequest.html" target="_top">Frames</a></li> +<li><a href="EventRequest.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/EventResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/EventResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,259 @@ +<!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>EventResponse (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="EventResponse (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/EventResponse.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/EventRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/GenericPortlet.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/EventResponse.html" target="_top">Frames</a></li> +<li><a href="EventResponse.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 EventResponse" class="title">Interface EventResponse</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/EventResponseWrapper.html" title="class in javax.portlet.filter">EventResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">EventResponse</span> +extends <a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></pre> +<div class="block">The <CODE>EventResponse</CODE> interface represents the portlet + response to an event request. + It extends the <CODE>StateAwareResponse</CODE> interface.<br> + The portlet container creates an <CODE>EventResponse</CODE> object and + passes it as argument to the portlet's <CODE>processEvent</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/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></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/EventResponse.html#setRenderParameters(javax.portlet.EventRequest)">setRenderParameters</a></strong>(<a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a> request)</code> +<div class="block">Maintain the current render parameters of the request for + the response.</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="setRenderParameters(javax.portlet.EventRequest)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setRenderParameters</h4> +<pre>void setRenderParameters(<a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a> request)</pre> +<div class="block">Maintain the current render parameters of the request for + the response. + <p> + All previously set render parameters are cleared. + <p> + These parameters will be accessible in all + subsequent render calls via the + <code>PortletRequest.getParameter</code> call until + a new request is targeted to the portlet. + <p> + The given parameters do not need to be encoded + prior to calling this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - The request the portlet has been provided + with by the portlet container for the current + <code>processEvent</code> call, must not be + <code>null</code>.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/EventResponse.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/EventRequest.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/GenericPortlet.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/EventResponse.html" target="_top">Frames</a></li> +<li><a href="EventResponse.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>
