Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequest.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequest.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequest.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequest.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,1561 @@ +<!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>PortletRequest (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="PortletRequest (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/PortletRequest.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/PortletPreferences.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletRequest.html" target="_top">Frames</a></li> +<li><a href="PortletRequest.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><a href="#nested_class_summary">Nested</a> | </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 PortletRequest" class="title">Interface PortletRequest</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a>, <a href="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet">ClientDataRequest</a>, <a href="../../javax/portlet/EventRequest.html" title="interface in javax.portlet">EventRequest</a>, <a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a>, <a href="../../javax/portlet/ResourceRequest.html" title="interface in javax.portlet">ResourceRequest</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter">ActionRequestWrapper</a>, <a href="../../javax/portlet/filter/EventRequestWrapper.html" title="class in javax.portlet.filter">EventRequestWrapper</a>, <a href="../../javax/portlet/filter/PortletRequestWrapper.html" title="class in javax.portlet.filter">PortletRequestWrapper</a>, <a href="../../javax/portlet/filter/RenderRequestWrapper.html" title="class in javax.portlet.filter">RenderRequestWrapper</a>, <a href="../../javax/portlet/filter/ResourceRequestWrapper.html" title="class in javax.portlet.filter">ResourceRequestWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">PortletRequest</span></pre> +<div class="block">The <CODE>PortletRequest</CODE> defines the base interface to provide client + request information to a portlet. The portlet container uses two specialized + versions of this interface when invoking a portlet, <CODE>ActionRequest</CODE> + and <CODE>RenderRequest</CODE>. The portlet container creates these objects and + passes them as arguments to the portlet's <CODE>processAction</CODE> and + <CODE>render</CODE> methods.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/ActionRequest.html" title="interface in javax.portlet"><code>ActionRequest</code></a>, +<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet"><code>RenderRequest</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet">PortletRequest.P3PUserInfos</a></strong></code> +<div class="block">P3P user information constants.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#ACTION_PHASE">ACTION_PHASE</a></strong></code> +<div class="block">String identifier for the portlet action lifecycle phase.</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/PortletRequest.html#ACTION_SCOPE_ID">ACTION_SCOPE_ID</a></strong></code> +<div class="block">The action scope ID that the portlet container uses + for storing the current action scope as render parameter + if the <code>javax.portlet.actionScopedRequestAttributes</code> + container runtime option is used by the portlet.</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/PortletRequest.html#BASIC_AUTH">BASIC_AUTH</a></strong></code> +<div class="block">String identifier for Basic authentication.</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/PortletRequest.html#CCPP_PROFILE">CCPP_PROFILE</a></strong></code> +<div class="block">Used to retrieve an instance of the <code>javax.ccpp.Profile</code> + with the <code>getAttribute</code> call.</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/PortletRequest.html#CLIENT_CERT_AUTH">CLIENT_CERT_AUTH</a></strong></code> +<div class="block">String identifier for Certification based authentication.</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/PortletRequest.html#DIGEST_AUTH">DIGEST_AUTH</a></strong></code> +<div class="block">String identifier for Digest based authentication.</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/PortletRequest.html#EVENT_PHASE">EVENT_PHASE</a></strong></code> +<div class="block">String identifier for the portlet event lifecycle phase.</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/PortletRequest.html#FORM_AUTH">FORM_AUTH</a></strong></code> +<div class="block">String identifier for Form based authentication.</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/PortletRequest.html#LIFECYCLE_PHASE">LIFECYCLE_PHASE</a></strong></code> +<div class="block">Provides the portlet lifecycle phase of the current request + as request attribute.</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/PortletRequest.html#RENDER_HEADERS">RENDER_HEADERS</a></strong></code> +<div class="block">The RENDER_HEADERS is a possible value of the RENDER_PART + request attribute and denotes that the portlet should set + the intended headers and the portlet title of this render + request.</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/PortletRequest.html#RENDER_MARKUP">RENDER_MARKUP</a></strong></code> +<div class="block">The RENDER_MARKUP is a possible value of the RENDER_PART + request attribute and denotes that the portlet should + produce its markup for this render request.</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/PortletRequest.html#RENDER_PART">RENDER_PART</a></strong></code> +<div class="block">The RENDER_PART portlet request attribute is set by portals + that are streaming based and therefore need to split the + render phase into two parts: first the RENDER_HEADERS part + where the portlet should only set the header related data + and the portlet title, and second the RENDER_MARKUP part + in which the portlet should produce its markup.</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/PortletRequest.html#RENDER_PHASE">RENDER_PHASE</a></strong></code> +<div class="block">String identifier for the portlet render lifecycle phase.</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/PortletRequest.html#RESOURCE_PHASE">RESOURCE_PHASE</a></strong></code> +<div class="block">String identifier for the portlet resource serving lifecycle phase.</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/PortletRequest.html#USER_INFO">USER_INFO</a></strong></code> +<div class="block">Used to retrieve user information attributes with the + <code>getAttribute</code> call.</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/PortletRequest.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 value of the named attribute as an <code>Object</code>, + or <code>null</code> if no attribute of the given name exists.</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/PortletRequest.html#getAttributeNames()">getAttributeNames</a></strong>()</code> +<div class="block">Returns an <code>Enumeration</code> containing the + names of the attributes available to this request.</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/PortletRequest.html#getAuthType()">getAuthType</a></strong>()</code> +<div class="block">Returns the name of the authentication scheme used for the + connection between client and portal, + for example, <code>BASIC_AUTH</code>, <code>CLIENT_CERT_AUTH</code>, + a custom one or <code>null</code> if there was no authentication.</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/PortletRequest.html#getContextPath()">getContextPath</a></strong>()</code> +<div class="block">Returns the context path which is the path prefix associated with the deployed + portlet application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>javax.servlet.http.Cookie[]</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getCookies()">getCookies</a></strong>()</code> +<div class="block">Returns an array containing all of the Cookie properties.</div> +</td> +</tr> +<tr class="rowColor"> +<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/PortletRequest.html#getLocale()">getLocale</a></strong>()</code> +<div class="block">Returns the preferred Locale in which the portal will accept content.</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/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/PortletRequest.html#getLocales()">getLocales</a></strong>()</code> +<div class="block">Returns an Enumeration of Locale objects indicating, in decreasing + order starting with the preferred locale in which the portal will + accept content for this request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getParameter(java.lang.String)">getParameter</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 value of a request parameter as a <code>String</code>, + or <code>null</code> if the parameter does not exist.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getParameterMap()">getParameterMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the parameters of this request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/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/PortletRequest.html#getParameterNames()">getParameterNames</a></strong>()</code> +<div class="block">Returns an <code>Enumeration</code> of <code>String</code> + objects containing the names of the parameters contained + in this request.</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/PortletRequest.html#getParameterValues(java.lang.String)">getParameterValues</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 an array of <code>String</code> objects containing + all of the values the given request parameter has, or + <code>null</code> if the parameter does not exist.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortalContext.html" title="interface in javax.portlet">PortalContext</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getPortalContext()">getPortalContext</a></strong>()</code> +<div class="block">Returns the context of the calling portal.</div> +</td> +</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/PortletRequest.html#getPortletMode()">getPortletMode</a></strong>()</code> +<div class="block">Returns the current portlet mode of the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getPortletSession()">getPortletSession</a></strong>()</code> +<div class="block">Returns the current portlet session or, if there is no current session, + creates one and returns the new session.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getPortletSession(boolean)">getPortletSession</a></strong>(boolean create)</code> +<div class="block">Returns the current portlet session or, if there is no current session + and the given flag is <CODE>true</CODE>, creates one and returns + the new session.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletPreferences.html" title="interface in javax.portlet">PortletPreferences</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getPreferences()">getPreferences</a></strong>()</code> +<div class="block">Returns the preferences object associated with the portlet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getPrivateParameterMap()">getPrivateParameterMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the private parameters of this request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/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/PortletRequest.html#getProperties(java.lang.String)">getProperties</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 all the values of the specified request property + as a <code>Enumeration</code> of <code>String</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/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/PortletRequest.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 value of the specified request property + as a <code>String</code>.</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/PortletRequest.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">Returns a <code>Enumeration</code> of all the property names + this request contains.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getPublicParameterMap()">getPublicParameterMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the public parameters of this request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getRemoteUser()">getRemoteUser</a></strong>()</code> +<div class="block">Returns the login of the user making this request, if the user + has been authenticated, or null if the user has not been authenticated.</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/PortletRequest.html#getRequestedSessionId()">getRequestedSessionId</a></strong>()</code> +<div class="block">Returns the session ID indicated in the client request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getResponseContentType()">getResponseContentType</a></strong>()</code> +<div class="block">Returns the portal preferred content type for 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/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/PortletRequest.html#getResponseContentTypes()">getResponseContentTypes</a></strong>()</code> +<div class="block">Gets a list of content types which the portal accepts for the response.</div> +</td> +</tr> +<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/PortletRequest.html#getScheme()">getScheme</a></strong>()</code> +<div class="block">Returns the name of the scheme used to make this request.</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/PortletRequest.html#getServerName()">getServerName</a></strong>()</code> +<div class="block">Returns the host name of the server that received the request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getServerPort()">getServerPort</a></strong>()</code> +<div class="block">Returns the port number on which this request was received.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/security/Principal.html?is-external=true"; title="class or interface in java.security">Principal</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#getUserPrincipal()">getUserPrincipal</a></strong>()</code> +<div class="block">Returns a java.security.Principal object containing the name of the + current authenticated user.</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/PortletRequest.html#getWindowID()">getWindowID</a></strong>()</code> +<div class="block">Returns the portlet window ID.</div> +</td> +</tr> +<tr class="altColor"> +<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/PortletRequest.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">Returns the current window state of the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#isPortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</a></strong>(<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> mode)</code> +<div class="block">Returns true, if the given portlet mode is a valid + one to set for this portlet in the context + of the current request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</a></strong>()</code> +<div class="block">Checks whether the requested session ID is still valid.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#isSecure()">isSecure</a></strong>()</code> +<div class="block">Returns a boolean indicating whether this request was made + using a secure channel between client and the portal, such as HTTPS.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#isUserInRole(java.lang.String)">isUserInRole</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> role)</code> +<div class="block">Returns a boolean indicating whether the authenticated user is + included in the specified logical "role".</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</a></strong>(<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</code> +<div class="block">Returns true, if the given window state is valid + to be set for this portlet in the context + of the current request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.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 an attribute from this request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequest.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> o)</code> +<div class="block">Stores an attribute in this request.</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="USER_INFO"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>USER_INFO</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> USER_INFO</pre> +<div class="block">Used to retrieve user information attributes with the + <code>getAttribute</code> call. The user information is returned + as a <code>Map</code> object. The portlet must define the + user information attribute it is interested in inside the + <code>user-attribute</code> section of the deployment descriptor. + If an attribute is not supported + by the current runtime system it will not show up in the user + attribute map.<BR> + If the user-attribute is supported by the runtime system, but not + defined for a particular user, then for that user the attribute + exists in the returned map and the attribute has a <code>null</code> value. + <p> + If the user-attribute is not defined for the current user it + will not show up in the Map. + <p> + The value is <code>javax.portlet.userinfo</code>.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletRequest.USER_INFO">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CCPP_PROFILE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CCPP_PROFILE</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> CCPP_PROFILE</pre> +<div class="block">Used to retrieve an instance of the <code>javax.ccpp.Profile</code> + with the <code>getAttribute</code> call. The returned profile is based + on the current portlet request and may contain additional CC/PP + information set by the portal / portlet container. + <p> + The value is <code>javax.portlet.ccpp</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.PortletRequest.CCPP_PROFILE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="BASIC_AUTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BASIC_AUTH</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> BASIC_AUTH</pre> +<div class="block">String identifier for Basic authentication. Value "BASIC".</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletRequest.BASIC_AUTH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="FORM_AUTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FORM_AUTH</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> FORM_AUTH</pre> +<div class="block">String identifier for Form based authentication. Value "FORM".</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletRequest.FORM_AUTH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CLIENT_CERT_AUTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLIENT_CERT_AUTH</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> CLIENT_CERT_AUTH</pre> +<div class="block">String identifier for Certification based authentication. Value "CLIENT_CERT".</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletRequest.CLIENT_CERT_AUTH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DIGEST_AUTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DIGEST_AUTH</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> DIGEST_AUTH</pre> +<div class="block">String identifier for Digest based authentication. Value "DIGEST".</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.PortletRequest.DIGEST_AUTH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ACTION_PHASE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ACTION_PHASE</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ACTION_PHASE</pre> +<div class="block">String identifier for the portlet action lifecycle phase. In this + phase the portlet request and response are from type + <code>ActionRequest</code> and <code>ActionResponse</code>. + <p> + The value of the constant is <code>ACTION_PHASE</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.PortletRequest.ACTION_PHASE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EVENT_PHASE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVENT_PHASE</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> EVENT_PHASE</pre> +<div class="block">String identifier for the portlet event lifecycle phase. In this + phase the portlet request and response are from type + <code>EventRequest</code> and <code>EventResponse</code>. + <p> + The value of the constant is <code>EVENT_PHASE</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.PortletRequest.EVENT_PHASE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RENDER_PHASE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RENDER_PHASE</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> RENDER_PHASE</pre> +<div class="block">String identifier for the portlet render lifecycle phase. In this + phase the portlet request and response are from type + <code>RenderRequest</code> and <code>RenderResponse</code>. + <p> + The value of the constant is <code>RENDER_PHASE</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.PortletRequest.RENDER_PHASE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RESOURCE_PHASE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RESOURCE_PHASE</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> RESOURCE_PHASE</pre> +<div class="block">String identifier for the portlet resource serving lifecycle phase. In this + phase the portlet request and response are from type + <code>ResourceRequest</code> and <code>ResourceResponse</code>. + <p> + The value of the constant is <code>RESOURCE_PHASE</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.PortletRequest.RESOURCE_PHASE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LIFECYCLE_PHASE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LIFECYCLE_PHASE</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> LIFECYCLE_PHASE</pre> +<div class="block">Provides the portlet lifecycle phase of the current request + as request attribute. + <p> + Valid values are: ACTION_PHASE, EVENT_PHASE, RENDER_PHASE, + RESOURCE_SERVING_PHASE. + <p> + The value of the constant is <code>javax.portlet.lifecylce_phase</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.PortletRequest.LIFECYCLE_PHASE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RENDER_PART"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RENDER_PART</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> RENDER_PART</pre> +<div class="block">The RENDER_PART portlet request attribute is set by portals + that are streaming based and therefore need to split the + render phase into two parts: first the RENDER_HEADERS part + where the portlet should only set the header related data + and the portlet title, and second the RENDER_MARKUP part + in which the portlet should produce its markup. + <p> + Non-streaming portals will not set this attribute and thus + the portlet should set headers, portlet title and produce + its markup in a single render request. + <p> + The value of the constant is <code>javax.portlet.render_part</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.PortletRequest.RENDER_PART">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RENDER_HEADERS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RENDER_HEADERS</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> RENDER_HEADERS</pre> +<div class="block">The RENDER_HEADERS is a possible value of the RENDER_PART + request attribute and denotes that the portlet should set + the intended headers and the portlet title of this render + request. + <p> + The value of the constant is <code>RENDER_HEADERS</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.PortletRequest.RENDER_HEADERS">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RENDER_MARKUP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RENDER_MARKUP</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> RENDER_MARKUP</pre> +<div class="block">The RENDER_MARKUP is a possible value of the RENDER_PART + request attribute and denotes that the portlet should + produce its markup for this render request. + <p> + The value of the constant is <code>RENDER_MARKUP</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.PortletRequest.RENDER_MARKUP">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ACTION_SCOPE_ID"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ACTION_SCOPE_ID</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ACTION_SCOPE_ID</pre> +<div class="block">The action scope ID that the portlet container uses + for storing the current action scope as render parameter + if the <code>javax.portlet.actionScopedRequestAttributes</code> + container runtime option is used by the portlet. + <p> + The value is <code>javax.portlet.as</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.PortletRequest.ACTION_SCOPE_ID">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="isWindowStateAllowed(javax.portlet.WindowState)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isWindowStateAllowed</h4> +<pre>boolean isWindowStateAllowed(<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</pre> +<div class="block">Returns true, if the given window state is valid + to be set for this portlet in the context + of the current request.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - window state to checked</dd> +<dt><span class="strong">Returns:</span></dt><dd>true, if it is valid for this portlet + in this request to change to the + given window state</dd></dl> +</li> +</ul> +<a name="isPortletModeAllowed(javax.portlet.PortletMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPortletModeAllowed</h4> +<pre>boolean isPortletModeAllowed(<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> mode)</pre> +<div class="block">Returns true, if the given portlet mode is a valid + one to set for this portlet in the context + of the current request.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - portlet mode to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>true, if it is valid for this portlet + in this request to change to the + given portlet mode</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 current portlet mode of the portlet.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet mode</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 current window state of the portlet.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the window state</dd></dl> +</li> +</ul> +<a name="getPreferences()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreferences</h4> +<pre><a href="../../javax/portlet/PortletPreferences.html" title="interface in javax.portlet">PortletPreferences</a> getPreferences()</pre> +<div class="block">Returns the preferences object associated with the portlet.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet preferences</dd></dl> +</li> +</ul> +<a name="getPortletSession()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletSession</h4> +<pre><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a> getPortletSession()</pre> +<div class="block">Returns the current portlet session or, if there is no current session, + creates one and returns the new session. + <p> + Creating a new portlet session will result in creating + a new <code>HttpSession</code> on which the portlet session is based on.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet session</dd></dl> +</li> +</ul> +<a name="getPortletSession(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletSession</h4> +<pre><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a> getPortletSession(boolean create)</pre> +<div class="block">Returns the current portlet session or, if there is no current session + and the given flag is <CODE>true</CODE>, creates one and returns + the new session. + <P> + If the given flag is <CODE>false</CODE> and there is no current + portlet session, this method returns <CODE>null</CODE>. + <p> + Creating a new portlet session will result in creating + a new <code>HttpSession</code> on which the portlet session is based on.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>create</code> - <CODE>true</CODE> to create a new session, <BR> + <CODE>false</CODE> to return <CODE>null</CODE> if there + is no current session</dd> +<dt><span class="strong">Returns:</span></dt><dd>the portlet session</dd></dl> +</li> +</ul> +<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 value of the specified request property + as a <code>String</code>. If the request did not include a property + of the specified name, this method returns <code>null</code>. + <p> + A portlet can access portal/portlet-container specific properties + through this method and, if available, the + headers of the HTTP client request. + <p> + This method should only be used if the + property has only one value. If the property might have + more than one value, use <a href="../../javax/portlet/PortletRequest.html#getProperties(java.lang.String)"><code>getProperties(java.lang.String)</code></a>. + <p> + If this method is used with a multivalued + parameter, the value returned is equal to the first value + in the Enumeration returned by <code>getProperties</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the + property name</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the + value of the requested + property, or <code>null</code> + if the request does not + have a property of that 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/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="getProperties(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</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>> getProperties(<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 all the values of the specified request property + as a <code>Enumeration</code> of <code>String</code> objects. + <p> + If the request did not include any properties + of the specified name, this method returns an empty + <code>Enumeration</code>. + The property name is case insensitive. You can use + this method with any request property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the + property name</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>Enumeration</code> containing + the values of the requested property. If + the request does not have any properties of + that name return an empty <code>Enumeration</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 a <code>Enumeration</code> of all the property names + this request contains. If the request has no + properties, this method returns an empty <code>Enumeration</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of all the + property names sent with this + request; if the request has + no properties, an empty <code>Enumeration</code>.</dd></dl> +</li> +</ul> +<a name="getPortalContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortalContext</h4> +<pre><a href="../../javax/portlet/PortalContext.html" title="interface in javax.portlet">PortalContext</a> getPortalContext()</pre> +<div class="block">Returns the context of the calling portal.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the context of the calling portal</dd></dl> +</li> +</ul> +<a name="getAuthType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthType</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> getAuthType()</pre> +<div class="block">Returns the name of the authentication scheme used for the + connection between client and portal, + for example, <code>BASIC_AUTH</code>, <code>CLIENT_CERT_AUTH</code>, + a custom one or <code>null</code> if there was no authentication.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>one of the static members <code>BASIC_AUTH</code>, + <code>FORM_AUTH</code>, <code>CLIENT_CERT_AUTH</code>, + <code>DIGEST_AUTH</code> (suitable for == comparison) + indicating the authentication scheme, + a custom one, or + <code>null</code> if the request was + not authenticated.</dd></dl> +</li> +</ul> +<a name="getContextPath()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContextPath</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> getContextPath()</pre> +<div class="block">Returns the context path which is the path prefix associated with the deployed + portlet application. If the portlet application is rooted at the + base of the web server URL namespace (also known as "default" context), + this path must be an empty string. Otherwise, it must be the path the + portlet application is rooted to, the path must start with a '/' and + it must not end with a '/' character. + <p> + To encode a URL the <a href="../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)"><code>PortletResponse.encodeURL(java.lang.String)</code></a> method must be used.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the + portion of the request URL that indicates the context + of the request</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)"><code>PortletResponse.encodeURL(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getRemoteUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemoteUser</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> getRemoteUser()</pre> +<div class="block">Returns the login of the user making this request, if the user + has been authenticated, or null if the user has not been authenticated.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the login + of the user making this request, or <code>null</code> + if the user login is not known.</dd></dl> +</li> +</ul> +<a name="getUserPrincipal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserPrincipal</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/security/Principal.html?is-external=true"; title="class or interface in java.security">Principal</a> getUserPrincipal()</pre> +<div class="block">Returns a java.security.Principal object containing the name of the + current authenticated user.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>java.security.Principal</code> containing + the name of the user making this request, or + <code>null</code> if the user has not been + authenticated.</dd></dl> +</li> +</ul> +<a name="isUserInRole(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUserInRole</h4> +<pre>boolean isUserInRole(<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> role)</pre> +<div class="block">Returns a boolean indicating whether the authenticated user is + included in the specified logical "role". Roles and role membership can be + defined using deployment descriptors. If the user has not been + authenticated, the method returns <code>false</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>role</code> - a <code>String</code> specifying the name + of the role</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>boolean</code> indicating whether + the user making this request belongs to a given role; + <code>false</code> if the user has not been + authenticated.</dd></dl> +</li> +</ul> +<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 value of the named attribute as an <code>Object</code>, + or <code>null</code> if no attribute of the given name exists. + <p> + Attribute names should follow the same conventions as package + names. This specification reserves names matching <code>java.*</code>, + and <code>javax.*</code>. + <p> + In a distributed portlet web application the <code>Object</code> + needs to be serializable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name of + the attribute</dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Object</code> containing the value + of the attribute, or <code>null</code> if + the attribute does not exist.</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="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> containing the + names of the attributes available to this request. + This method returns an empty <code>Enumeration</code> + if the request has no attributes available to it.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of strings + containing the names + of the request attributes, or an empty + <code>Enumeration</code> if the request + has no attributes available to it.</dd></dl> +</li> +</ul> +<a name="getParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameter</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> getParameter(<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 value of a request parameter as a <code>String</code>, + or <code>null</code> if the parameter does not exist. Request parameters + are extra information sent with the request. The returned parameter + are "x-www-form-urlencoded" decoded. + <p> + Only parameters targeted to the current portlet are accessible. + <p> + This method should only be used if the + parameter has only one value. If the parameter might have + more than one value, use <a href="../../javax/portlet/PortletRequest.html#getParameterValues(java.lang.String)"><code>getParameterValues(java.lang.String)</code></a>. + <p> + If this method is used with a multivalued + parameter, the value returned is equal to the first value + in the array returned by <code>getParameterValues</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the + name of the parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> representing the + single value of the parameter</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">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#getParameterValues(java.lang.String)"><code>getParameterValues(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterNames</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>> getParameterNames()</pre> +<div class="block">Returns an <code>Enumeration</code> of <code>String</code> + objects containing the names of the parameters contained + in this request. If the request has + no parameters, the method returns an + empty <code>Enumeration</code>. + <p> + Only parameters targeted to the current portlet are returned.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> + objects, each <code>String</code> containing + the name of a request parameter; or an + empty <code>Enumeration</code> if the + request has no parameters.</dd></dl> +</li> +</ul> +<a name="getParameterValues(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterValues</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>[] getParameterValues(<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 an array of <code>String</code> objects containing + all of the values the given request parameter has, or + <code>null</code> if the parameter does not exist. + The returned parameters are "x-www-form-urlencoded" decoded. + <p> + If the parameter has a single value, the array has a length + of 1.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> containing the name of + the parameter the value of which is requested</dd> +<dt><span class="strong">Returns:</span></dt><dd>an array of <code>String</code> objects + containing the parameter values.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#getParameter(java.lang.String)"><code>getParameter(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getParameterMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getParameterMap()</pre> +<div class="block">Returns a <code>Map</code> of the parameters of this request. + Request parameters are extra information sent with the request. + The returned parameters are "x-www-form-urlencoded" decoded. + <p> + The values in the returned <code>Map</code> are from type + String array (<code>String[]</code>). + <p> + If no parameters exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing parameter names as + keys and parameter values as map values, or an empty <code>Map</code> + if no parameters exist. The keys in the parameter + map are of type String. The values in the parameter map are of type + String array (<code>String[]</code>).</dd></dl> +</li> +</ul> +<a name="isSecure()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSecure</h4> +<pre>boolean isSecure()</pre> +<div class="block">Returns a boolean indicating whether this request was made + using a secure channel between client and the portal, such as HTTPS.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true, if the request was made using a secure channel.</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> o)</pre> +<div class="block">Stores an attribute in this request. + + <p>Attribute names should follow the same conventions as + package names. Names beginning with <code>java.*</code>, + <code>javax.*</code>, and <code>com.sun.*</code> are + reserved. +<br> If the value passed into this method is <code>null</code>, + the effect is the same as calling <a href="../../javax/portlet/PortletRequest.html#removeAttribute(java.lang.String)"><code>removeAttribute(java.lang.String)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying + the name of the attribute</dd><dd><code>o</code> - the <code>Object</code> to be stored</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="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 an attribute from this request. This method is not + generally needed, as attributes only persist as long as the request + is being handled. + + <p>Attribute names should follow the same conventions as + package names. Names beginning with <code>java.*</code>, + <code>javax.*</code>, and <code>com.sun.*</code> are + reserved.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying + the name of the attribute 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></dl> +</li> +</ul> +<a name="getRequestedSessionId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequestedSessionId</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> getRequestedSessionId()</pre> +<div class="block">Returns the session ID indicated in the client request. + This session ID may not be a valid one, it may be an old + one that has expired or has been invalidated. + If the client request + did not specify a session ID, this method returns + <code>null</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the session + ID, or <code>null</code> if the request did + not specify a session ID</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#isRequestedSessionIdValid()"><code>isRequestedSessionIdValid()</code></a></dd></dl> +</li> +</ul> +<a name="isRequestedSessionIdValid()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRequestedSessionIdValid</h4> +<pre>boolean isRequestedSessionIdValid()</pre> +<div class="block">Checks whether the requested session ID is still valid.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this + request has an id for a valid session + in the current session context; + <code>false</code> otherwise</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequest.html#getRequestedSessionId()"><code>getRequestedSessionId()</code></a>, +<a href="../../javax/portlet/PortletRequest.html#getPortletSession()"><code>getPortletSession()</code></a></dd></dl> +</li> +</ul> +<a name="getResponseContentType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseContentType</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getResponseContentType()</pre> +<div class="block">Returns the portal preferred content type for the response. + <p> + The following restrictions apply: + <ul> + <li>The content type only includes the MIME type, not the + character set. The character set of the response + can be retrieved via the <a href="../../javax/portlet/MimeResponse.html#getCharacterEncoding()"><code>MimeResponse.getCharacterEncoding()</code></a>.</li> + <li>Only content types that the portlet has defined in its + deployment descriptor are valid return values for + this method call. If the portlet has defined + <code>'*'</code> or <code>'* / *'</code> as supported content + types, these may also be valid return values.</li> + </ul></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>preferred MIME type of the response</dd></dl> +</li> +</ul> +<a name="getResponseContentTypes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseContentTypes</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getResponseContentTypes()</pre> +<div class="block">Gets a list of content types which the portal accepts for the response. + This list is ordered with the most preferable types listed first. + <p> + The following restrictions apply: + <ul> + <li>The content type only includes the MIME type, not the + character set.</li> + <li>Only content types that the portlet has defined in its + deployment descriptor are valid return values for + this method call. If the portlet has defined + <code>'*'</code> or <code>'* / *'</code> as supported content + types, these may also be valid return values.</li> + </ul></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>ordered list of MIME types for the response</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 preferred Locale in which the portal will accept content. + The Locale may be based on the Accept-Language header of the client.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the preferred Locale in which the portal will accept content.</dd></dl> +</li> +</ul> +<a name="getLocales()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocales</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/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a>> getLocales()</pre> +<div class="block">Returns an Enumeration of Locale objects indicating, in decreasing + order starting with the preferred locale in which the portal will + accept content for this request. + The Locales may be based on the Accept-Language header of the client.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an Enumeration of Locales, in decreasing order, in which + the portal will accept content for this request</dd></dl> +</li> +</ul> +<a name="getScheme()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScheme</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> getScheme()</pre> +<div class="block">Returns the name of the scheme used to make this request. + For example, <code>http</code>, <code>https</code>, or <code>ftp</code>. + Different schemes have different rules for constructing URLs, + as noted in RFC 1738.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name + of the scheme used to make this request</dd></dl> +</li> +</ul> +<a name="getServerName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getServerName</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> getServerName()</pre> +<div class="block">Returns the host name of the server that received the request.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name + of the server to which the request was sent</dd></dl> +</li> +</ul> +<a name="getServerPort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getServerPort</h4> +<pre>int getServerPort()</pre> +<div class="block">Returns the port number on which this request was received.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the port number</dd></dl> +</li> +</ul> +<a name="getWindowID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowID</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> getWindowID()</pre> +<div class="block">Returns the portlet window ID. The portlet window ID is + unique for this portlet window and is constant for the lifetime + of the portlet window. + <p> + This ID is the same that is used by the portlet container for + scoping the portlet-scope session attributes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet window ID</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getCookies()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCookies</h4> +<pre>javax.servlet.http.Cookie[] getCookies()</pre> +<div class="block">Returns an array containing all of the Cookie properties. + <p> + This method returns <code>null</code> if no cookies exist.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>array of cookie properties, or + <code>null</code> if no cookies exist.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)"><code>PortletResponse.addProperty(Cookie)</code></a></dd></dl> +</li> +</ul> +<a name="getPrivateParameterMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrivateParameterMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getPrivateParameterMap()</pre> +<div class="block">Returns a <code>Map</code> of the private parameters of this request. + Private parameters are not shared with other portlets or components. + The returned parameters are "x-www-form-urlencoded" decoded. + <p> + The values in the returned <code>Map</code> are from type + String array (<code>String[]</code>). + <p> + If no private parameters exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing private parameter names as + keys and private parameter values as map values, or an empty <code>Map</code> + if no private parameters exist. The keys in the parameter + map are of type String. The values in the parameter map are of type + String array (<code>String[]</code>).</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getPublicParameterMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPublicParameterMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getPublicParameterMap()</pre> +<div class="block">Returns a <code>Map</code> of the public parameters of this request. + Public parameters may be shared with other portlets or components and + defined in the portlet deployment descriptor with the + <code>supported-public-render-parameter</code> element. + The returned parameters are "x-www-form-urlencoded" decoded. + <p> + The values in the returned <code>Map</code> are from type + String array (<code>String[]</code>). + <p> + If no public parameters exist this method returns an empty <code>Map</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing public parameter names as + keys and public parameter values as map values, or an empty <code>Map</code> + if no public parameters exist. The keys in the parameter + map are of type String. The values in the parameter map are of type + String array (<code>String[]</code>).</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</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/PortletRequest.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/PortletPreferences.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletRequest.html" target="_top">Frames</a></li> +<li><a href="PortletRequest.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><a href="#nested_class_summary">Nested</a> | </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 ======= -->
[... 4 lines stripped ...]
