Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/MimeResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/MimeResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/MimeResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/MimeResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,867 @@ +<!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>MimeResponse (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="MimeResponse (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/MimeResponse.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/GenericPortlet.html" title="class in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortalContext.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/MimeResponse.html" target="_top">Frames</a></li> +<li><a href="MimeResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Interface MimeResponse" class="title">Interface MimeResponse</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></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a>, <a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a>, <a href="../../javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">MimeResponse</span> +extends <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></pre> +<div class="block">The <CODE>MimeResponse</CODE> defines the base interface to assist a + portlet in returning MIME content.</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"> +<!-- =========== 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/MimeResponse.html#CACHE_SCOPE">CACHE_SCOPE</a></strong></code> +<div class="block">Property to set the cache scope for this response using the + <code>setProperty</code> method intended to be used in + forwarded or included servlets/JSPs.</div> +</td> +</tr> +<tr class="rowColor"> +<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/MimeResponse.html#ETAG">ETAG</a></strong></code> +<div class="block">Property to tell the portlet container the new ETag for this response + intended to be used in forwarded or included servlets/JSPs.</div> +</td> +</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/MimeResponse.html#EXPIRATION_CACHE">EXPIRATION_CACHE</a></strong></code> +<div class="block">Property to set the expiration time in seconds for this response using + the <code>setProperty</code> method intended to be used in + forwarded or included servlets/JSPs.</div> +</td> +</tr> +<tr class="rowColor"> +<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/MimeResponse.html#MARKUP_HEAD_ELEMENT">MARKUP_HEAD_ELEMENT</a></strong></code> +<div class="block">Property intended to be a hint to the portal application that the provided + DOM element should be added to the markup head section of the response to the + client.</div> +</td> +</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/MimeResponse.html#NAMESPACED_RESPONSE">NAMESPACED_RESPONSE</a></strong></code> +<div class="block">Property intended to be a hint to the portal application that the returned + content is completely namespaced.</div> +</td> +</tr> +<tr class="rowColor"> +<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/MimeResponse.html#PRIVATE_SCOPE">PRIVATE_SCOPE</a></strong></code> +<div class="block">Private cache scope, indicating that the cache entry must not be shared + across users.</div> +</td> +</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/MimeResponse.html#PUBLIC_SCOPE">PUBLIC_SCOPE</a></strong></code> +<div class="block">Public cache scope, indicating that the cache entry can be shared across + users.</div> +</td> +</tr> +<tr class="rowColor"> +<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/MimeResponse.html#USE_CACHED_CONTENT">USE_CACHED_CONTENT</a></strong></code> +<div class="block">Property to tell the portlet container to use the cached markup + for the validation token provided in the request.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#createActionURL()">createActionURL</a></strong>()</code> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#createRenderURL()">createRenderURL</a></strong>()</code> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#createResourceURL()">createResourceURL</a></strong>()</code> +<div class="block">Creates a portlet URL targeting the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#flushBuffer()">flushBuffer</a></strong>()</code> +<div class="block">Forces any content in the buffer to be written to the underlying output stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#getBufferSize()">getBufferSize</a></strong>()</code> +<div class="block">Returns the actual buffer size used for the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/CacheControl.html" title="interface in javax.portlet">CacheControl</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#getCacheControl()">getCacheControl</a></strong>()</code> +<div class="block">Returns the cache control object allowing to set + specific cache settings valid for the markup + returned in this response.</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/MimeResponse.html#getCharacterEncoding()">getCharacterEncoding</a></strong>()</code> +<div class="block">Returns the name of the charset used for the MIME body sent in this + response.</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/MimeResponse.html#getContentType()">getContentType</a></strong>()</code> +<div class="block">Returns the MIME type that can be used to contribute markup to the render + response.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#getLocale()">getLocale</a></strong>()</code> +<div class="block">Returns the locale assigned to the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()">getPortletOutputStream</a></strong>()</code> +<div class="block">Returns a <code>OutputStream</code> suitable for writing binary data in + the response.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#getWriter()">getWriter</a></strong>()</code> +<div class="block">Returns a PrintWriter object that can send character text to the portal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#isCommitted()">isCommitted</a></strong>()</code> +<div class="block">Returns a boolean indicating if the response has been committed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#reset()">reset</a></strong>()</code> +<div class="block">Clears any data that exists in the buffer as well as the properties set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#resetBuffer()">resetBuffer</a></strong>()</code> +<div class="block">Clears the content of the underlying buffer in the response without + clearing properties set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)">setBufferSize</a></strong>(int size)</code> +<div class="block">Sets the preferred buffer size for the body of the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)">setContentType</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> type)</code> +<div class="block">Sets the MIME type for the response.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.PortletResponse"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></h3> +<code><a href="../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty</a>, <a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</a>, <a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</a>, <a href="../../javax/portlet/PortletResponse.html#createElement(java.lang.String)">createElement</a>, <a href="../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)">encodeURL</a>, <a href="../../javax/portlet/PortletResponse.html#getNamespace()">getNamespace</a>, <a href="../../javax/portlet/PortletResponse.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="EXPIRATION_CACHE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXPIRATION_CACHE</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> EXPIRATION_CACHE</pre> +<div class="block">Property to set the expiration time in seconds for this response using + the <code>setProperty</code> method intended to be used in + forwarded or included servlets/JSPs. + <P> + If the expiration value is set to <code>0</code>, caching is disabled for this + portlet; if the value is set to <code>-1</code>, the cache does not expire. + <p> + A default can be defined in the portlet deployment descriptor + with the <code>expiration-cache<code> tag, otherwise it is <code>0</code>. + <p> + Non-integer values are treated as <code>0</code>. + <p> + The value is <code>"portlet.expiration-cache"</code>.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/CacheControl.html" title="interface in javax.portlet"><code>CacheControl</code></a>, +<a href="../../constant-values.html#javax.portlet.MimeResponse.EXPIRATION_CACHE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CACHE_SCOPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CACHE_SCOPE</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> CACHE_SCOPE</pre> +<div class="block">Property to set the cache scope for this response using the + <code>setProperty</code> method intended to be used in + forwarded or included servlets/JSPs. + <P> + Predefined cache scopes are: <code>PUBLIC_SCOPE</code> and <code>PRIVATE_SCOPE</code>. + <p> + A default can be defined in the portlet deployment descriptor + with the <code>cache-scope<code> tag, otherwise it is <code>PRIVATE_SCOPE</code>. + <p> + Values that are not either <code>PUBLIC_SCOPE</code> or <code>PRIVATE_SCOPE</code> + are treated as <code>PRIVATE_SCOPE</code>. + <p> + The value is <code>"portlet.cache-scope"</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/CacheControl.html" title="interface in javax.portlet"><code>CacheControl</code></a>, +<a href="../../constant-values.html#javax.portlet.MimeResponse.CACHE_SCOPE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PUBLIC_SCOPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PUBLIC_SCOPE</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> PUBLIC_SCOPE</pre> +<div class="block">Public cache scope, indicating that the cache entry can be shared across + users. The value is <code>"portlet.public-scope"</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="../../constant-values.html#javax.portlet.MimeResponse.PUBLIC_SCOPE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PRIVATE_SCOPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PRIVATE_SCOPE</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> PRIVATE_SCOPE</pre> +<div class="block">Private cache scope, indicating that the cache entry must not be shared + across users. The value is <code>"portlet.private-scope"</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="../../constant-values.html#javax.portlet.MimeResponse.PRIVATE_SCOPE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ETAG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ETAG</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ETAG</pre> +<div class="block">Property to tell the portlet container the new ETag for this response + intended to be used in forwarded or included servlets/JSPs. + <p> + This property needs to be set using the <code>setProperty</code> method. + <P> + The value is <code>"portlet.ETag "</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/CacheControl.html" title="interface in javax.portlet"><code>CacheControl</code></a>, +<a href="../../constant-values.html#javax.portlet.MimeResponse.ETAG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="USE_CACHED_CONTENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>USE_CACHED_CONTENT</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> USE_CACHED_CONTENT</pre> +<div class="block">Property to tell the portlet container to use the cached markup + for the validation token provided in the request. This property + needs to be set using the <code>setProperty</code> method with a non-null + value and is intended to be used in forwarded or included servlets/JSPs. + The value itself is not evaluated. + <P> + The value is <code>"portlet.use-cached-content "</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/CacheControl.html" title="interface in javax.portlet"><code>CacheControl</code></a>, +<a href="../../constant-values.html#javax.portlet.MimeResponse.USE_CACHED_CONTENT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="NAMESPACED_RESPONSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NAMESPACED_RESPONSE</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> NAMESPACED_RESPONSE</pre> +<div class="block">Property intended to be a hint to the portal application that the returned + content is completely namespaced. + This includes all markup id elements, form fields, etc. + One example where this is might be used is for portal applications that + are form-based and thus need to re-write any forms included in the portlet + markup. + <p> + This property needs to be set using the <code>setProperty</code> method with a non-null + value. The value itself is not evaluated. + <p> + The value is <code>"X-JAVAX-PORTLET-NAMESPACED-RESPONSE"</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="../../constant-values.html#javax.portlet.MimeResponse.NAMESPACED_RESPONSE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MARKUP_HEAD_ELEMENT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MARKUP_HEAD_ELEMENT</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> MARKUP_HEAD_ELEMENT</pre> +<div class="block">Property intended to be a hint to the portal application that the provided + DOM element should be added to the markup head section of the response to the + client. + <p> + Support for this property is optional and the portlet can verify if the + calling portal supports this property via the <code>MARKUP_HEAD_ELEMENT_SUPPORT</code> + property on the <code>PortalContext</code>. + <p> + Even if the calling portal support this property delivery of the DOM + element to the client cannot be guaranteed, e.g. due to possible security + rules of the portal application or elements that conflict with the + response of other portlets. + <p> + This property needs to be set using the + <code>setProperty(String key,org.w3c.dom.Element element)</code> + method. + <p> + The value is <code>"javax.portlet.markup.head.element"</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="../../constant-values.html#javax.portlet.MimeResponse.MARKUP_HEAD_ELEMENT">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="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 that can be used to contribute markup to the render + response. + <p> + If no content type was set previously using the <a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>setContentType(java.lang.String)</code></a> + method this method returns <code>null</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the MIME type of the response, or <code>null</code> if no + content type is set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>setContentType(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="setContentType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContentType</h4> +<pre>void setContentType(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> type)</pre> +<div class="block">Sets the MIME type for the response. The portlet should set the + content type before calling <a href="../../javax/portlet/MimeResponse.html#getWriter()"><code>getWriter()</code></a> or + <a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()"><code>getPortletOutputStream()</code></a>. If the content type is not + the <a href="../../javax/portlet/PortletRequest.html#getResponseContentType()"><code>PortletRequest.getResponseContentType()</code></a> value is + set as response content type by the portlet container. + <p> + Calling <code>setContentType</code> after <code>getWriter</code> or + <code>getOutputStream</code> does not change the content type. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the content MIME type</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#getResponseContentTypes()"><code>PortletRequest.getResponseContentTypes()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getContentType()"><code>getContentType()</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 charset used for the MIME body sent in this + response. + + <p> + See <a href="http://ds.internic.net/rfc/rfc2045.txt";>RFC 2047</a> for + more information about character encoding and MIME.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the name of the charset, for + example, <code>ISO-8859-1</code></dd></dl> +</li> +</ul> +<a name="getWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriter</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> getWriter() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Returns a PrintWriter object that can send character text to the portal. + <p> + Before calling this method the content type of the render response should + be set using the <a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>setContentType(java.lang.String)</code></a> method. + <p> + Either this method or <a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()"><code>getPortletOutputStream()</code></a> may be called to + write the body, not both.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>PrintWriter</code> object that can return character + data to the portal</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an input or output exception occurred</dd> +<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 <code>getPortletOutputStream</code> method has + been called on this response.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>setContentType(java.lang.String)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getPortletOutputStream()"><code>getPortletOutputStream()</code></a></dd></dl> +</li> +</ul> +<a name="getLocale()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocale</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> getLocale()</pre> +<div class="block">Returns the locale assigned to the response.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Locale of this response</dd></dl> +</li> +</ul> +<a name="setBufferSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBufferSize</h4> +<pre>void setBufferSize(int size)</pre> +<div class="block">Sets the preferred buffer size for the body of the response. The portlet + container will use a buffer at least as large as the size requested. + <p> + This method must be called before any response body content is written; + if content has been written, or the portlet container does not support + buffering, this method may throw an <code>IllegalStateException</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - the preferred buffer size</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 this method is called after content has been written, + or the portlet container does not support buffering</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#getBufferSize()"><code>getBufferSize()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#flushBuffer()"><code>flushBuffer()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#isCommitted()"><code>isCommitted()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#reset()"><code>reset()</code></a></dd></dl> +</li> +</ul> +<a name="getBufferSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBufferSize</h4> +<pre>int getBufferSize()</pre> +<div class="block">Returns the actual buffer size used for the response. If no buffering is + used, this method returns 0.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the actual buffer size used</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>setBufferSize(int)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#flushBuffer()"><code>flushBuffer()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#isCommitted()"><code>isCommitted()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#reset()"><code>reset()</code></a></dd></dl> +</li> +</ul> +<a name="flushBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flushBuffer</h4> +<pre>void flushBuffer() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Forces any content in the buffer to be written to the underlying output stream. A call to + this method automatically commits the response.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an error occurred when writing the output</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>setBufferSize(int)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getBufferSize()"><code>getBufferSize()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#isCommitted()"><code>isCommitted()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#reset()"><code>reset()</code></a></dd></dl> +</li> +</ul> +<a name="resetBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetBuffer</h4> +<pre>void resetBuffer()</pre> +<div class="block">Clears the content of the underlying buffer in the response without + clearing properties set. If the response has been committed, this method + throws an <code>IllegalStateException</code>.</div> +<dl><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 this method is called after response is committed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>setBufferSize(int)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getBufferSize()"><code>getBufferSize()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#isCommitted()"><code>isCommitted()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#reset()"><code>reset()</code></a></dd></dl> +</li> +</ul> +<a name="isCommitted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCommitted</h4> +<pre>boolean isCommitted()</pre> +<div class="block">Returns a boolean indicating if the response has been committed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a boolean indicating if the response has been committed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>setBufferSize(int)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getBufferSize()"><code>getBufferSize()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#flushBuffer()"><code>flushBuffer()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#reset()"><code>reset()</code></a></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>void reset()</pre> +<div class="block">Clears any data that exists in the buffer as well as the properties set. + If the response has been committed, this method throws an + <code>IllegalStateException</code>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the response has already been committed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/MimeResponse.html#setBufferSize(int)"><code>setBufferSize(int)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getBufferSize()"><code>getBufferSize()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#flushBuffer()"><code>flushBuffer()</code></a>, +<a href="../../javax/portlet/MimeResponse.html#isCommitted()"><code>isCommitted()</code></a></dd></dl> +</li> +</ul> +<a name="getPortletOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletOutputStream</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> getPortletOutputStream() + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Returns a <code>OutputStream</code> suitable for writing binary data in + the response. The portlet container does not encode the binary data. + <p> + Before calling this method the content type of the render response must + be set using the <a href="../../javax/portlet/MimeResponse.html#setContentType(java.lang.String)"><code>setContentType(java.lang.String)</code></a> method. + <p> + Calling <code>flush()</code> on the OutputStream commits the response. + <p> + Either this method or <a href="../../javax/portlet/MimeResponse.html#getWriter()"><code>getWriter()</code></a> may be called to write the body, + not both.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>OutputStream</code> for writing binary data</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the <code>getWriter</code> method has been called on + this response.</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/MimeResponse.html#setContentType(java.lang.String)"><code>setContentType(java.lang.String)</code></a>, +<a href="../../javax/portlet/MimeResponse.html#getWriter()"><code>getWriter()</code></a></dd></dl> +</li> +</ul> +<a name="createRenderURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRenderURL</h4> +<pre><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> createRenderURL()</pre> +<div class="block">Creates a portlet URL targeting the portlet. If no portlet mode, window + state or security modifier is set in the PortletURL the current values + are preserved. If a request is triggered by the PortletURL, it results in + a render request. + <p> + The returned URL can be further extended by adding portlet-specific + parameters and portlet modes and window states. + <p> + The created URL will per default not contain any parameters of the + current render request.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a portlet render URL</dd></dl> +</li> +</ul> +<a name="createActionURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createActionURL</h4> +<pre><a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> createActionURL()</pre> +<div class="block">Creates a portlet URL targeting the portlet. If no portlet mode, window + state or security modifier is set in the PortletURL the current values + are preserved. If a request is triggered by the PortletURL, it results in + an action request. + <p> + The returned URL can be further extended by adding portlet-specific + parameters and portlet modes and window states. + <p> + The created URL will per default not contain any parameters of the + current render request.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a portlet action URL</dd></dl> +</li> +</ul> +<a name="createResourceURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createResourceURL</h4> +<pre><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a> createResourceURL()</pre> +<div class="block">Creates a portlet URL targeting the portlet. If no security modifier is + set in the PortletURL the current values are preserved. The current + render parameters, portlet mode and window state are preserved. + <p> + If a request is triggered by the PortletURL, it results in a serve + resource request of the <code>ResourceServingPortlet</code> interface. + <p> + The returned URL can be further extended by adding portlet-specific + parameters . + <p> + The created URL will per default contain the current + cacheability setting of the parent resource. + If no parent resource is available, <code>PAGE</code> is the default.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a portlet resource URL</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getCacheControl()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCacheControl</h4> +<pre><a href="../../javax/portlet/CacheControl.html" title="interface in javax.portlet">CacheControl</a> getCacheControl()</pre> +<div class="block">Returns the cache control object allowing to set + specific cache settings valid for the markup + returned in this response.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Cache control for the current response.</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/MimeResponse.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/GenericPortlet.html" title="class in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortalContext.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/MimeResponse.html" target="_top">Frames</a></li> +<li><a href="MimeResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortalContext.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortalContext.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortalContext.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortalContext.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,363 @@ +<!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>PortalContext (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="PortalContext (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/PortalContext.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/MimeResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/Portlet.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/PortalContext.html" target="_top">Frames</a></li> +<li><a href="PortalContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Interface PortalContext" class="title">Interface PortalContext</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">PortalContext</span></pre> +<div class="block">The <CODE>PortalContext</CODE> interface gives the portlet + the ability to retrieve information about the portal calling this portlet. + <p> + The portlet can only read the <CODE>PortalContext</CODE> data.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortalContext.html#MARKUP_HEAD_ELEMENT_SUPPORT">MARKUP_HEAD_ELEMENT_SUPPORT</a></strong></code> +<div class="block">Property indicating if the portal application supports the + <code>MimeResponse</code> property <code>MARKUP_HEAD_ELEMENT</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortalContext.html#getPortalInfo()">getPortalInfo</a></strong>()</code> +<div class="block">Returns information about the portal like vendor, version, etc.</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/PortalContext.html#getProperty(java.lang.String)">getProperty</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)</code> +<div class="block">Returns the portal property with the given name, + or a <code>null</code> if there is + no property by that name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortalContext.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">Returns all portal property names, or an empty + <code>Enumeration</code> if there are no property names.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortalContext.html#getSupportedPortletModes()">getSupportedPortletModes</a></strong>()</code> +<div class="block">Returns all supported portlet modes by the portal + as an enumeration of <code>PortletMode</code> objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortalContext.html#getSupportedWindowStates()">getSupportedWindowStates</a></strong>()</code> +<div class="block">Returns all supported window states by the portal + as an enumeration of <code>WindowState</code> objects.</div> +</td> +</tr> +</table> +</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="MARKUP_HEAD_ELEMENT_SUPPORT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MARKUP_HEAD_ELEMENT_SUPPORT</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> MARKUP_HEAD_ELEMENT_SUPPORT</pre> +<div class="block">Property indicating if the portal application supports the + <code>MimeResponse</code> property <code>MARKUP_HEAD_ELEMENT</code>. + <p> + A non-null value indicates that the portal application supports + the <code>MARKUP_HEAD_ELEMENT</code> property. + <p> + The value is <code>"javax.portlet.markup.head.element.support"</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="../../constant-values.html#javax.portlet.PortalContext.MARKUP_HEAD_ELEMENT_SUPPORT">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperty</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> getProperty(<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)</pre> +<div class="block">Returns the portal property with the given name, + or a <code>null</code> if there is + no property by that name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - property name</dd> +<dt><span class="strong">Returns:</span></dt><dd>portal property with key <code>name</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 name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getPropertyNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getPropertyNames()</pre> +<div class="block">Returns all portal property names, or an empty + <code>Enumeration</code> if there are no property names.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>All portal property names as an + <code>Enumeration</code> of <code>String</code> objects</dd></dl> +</li> +</ul> +<a name="getSupportedPortletModes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedPortletModes</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a>> getSupportedPortletModes()</pre> +<div class="block">Returns all supported portlet modes by the portal + as an enumeration of <code>PortletMode</code> objects. + <p> + The portlet modes must at least include the + standard portlet modes <code>EDIT, HELP, VIEW</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>All supported portal modes by the portal + as an enumeration of <code>PortletMode</code> objects.</dd></dl> +</li> +</ul> +<a name="getSupportedWindowStates()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedWindowStates</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a>> getSupportedWindowStates()</pre> +<div class="block">Returns all supported window states by the portal + as an enumeration of <code>WindowState</code> objects. + <p> + The window states must at least include the + standard window states <code> MINIMIZED, NORMAL, MAXIMIZED</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>All supported window states by the portal + as an enumeration of <code>WindowState</code> objects.</dd></dl> +</li> +</ul> +<a name="getPortalInfo()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPortalInfo</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> getPortalInfo()</pre> +<div class="block">Returns information about the portal like vendor, version, etc. + <p> + The form of the returned string is <I>servername/versionnumber</I>. For + example, the reference implementation Pluto may return the string + <CODE>Pluto/1.0</CODE>. + <p> + The portlet container may return other optional information after the + primary string in parentheses, for example, <CODE>Pluto/1.0 + (JDK 1.3.1; Windows NT 4.0 x86)</CODE>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <CODE>String</CODE> containing at least the portal name and version number</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/PortalContext.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/MimeResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/Portlet.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/PortalContext.html" target="_top">Frames</a></li> +<li><a href="PortalContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Portlet.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Portlet.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Portlet.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/Portlet.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,375 @@ +<!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>Portlet (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="Portlet (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/Portlet.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/PortalContext.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletConfig.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/Portlet.html" target="_top">Frames</a></li> +<li><a href="Portlet.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 Portlet" class="title">Interface Portlet</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">Portlet</span></pre> +<div class="block">The <CODE>Portlet</CODE> interface is used by the portlet container to + invoke the portlets. Every portlet has to implement this interface, + either by directly implementing it, or by using an existing class + implementing the Portlet interface. + <P> + A portlet is a Java technology-based web component. It is managed by the portlet container and + processes requests and generates dynamic content as response. Portlets are used by portals as + pluggable user interface components. + <p> + The content generated by a portlet is called a fragment. A fragment is a piece of + markup (e.g. HTML, XHTML, WML) adhering to certain rules and can be aggregated + with other fragments into a complete document. The content of a portlet is normally + aggregated with the content of other portlets into the portal page. + <P> + The portlet container instantiates portlets, manages their lifecycle + and invoking them to process requests. The lifecycle consists of: + <ul> + <li>initializing the portlet using using the <code>init</code> method + <li>request processsing + <li>taking the portlet out of service using the <code>destroy</code> method + </ul> + <p> + Request processing is divided into two types: + <ul> + <li>action requests handled through the <code>processAction</code> method, + to perform actions targeted to the portlet + <li>render requests handled through the <code>render</code> method, + to perform the render operation + </ul></div> +</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/Portlet.html#destroy()">destroy</a></strong>()</code> +<div class="block">Called by the portlet container to indicate to a portlet that the + portlet is being taken out of service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/Portlet.html#init(javax.portlet.PortletConfig)">init</a></strong>(<a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a> config)</code> +<div class="block">Called by the portlet container to indicate to a portlet that the + portlet is being placed into service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/Portlet.html#processAction(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse)">processAction</a></strong>(<a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a> request, + <a href="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a> response)</code> +<div class="block">Called by the portlet container to allow the portlet to process + an action request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/Portlet.html#render(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">render</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Called by the portlet container to allow the portlet to generate + the content of the response based on its current state.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(javax.portlet.PortletConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</a> config) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<div class="block">Called by the portlet container to indicate to a portlet that the + portlet is being placed into service. + + <p>The portlet container calls the <code>init</code> + method exactly once after instantiating the portlet. + The <code>init</code> method must complete successfully + before the portlet can receive any requests. + + <p>The portlet container cannot place the portlet into service + if the <code>init</code> method + <ol> + <li>Throws a <code>PortletException</code> + <li>Does not return within a time period defined by the portlet container. + </ol></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - a <code>PortletConfig</code> object + containing the portlet's + configuration and initialization parameters</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 an exception has occurred that + interferes with the portlet's normal + operation.</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet cannot perform the initialization at this time.</dd></dl> +</li> +</ul> +<a name="processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processAction</h4> +<pre>void processAction(<a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a> request, + <a href="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Called by the portlet container to allow the portlet to process + an action request. This method is called if the client request was + originated by a URL created (by the portlet) with the + <code>RenderResponse.createActionURL()</code> method. + <p> + Typically, in response to an action request, a portlet updates state + based on the information sent in the action request parameters. + In an action the portlet may: + <ul> + <li>issue a redirect + <li>change its window state + <li>change its portlet mode + <li>modify its persistent state + <li>set render parameters + </ul> + <p> + A client request triggered by an action URL translates into one + action request and many render requests, one per portlet in the portal page. + The action processing must be finished before the render requests + can be issued.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the action request</dd><dd><code>response</code> - the action 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 action 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> +<a name="render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>render</h4> +<pre>void render(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Called by the portlet container to allow the portlet to generate + the content of the response based on its current state.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the render request</dd><dd><code>response</code> - the render response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the portlet has problems fulfilling the + rendering request</dd> +<dd><code><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</a></code> - if the portlet is unavailable to perform render at this time</dd> +<dd><code><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</a></code> - if the portlet cannot fullfill this request because of security reasons</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the streaming causes an I/O problem</dd></dl> +</li> +</ul> +<a name="destroy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>destroy</h4> +<pre>void destroy()</pre> +<div class="block">Called by the portlet container to indicate to a portlet that the + portlet is being taken out of service. + <p> + Before the portlet container calls the destroy method, it should + allow any threads that are currently processing requests within + the portlet object to complete execution. To avoid + waiting forever, the portlet container can optionally wait for + a predefined time before destroying the portlet object. + + <p>This method enables the portlet to do the following: + <ul> + <li>clean up any resources that it holds (for example, memory, + file handles, threads) + <li>make sure that any persistent state is + synchronized with the portlet current state in memory. + </ul></div> +</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/Portlet.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/PortalContext.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletConfig.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/Portlet.html" target="_top">Frames</a></li> +<li><a href="Portlet.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>
