Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSession.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSession.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSession.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSession.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,776 @@ +<!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>PortletSession (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="PortletSession (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/PortletSession.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/PortletSecurityException.html" title="class in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletSessionUtil.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/PortletSession.html" target="_top">Frames</a></li> +<li><a href="PortletSession.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 PortletSession" class="title">Interface PortletSession</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">PortletSession</span></pre> +<div class="block">The <CODE>PortletSession</CODE> interface provides a way to identify a user + across more than one request and to store transient information about that user. + <p> + A <code>PortletSession</code> is created per user client per portlet application. + <p> + A portlet can bind an object attribute into a <code>PortletSession</code> by name. + The <code>PortletSession</code> interface defines two scopes for storing objects: + <ul> + <li><code>APPLICATION_SCOPE</code> + <li><code>PORTLET_SCOPE</code> + </ul> + All objects stored in the session using the <code>APPLICATION_SCOPE</code> + must be available to all the portlets, servlets and + JSPs that belongs to the same portlet application and that handles a + request identified as being a part of the same session. + Objects stored in the session using the <code>PORTLET_SCOPE</code> must be + available to the portlet during requests for the same portlet window + that the objects where stored from. Attributes stored in the + <code>PORTLET_SCOPE</code> are not protected from other web components + of the portlet application. They are just conveniently namespaced. + <P> + The portlet session is based on the <code>HttpSession</code>. Therefore all + <code>HttpSession</code> listeners do apply to the portlet session and + attributes set in the portlet session are visible in the <code>HttpSession</code> + and vice versa.</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 int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#APPLICATION_SCOPE">APPLICATION_SCOPE</a></strong></code> +<div class="block">This constant defines an application wide scope for the session attribute.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#PORTLET_SCOPE">PORTLET_SCOPE</a></strong></code> +<div class="block">This constant defines the scope of the session attribute to be + private to the portlet and its included resources.</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/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getAttribute(java.lang.String)">getAttribute</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 object bound with the specified name in this session + under the <code>PORTLET_SCOPE</code>, or <code>null</code> if no + object is bound under the name in that scope.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getAttribute(java.lang.String,%20int)">getAttribute</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, + int scope)</code> +<div class="block">Returns the object bound with the specified name in this session, + or <code>null</code> if no object is bound under the name in the given scope.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the session attributes in + the portlet session scope.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getAttributeMap(int)">getAttributeMap</a></strong>(int scope)</code> +<div class="block">Returns a <code>Map</code> of the session attributes in + the given session scope.</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/PortletSession.html#getAttributeNames()">getAttributeNames</a></strong>()</code> +<div class="block">Returns an <code>Enumeration</code> of String objects containing the names of + all the objects bound to this session under the <code>PORTLET_SCOPE</code>, or an + empty <code>Enumeration</code> if no attributes are available.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getAttributeNames(int)">getAttributeNames</a></strong>(int scope)</code> +<div class="block">Returns an <code>Enumeration</code> of String objects containing the names of + all the objects bound to this session in the given scope, or an + empty <code>Enumeration</code> if no attributes are available in the + given scope.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getCreationTime()">getCreationTime</a></strong>()</code> +<div class="block">Returns the time when this session was created, measured in + milliseconds since midnight January 1, 1970 GMT.</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/PortletSession.html#getId()">getId</a></strong>()</code> +<div class="block">Returns a string containing the unique identifier assigned to this session.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getLastAccessedTime()">getLastAccessedTime</a></strong>()</code> +<div class="block">Returns the last time the client sent a request associated with this session, + as the number of milliseconds since midnight January 1, 1970 GMT.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getMaxInactiveInterval()">getMaxInactiveInterval</a></strong>()</code> +<div class="block">Returns the maximum time interval, in seconds, for which the portlet container + keeps this session open between client accesses.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#getPortletContext()">getPortletContext</a></strong>()</code> +<div class="block">Returns the portlet application context associated with this session.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#invalidate()">invalidate</a></strong>()</code> +<div class="block">Invalidates this session (all scopes) and unbinds any objects bound to it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#isNew()">isNew</a></strong>()</code> +<div class="block">Returns true if the client does not yet know about the session or + if the client chooses not to join the session.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#removeAttribute(java.lang.String)">removeAttribute</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">Removes the object bound with the specified name under + the <code>PORTLET_SCOPE</code> from + this session.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#removeAttribute(java.lang.String,%20int)">removeAttribute</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, + int scope)</code> +<div class="block">Removes the object bound with the specified name and the given scope from + this session.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Binds an object to this session under the <code>PORTLET_SCOPE</code>, using the name specified.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#setAttribute(java.lang.String,%20java.lang.Object,%20int)">setAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + int scope)</code> +<div class="block">Binds an object to this session in the given scope, using the name specified.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSession.html#setMaxInactiveInterval(int)">setMaxInactiveInterval</a></strong>(int interval)</code> +<div class="block">Specifies the time, in seconds, between client requests, before the + portlet container invalidates this session.</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="APPLICATION_SCOPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>APPLICATION_SCOPE</h4> +<pre>static final int APPLICATION_SCOPE</pre> +<div class="block">This constant defines an application wide scope for the session attribute. + <code>APPLICATION_SCOPE</code> session attributes enable Portlets + within one portlet application to share data. + <p> + Portlets may need to prefix attributes set in this scope with some + ID, to avoid overwriting each other's attributes in the + case where two portlets of the same portlet definition + are created. + <p> + Value: <code>0x01</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletSession.APPLICATION_SCOPE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PORTLET_SCOPE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PORTLET_SCOPE</h4> +<pre>static final int PORTLET_SCOPE</pre> +<div class="block">This constant defines the scope of the session attribute to be + private to the portlet and its included resources. + <p> + Value: <code>0x02</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletSession.PORTLET_SCOPE">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="getAttribute(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttribute</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getAttribute(<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 object bound with the specified name in this session + under the <code>PORTLET_SCOPE</code>, or <code>null</code> if no + object is bound under the name in that scope.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the object</dd> +<dt><span class="strong">Returns:</span></dt><dd>the object with the specified name for + the <code>PORTLET_SCOPE</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/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if this method is called on an + invalidated session.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getAttribute(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttribute</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getAttribute(<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, + int scope)</pre> +<div class="block">Returns the object bound with the specified name in this session, + or <code>null</code> if no object is bound under the name in the given scope.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the object</dd><dd><code>scope</code> - session scope of this attribute</dd> +<dt><span class="strong">Returns:</span></dt><dd>the object with the specified name</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 on an + invalidated session, or the scope is unknown to the container.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getAttributeNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttributeNames</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>> getAttributeNames()</pre> +<div class="block">Returns an <code>Enumeration</code> of String objects containing the names of + all the objects bound to this session under the <code>PORTLET_SCOPE</code>, or an + empty <code>Enumeration</code> if no attributes are available.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of + <code>String</code> objects specifying the + names of all the objects bound to + this session, or an empty <code>Enumeration</code> + if no attributes are available.</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 on an + invalidated session</dd></dl> +</li> +</ul> +<a name="getAttributeNames(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttributeNames</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>> getAttributeNames(int scope)</pre> +<div class="block">Returns an <code>Enumeration</code> of String objects containing the names of + all the objects bound to this session in the given scope, or an + empty <code>Enumeration</code> if no attributes are available in the + given scope.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - session scope of the attribute names</dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of + <code>String</code> objects specifying the + names of all the objects bound to + this session, or an empty <code>Enumeration</code> + if no attributes are available in the given scope.</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 on an + invalidated session, or the scope is unknown to the container.</dd></dl> +</li> +</ul> +<a name="getCreationTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationTime</h4> +<pre>long getCreationTime()</pre> +<div class="block">Returns the time when this session was created, measured in + milliseconds since midnight January 1, 1970 GMT.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>long</code> specifying + when this session was created, + expressed in + milliseconds since 1/1/1970 GMT</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 on an + invalidated session</dd></dl> +</li> +</ul> +<a name="getId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</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> getId()</pre> +<div class="block">Returns a string containing the unique identifier assigned to this session.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a string specifying the identifier + assigned to this session</dd></dl> +</li> +</ul> +<a name="getLastAccessedTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastAccessedTime</h4> +<pre>long getLastAccessedTime()</pre> +<div class="block">Returns the last time the client sent a request associated with this session, + as the number of milliseconds since midnight January 1, 1970 GMT. + + <p>Actions that your portlet takes, such as getting or setting + a value associated with the session, do not affect the access + time.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>long</code> + representing the last time + the client sent a request associated + with this session, expressed in + milliseconds since 1/1/1970 GMT</dd></dl> +</li> +</ul> +<a name="getMaxInactiveInterval()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxInactiveInterval</h4> +<pre>int getMaxInactiveInterval()</pre> +<div class="block">Returns the maximum time interval, in seconds, for which the portlet container + keeps this session open between client accesses. After this interval, + the portlet container invalidates the session. The maximum time + interval can be set + with the <code>setMaxInactiveInterval</code> method. + A negative time indicates the session should never timeout.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the number of + seconds this session remains open + between client requests</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletSession.html#setMaxInactiveInterval(int)"><code>setMaxInactiveInterval(int)</code></a></dd></dl> +</li> +</ul> +<a name="invalidate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invalidate</h4> +<pre>void invalidate()</pre> +<div class="block">Invalidates this session (all scopes) and unbinds any objects bound to it. + <p> + Invalidating the portlet session will result in invalidating the underlying + <code>HttpSession</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 on a + session which has already been invalidated</dd></dl> +</li> +</ul> +<a name="isNew()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNew</h4> +<pre>boolean isNew()</pre> +<div class="block">Returns true if the client does not yet know about the session or + if the client chooses not to join the session.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the + server has created a session, + but the client has not joined yet.</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 on a + session which has already been invalidated</dd></dl> +</li> +</ul> +<a name="removeAttribute(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeAttribute</h4> +<pre>void removeAttribute(<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">Removes the object bound with the specified name under + the <code>PORTLET_SCOPE</code> from + this session. If the session does not have an object + bound with the specified name, this method does nothing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the object to be + removed from this session in the + <code> PORTLET_SCOPE</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/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if this method is called on a + session which has been invalidated</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="removeAttribute(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeAttribute</h4> +<pre>void removeAttribute(<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, + int scope)</pre> +<div class="block">Removes the object bound with the specified name and the given scope from + this session. If the session does not have an object + bound with the specified name, this method does nothing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the object to be + removed from this session</dd><dd><code>scope</code> - session scope of this attribute</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 on a + session which has been invalidated</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="setAttribute(java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAttribute</h4> +<pre>void setAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Binds an object to this session under the <code>PORTLET_SCOPE</code>, using the name specified. + If an object of the same name in this scope is already bound to the session, + that object is replaced. + + <p>After this method has been executed, and if the new object + implements <code>HttpSessionBindingListener</code>, + the container calls + <code>HttpSessionBindingListener.valueBound</code>. The container then + notifies any <code>HttpSessionAttributeListeners</code> in the web + application. + <p>If an object was already bound to this session + that implements <code>HttpSessionBindingListener</code>, its + <code>HttpSessionBindingListener.valueUnbound</code> method is called. + + <p>If the value is <code>null</code>, this has the same effect as calling + <code>removeAttribute()</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to which the object is bound under + the <code>PORTLET_SCOPE</code>; + this cannot be <code>null</code>.</dd><dd><code>value</code> - the object to be bound</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 on a + session which has been invalidated</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="setAttribute(java.lang.String, java.lang.Object, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAttribute</h4> +<pre>void setAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + int scope)</pre> +<div class="block">Binds an object to this session in the given scope, using the name specified. + If an object of the same name in this scope is already bound to the session, + that object is replaced. + + <p>After this method has been executed, and if the new object + implements <code>HttpSessionBindingListener</code>, + the container calls + <code>HttpSessionBindingListener.valueBound</code>. The container then + notifies any <code>HttpSessionAttributeListeners</code> in the web + application. + <p>If an object was already bound to this session + that implements <code>HttpSessionBindingListener</code>, its + <code>HttpSessionBindingListener.valueUnbound</code> method is called. + + <p>If the value is <code>null</code>, this has the same effect as calling + <code>removeAttribute()</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to which the object is bound; + this cannot be <code>null</code>.</dd><dd><code>value</code> - the object to be bound</dd><dd><code>scope</code> - session scope of this attribute</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 on a + session which has been invalidated</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code> or scope is unknown to the container.</dd></dl> +</li> +</ul> +<a name="setMaxInactiveInterval(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxInactiveInterval</h4> +<pre>void setMaxInactiveInterval(int interval)</pre> +<div class="block">Specifies the time, in seconds, between client requests, before the + portlet container invalidates this session. A negative time + indicates the session should never timeout.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - An integer specifying the number + of seconds</dd></dl> +</li> +</ul> +<a name="getPortletContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletContext</h4> +<pre><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a> getPortletContext()</pre> +<div class="block">Returns the portlet application context associated with this session.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet application context</dd></dl> +</li> +</ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> getAttributeMap()</pre> +<div class="block">Returns a <code>Map</code> of the session attributes in + the portlet session scope. + <p> + The keys are of type <code>String</code> and the values in the + returned <code>Map</code> are from type <code>Object</code>. + <p> + If no session attributes exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing the session attributes in the + portlet session scope as keys and attribute values as map values, or an empty <code>Map</code> + if no session attributes exist. The keys in the + map are of type String, the values of type + Object.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getAttributeMap(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> getAttributeMap(int scope)</pre> +<div class="block">Returns a <code>Map</code> of the session attributes in + the given session scope. + <p> + The keys are of type <code>String</code> and the values in the + returned <code>Map</code> are from type <code>Object</code>. + <p> + If no session attributes exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - session scope of this attribute</dd> +<dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing the session attributes in the + given scope as keys and attribute values as map values, or an empty <code>Map</code> + if no session attributes exist. The keys in the + map are of type String, the values of type + Object.</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/PortletSession.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/PortletSecurityException.html" title="class in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletSessionUtil.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/PortletSession.html" target="_top">Frames</a></li> +<li><a href="PortletSession.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/PortletSessionUtil.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSessionUtil.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSessionUtil.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSessionUtil.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,297 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PortletSessionUtil (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="PortletSessionUtil (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/PortletSessionUtil.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/PortletSession.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletURL.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/PortletSessionUtil.html" target="_top">Frames</a></li> +<li><a href="PortletSessionUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Class PortletSessionUtil" class="title">Class PortletSessionUtil</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.PortletSessionUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">PortletSessionUtil</span> +extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">The <CODE>PortletSessionUtil</CODE> class helps identify and decode + attributes in the <CODE>PORTLET_SCOPE</CODE> scope of the PortletSession + when accessed through the HttpSession an from within calls to methods + of the HttpSessionBindingListener interface.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/PortletSessionUtil.html#PortletSessionUtil()">PortletSessionUtil</a></strong>()</code> </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>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/PortletSessionUtil.html#decodeAttributeName(java.lang.String)">decodeAttributeName</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 attribute name of an attribute in the + <code>PORTLET_SCOPE</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletSessionUtil.html#decodeScope(java.lang.String)">decodeScope</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 portlet attribute scope from an encoded portlet + attribute.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PortletSessionUtil()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PortletSessionUtil</h4> +<pre>public PortletSessionUtil()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="decodeAttributeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeAttributeName</h4> +<pre>public 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> decodeAttributeName(<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 attribute name of an attribute in the + <code>PORTLET_SCOPE</code>. If the attribute is in the + <code>APPLICATION_SCOPE</code> it returns the attribute name unchanged.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the + encoded portlet attribute</dd> +<dt><span class="strong">Returns:</span></dt><dd>the decoded attribute name</dd></dl> +</li> +</ul> +<a name="decodeScope(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decodeScope</h4> +<pre>public static int decodeScope(<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 portlet attribute scope from an encoded portlet + attribute. + <br>Possible return values are: + <ul> + <li><code>PortletSession.APPLICATION_SCOPE</code></li> + <li><code>PortletSession.PORTLET_SCOPE</code></li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the + encoded portlet attribute</dd> +<dt><span class="strong">Returns:</span></dt><dd>the decoded attribute scope</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet"><code>PortletSession</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PortletSessionUtil.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/PortletSession.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletURL.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/PortletSessionUtil.html" target="_top">Frames</a></li> +<li><a href="PortletSessionUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURL.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURL.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURL.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURL.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,353 @@ +<!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>PortletURL (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="PortletURL (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/PortletURL.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/PortletSessionUtil.html" title="class in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletURLGenerationListener.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/PortletURL.html" target="_top">Frames</a></li> +<li><a href="PortletURL.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 PortletURL" class="title">Interface PortletURL</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">PortletURL</span> +extends <a href="../../javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></pre> +<div class="block">The <CODE>PortletURL</CODE> interface represents a URL + that reference the portlet itself. + <p> + A PortletURL is created through the <CODE>RenderResponse</CODE> + or <code>ResourceResponse</code>. + Parameters, a portlet mode, a window state and a security level + can be added to <CODE>PortletURL</CODE> objects. + <P> + There are two types of PortletURLs: + <ul> + <li>Action URLs, they are created with <CODE>createActionURL</CODE>, and + trigger an action request followed by a render request. + <li>Render URLs, they are created with <CODE>createRenderURL</CODE>, and + trigger a render request. + </ul> + <p> + The string representation of a PortletURL does not need to be a valid + URL at the time the portlet is generating its content. It may contain + special tokens that will be converted to a valid URL, by the portal, + before the content is returned to the client.</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><a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURL.html#getPortletMode()">getPortletMode</a></strong>()</code> +<div class="block">Returns the currently set portlet mode on this PortletURL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURL.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">Returns the currently set window state on this PortletURL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURL.html#removePublicRenderParameter(java.lang.String)">removePublicRenderParameter</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">Removes the specified public render parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURL.html#setPortletMode(javax.portlet.PortletMode)">setPortletMode</a></strong>(<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> portletMode)</code> +<div class="block">Indicates the portlet mode the portlet must be in, if this + portlet URL triggers a request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURL.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">Indicates the window state the portlet should be in, if this + portlet URL triggers a request.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.BaseURL"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></h3> +<code><a href="../../javax/portlet/BaseURL.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</a>, <a href="../../javax/portlet/BaseURL.html#getParameterMap()">getParameterMap</a>, <a href="../../javax/portlet/BaseURL.html#setParameter(java.lang.String,%20java.lang.String)">setParameter</a>, <a href="../../javax/portlet/BaseURL.html#setParameter(java.lang.String,%20java.lang.String[])">setParameter</a>, <a href="../../javax/portlet/BaseURL.html#setParameters(java.util.Map)">setParameters</a>, <a href="../../javax/portlet/BaseURL.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a>, <a href="../../javax/portlet/BaseURL.html#setSecure(boolean)">setSecure</a>, <a href="../../javax/portlet/BaseURL.html#toString()">toString</a>, <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer)">write</a>, <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer,%20boolean)">write</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="setWindowState(javax.portlet.WindowState)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWindowState</h4> +<pre>void setWindowState(<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState) + throws <a href="../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a></pre> +<div class="block">Indicates the window state the portlet should be in, if this + portlet URL triggers a request. + <p> + A URL can not have more than one window state attached to it. + If more than one window state is set only the last one set + is attached to the URL.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>windowState</code> - the portlet window state</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a></code> - if the portlet cannot switch to this state, + because the portal does not support this state, the portlet has not + declared in its deployment descriptor that it supports this state, or the current + user is not allowed to switch to this state. + The <code>PortletRequest.isWindowStateAllowed()</code> method can be used + to check if the portlet can set a given window state.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.portlet.WindowState)"><code>PortletRequest.isWindowStateAllowed(javax.portlet.WindowState)</code></a></dd></dl> +</li> +</ul> +<a name="setPortletMode(javax.portlet.PortletMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPortletMode</h4> +<pre>void setPortletMode(<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> portletMode) + throws <a href="../../javax/portlet/PortletModeException.html" title="class in javax.portlet">PortletModeException</a></pre> +<div class="block">Indicates the portlet mode the portlet must be in, if this + portlet URL triggers a request. + <p> + A URL can not have more than one portlet mode attached to it. + If more than one portlet mode is set only the last one set + is attached to the URL.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>portletMode</code> - the portlet mode</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletModeException.html" title="class in javax.portlet">PortletModeException</a></code> - if the portlet cannot switch to this mode, + because the portal does not support this mode, the portlet has not + declared in its deployment descriptor that it supports this mode for the current markup, + or the current user is not allowed to switch to this mode. + The <code>PortletRequest.isPortletModeAllowed()</code> method can be used + to check if the portlet can set a given portlet mode.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#isPortletModeAllowed(javax.portlet.PortletMode)"><code>PortletRequest.isPortletModeAllowed(javax.portlet.PortletMode)</code></a></dd></dl> +</li> +</ul> +<a name="getPortletMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletMode</h4> +<pre><a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> getPortletMode()</pre> +<div class="block">Returns the currently set portlet mode on this PortletURL.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet mode, or <code>null</code> if none is set</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getWindowState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowState</h4> +<pre><a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> getWindowState()</pre> +<div class="block">Returns the currently set window state on this PortletURL.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the window state, or <code>null</code> if none is set</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="removePublicRenderParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removePublicRenderParameter</h4> +<pre>void removePublicRenderParameter(<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">Removes the specified public render parameter. + The name must reference a public render parameter defined + in the portlet deployment descriptor under the + <code>public-render-parameter</code> element with the + <code>identifier</code> mapping to the parameter name. + <p> + Note that calling this method on a PortletURL of type + Action URL does not have any effect.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying + the name of the public render parameter to be removed</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><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/PortletURL.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/PortletSessionUtil.html" title="class in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletURLGenerationListener.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/PortletURL.html" target="_top">Frames</a></li> +<li><a href="PortletURL.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/PortletURLGenerationListener.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURLGenerationListener.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURLGenerationListener.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletURLGenerationListener.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,266 @@ +<!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>PortletURLGenerationListener (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="PortletURLGenerationListener (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/PortletURLGenerationListener.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/PortletURL.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PreferencesValidator.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/PortletURLGenerationListener.html" target="_top">Frames</a></li> +<li><a href="PortletURLGenerationListener.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 PortletURLGenerationListener" class="title">Interface PortletURLGenerationListener</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">PortletURLGenerationListener</span></pre> +<div class="block">Portlet applications can register portlet URL listeners in order to filter URLs + before they get generated. + In order to receive a callback from the portlet container before a + portlet URL is generated the portlet application needs to implement this + interface and register it in the deployment descriptor with the + <code>listener</code> element.</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/PortletURLGenerationListener.html#filterActionURL(javax.portlet.PortletURL)">filterActionURL</a></strong>(<a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> actionURL)</code> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on action URLs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURLGenerationListener.html#filterRenderURL(javax.portlet.PortletURL)">filterRenderURL</a></strong>(<a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> renderURL)</code> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on render URLs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletURLGenerationListener.html#filterResourceURL(javax.portlet.ResourceURL)">filterResourceURL</a></strong>(<a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a> resourceURL)</code> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on resource URLs.</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="filterActionURL(javax.portlet.PortletURL)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterActionURL</h4> +<pre>void filterActionURL(<a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> actionURL)</pre> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on action URLs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>actionURL</code> - action URL to be generated</dd></dl> +</li> +</ul> +<a name="filterRenderURL(javax.portlet.PortletURL)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterRenderURL</h4> +<pre>void filterRenderURL(<a href="../../javax/portlet/PortletURL.html" title="interface in javax.portlet">PortletURL</a> renderURL)</pre> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on render URLs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>renderURL</code> - render URL to be generated</dd></dl> +</li> +</ul> +<a name="filterResourceURL(javax.portlet.ResourceURL)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>filterResourceURL</h4> +<pre>void filterResourceURL(<a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet">ResourceURL</a> resourceURL)</pre> +<div class="block">Callback being called by the portlet container + before <code>toString</code> or <code>write</code> + are executed on resource URLs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resourceURL</code> - resource URL to be generated</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/PortletURLGenerationListener.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/PortletURL.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PreferencesValidator.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/PortletURLGenerationListener.html" target="_top">Frames</a></li> +<li><a href="PortletURLGenerationListener.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>
