Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletRequestWrapper.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletRequestWrapper.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletRequestWrapper.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/PortletRequestWrapper.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,1257 @@ +<!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>PortletRequestWrapper (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="PortletRequestWrapper (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/PortletRequestWrapper.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/filter/PortletFilter.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/PortletRequestWrapper.html" target="_top">Frames</a></li> +<li><a href="PortletRequestWrapper.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.filter</div> +<h2 title="Class PortletRequestWrapper" class="title">Class PortletRequestWrapper</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.filter.PortletRequestWrapper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</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/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 class <span class="strong">PortletRequestWrapper</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> +implements <a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></pre> +<div class="block">The <code>PortletRequestWrapper</code> provides a convenient + implementation of the <code>PortletRequest</code> interface + and is extended by other request wrappers. + This class implements the Wrapper or Decorator pattern. + Methods default to calling through to the wrapped request object.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet"><code>PortletRequest</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_javax.portlet.PortletRequest"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface javax.portlet.<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet">PortletRequest.P3PUserInfos</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_javax.portlet.PortletRequest"> +<!-- --> +</a> +<h3>Fields inherited from interface javax.portlet.<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></h3> +<code><a href="../../../javax/portlet/PortletRequest.html#ACTION_PHASE">ACTION_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#ACTION_SCOPE_ID">ACTION_SCOPE_ID</a>, <a href="../../../javax/portlet/PortletRequest.html#BASIC_AUTH">BASIC_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#CCPP_PROFILE">CCPP_PROFILE</a>, <a href="../../../javax/portlet/PortletRequest.html#CLIENT_CERT_AUTH">CLIENT_CERT_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#DIGEST_AUTH">DIGEST_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#EVENT_PHASE">EVENT_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#FORM_AUTH">FORM_AUTH</a>, <a href="../../../javax/portlet/PortletRequest.html#LIFECYCLE_PHASE">LIFECYCLE_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#RENDER_HEADERS">RENDER_HEADERS</a>, <a href="../../../javax/portlet/PortletRequest.html#RENDER_MARKUP">RENDER_MARKUP</a>, <a href="../../../javax/portlet/PortletRequest.html#REN DER_PART">RENDER_PART</a>, <a href="../../../javax/portlet/PortletRequest.html#RENDER_PHASE">RENDER_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#RESOURCE_PHASE">RESOURCE_PHASE</a>, <a href="../../../javax/portlet/PortletRequest.html#USER_INFO">USER_INFO</a></code></li> +</ul> +</li> +</ul> +<!-- ======== 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/filter/PortletRequestWrapper.html#PortletRequestWrapper(javax.portlet.PortletRequest)">PortletRequestWrapper</a></strong>(<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request)</code> +<div class="block">Creates an <code>PortletRequest</code> adaptor + wrapping the given request object.</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/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>getAttribute(String name)</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getAttributeNames()">getAttributeNames</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getAttributeNames()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getAuthType()">getAuthType</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getAuthType()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getContextPath()">getContextPath</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getContextPath()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getCookies()">getCookies</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getCookies()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getLocale()">getLocale</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getLocales()">getLocales</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getLocales()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>getParameter(String name)</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getParameterMap()">getParameterMap</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getParameterMap()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getParameterNames()">getParameterNames</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getParameterNames()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>getParameterValues(name)</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPortalContext()">getPortalContext</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPortalContext()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPortletMode()">getPortletMode</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPortletMode()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPortletSession()">getPortletSession</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPortletSession()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPortletSession(boolean)">getPortletSession</a></strong>(boolean create)</code> +<div class="block">The default behavior of this method is to call + <code>getPortletSession(create)</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPreferences()">getPreferences</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPreferences()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPrivateParameterMap()">getPrivateParameterMap</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPrivateParameterMap()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>getProperteis(name)</code> on the wrapped request object.</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/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>getProperty(name)</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPropertyNames()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getPublicParameterMap()">getPublicParameterMap</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getPublicParameterMap()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getRemoteUser()">getRemoteUser</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getRemoteUser()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getRequest()">getRequest</a></strong>()</code> +<div class="block">Return the wrapped request object.</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/filter/PortletRequestWrapper.html#getRequestedSessionId()">getRequestedSessionId</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getRequestedSessionId()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getResponseContentType()">getResponseContentType</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getResponseContentType()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getResponseContentTypes()">getResponseContentTypes</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getResponseContentTypes()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getScheme()">getScheme</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getScheme()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getServerName()">getServerName</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getServerName()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getServerPort()">getServerPort</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getServerPort()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<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/filter/PortletRequestWrapper.html#getUserPrincipal()">getUserPrincipal</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getUserPrincipal()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getWindowID()">getWindowID</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getWindowId()</code> on the wrapped request object.</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/filter/PortletRequestWrapper.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getWindowState()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>isPortletModeAllowed(mode)</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>isRequestedSessionIdValid()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isSecure()">isSecure</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>isSecure()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>isUserInRole(role)</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>isWindowStateAllowed(state)</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>removeAttribute(name)</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.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">The default behavior of this method is to call + <code>setAttribute(name, o)</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#setRequest(javax.portlet.PortletRequest)">setRequest</a></strong>(<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request)</code> +<div class="block">Sets the request object being wrapped.</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="PortletRequestWrapper(javax.portlet.PortletRequest)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PortletRequestWrapper</h4> +<pre>public PortletRequestWrapper(<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request)</pre> +<div class="block">Creates an <code>PortletRequest</code> adaptor + wrapping the given request object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the portlet request to wrap</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 the request is <code>null</code></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>public <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">The default behavior of this method is to call + <code>getAttribute(String name)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getAttribute(java.lang.String)">getAttribute</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></dl> +</li> +</ul> +<a name="getAttributeNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttributeNames</h4> +<pre>public <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">The default behavior of this method is to call + <code>getAttributeNames()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getAttributeNames()">getAttributeNames</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getAuthType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthType</h4> +<pre>public <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">The default behavior of this method is to call + <code>getAuthType()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getAuthType()">getAuthType</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public <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">The default behavior of this method is to call + <code>getContextPath()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getContextPath()">getContextPath</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getLocale()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocale</h4> +<pre>public <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">The default behavior of this method is to call + <code>getLocale()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getLocale()">getLocale</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public <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">The default behavior of this method is to call + <code>getLocales()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getLocales()">getLocales</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameter</h4> +<pre>public <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">The default behavior of this method is to call + <code>getParameter(String name)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getParameter(java.lang.String)">getParameter</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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">See Also:</span></dt><dd><a href="../../../javax/portlet/PortletRequest.html#getParameterValues(java.lang.String)"><code>PortletRequest.getParameterValues(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getParameterMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterMap</h4> +<pre>public <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">The default behavior of this method is to call + <code>getParameterMap()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getParameterMap()">getParameterMap</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameterNames</h4> +<pre>public <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">The default behavior of this method is to call + <code>getParameterNames()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getParameterNames()">getParameterNames</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public <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">The default behavior of this method is to call + <code>getParameterValues(name)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getParameterValues(java.lang.String)">getParameterValues</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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">See Also:</span></dt><dd><a href="../../../javax/portlet/PortletRequest.html#getParameter(java.lang.String)"><code>PortletRequest.getParameter(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getPortalContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortalContext</h4> +<pre>public <a href="../../../javax/portlet/PortalContext.html" title="interface in javax.portlet">PortalContext</a> getPortalContext()</pre> +<div class="block">The default behavior of this method is to call + <code>getPortalContext()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPortalContext()">getPortalContext</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the context of the calling portal</dd></dl> +</li> +</ul> +<a name="getPortletMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletMode</h4> +<pre>public <a href="../../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> getPortletMode()</pre> +<div class="block">The default behavior of this method is to call + <code>getPortletMode()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPortletMode()">getPortletMode</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the portlet mode</dd></dl> +</li> +</ul> +<a name="getPortletSession()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletSession</h4> +<pre>public <a href="../../../javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a> getPortletSession()</pre> +<div class="block">The default behavior of this method is to call + <code>getPortletSession()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPortletSession()">getPortletSession</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public <a href="../../../javax/portlet/PortletSession.html" title="interface in javax.portlet">PortletSession</a> getPortletSession(boolean create)</pre> +<div class="block">The default behavior of this method is to call + <code>getPortletSession(create)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPortletSession(boolean)">getPortletSession</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getPreferences()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreferences</h4> +<pre>public <a href="../../../javax/portlet/PortletPreferences.html" title="interface in javax.portlet">PortletPreferences</a> getPreferences()</pre> +<div class="block">The default behavior of this method is to call + <code>getPreferences()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPreferences()">getPreferences</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the portlet preferences</dd></dl> +</li> +</ul> +<a name="getProperties(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <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">The default behavior of this method is to call + <code>getProperteis(name)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getProperties(java.lang.String)">getProperties</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></dl> +</li> +</ul> +<a name="getProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperty</h4> +<pre>public <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">The default behavior of this method is to call + <code>getProperty(name)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getProperty(java.lang.String)">getProperty</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></dl> +</li> +</ul> +<a name="getPropertyNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre>public <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">The default behavior of this method is to call + <code>getPropertyNames()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPropertyNames()">getPropertyNames</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getRemoteUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemoteUser</h4> +<pre>public <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">The default behavior of this method is to call + <code>getRemoteUser()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getRemoteUser()">getRemoteUser</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getRequestedSessionId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequestedSessionId</h4> +<pre>public <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">The default behavior of this method is to call + <code>getRequestedSessionId()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getRequestedSessionId()">getRequestedSessionId</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>PortletRequest.isRequestedSessionIdValid()</code></a></dd></dl> +</li> +</ul> +<a name="getResponseContentType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseContentType</h4> +<pre>public <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">The default behavior of this method is to call + <code>getResponseContentType()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getResponseContentType()">getResponseContentType</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public <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">The default behavior of this method is to call + <code>getResponseContentTypes()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getResponseContentTypes()">getResponseContentTypes</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>ordered list of MIME types for the response</dd></dl> +</li> +</ul> +<a name="getScheme()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScheme</h4> +<pre>public <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">The default behavior of this method is to call + <code>getScheme()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getScheme()">getScheme</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public <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">The default behavior of this method is to call + <code>getServerName()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getServerName()">getServerName</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>public int getServerPort()</pre> +<div class="block">The default behavior of this method is to call + <code>getServerPort()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getServerPort()">getServerPort</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer specifying the port number</dd></dl> +</li> +</ul> +<a name="getUserPrincipal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserPrincipal</h4> +<pre>public <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">The default behavior of this method is to call + <code>getUserPrincipal()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getUserPrincipal()">getUserPrincipal</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="getWindowID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowID</h4> +<pre>public <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">The default behavior of this method is to call + <code>getWindowId()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getWindowID()">getWindowID</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the portlet window ID</dd></dl> +</li> +</ul> +<a name="getWindowState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowState</h4> +<pre>public <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> getWindowState()</pre> +<div class="block">The default behavior of this method is to call + <code>getWindowState()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getWindowState()">getWindowState</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the window state</dd></dl> +</li> +</ul> +<a name="isPortletModeAllowed(javax.portlet.PortletMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPortletModeAllowed</h4> +<pre>public boolean isPortletModeAllowed(<a href="../../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> mode)</pre> +<div class="block">The default behavior of this method is to call + <code>isPortletModeAllowed(mode)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#isPortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="isRequestedSessionIdValid()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRequestedSessionIdValid</h4> +<pre>public boolean isRequestedSessionIdValid()</pre> +<div class="block">The default behavior of this method is to call + <code>isRequestedSessionIdValid()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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>PortletRequest.getRequestedSessionId()</code></a>, +<a href="../../../javax/portlet/PortletRequest.html#getPortletSession()"><code>PortletRequest.getPortletSession()</code></a></dd></dl> +</li> +</ul> +<a name="isSecure()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSecure</h4> +<pre>public boolean isSecure()</pre> +<div class="block">The default behavior of this method is to call + <code>isSecure()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#isSecure()">isSecure</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true, if the request was made using a secure channel.</dd></dl> +</li> +</ul> +<a name="isUserInRole(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUserInRole</h4> +<pre>public 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">The default behavior of this method is to call + <code>isUserInRole(role)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#isUserInRole(java.lang.String)">isUserInRole</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="isWindowStateAllowed(javax.portlet.WindowState)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isWindowStateAllowed</h4> +<pre>public boolean isWindowStateAllowed(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</pre> +<div class="block">The default behavior of this method is to call + <code>isWindowStateAllowed(state)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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="removeAttribute(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeAttribute</h4> +<pre>public 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">The default behavior of this method is to call + <code>removeAttribute(name)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#removeAttribute(java.lang.String)">removeAttribute</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></dl> +</li> +</ul> +<a name="setAttribute(java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAttribute</h4> +<pre>public 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">The default behavior of this method is to call + <code>setAttribute(name, o)</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></dl> +</li> +</ul> +<a name="getRequest()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequest</h4> +<pre>public <a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> getRequest()</pre> +<div class="block">Return the wrapped request object.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the wrapped request</dd></dl> +</li> +</ul> +<a name="setRequest(javax.portlet.PortletRequest)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequest</h4> +<pre>public void setRequest(<a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request)</pre> +<div class="block">Sets the request object being wrapped.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the request to set</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 the request is null.</dd></dl> +</li> +</ul> +<a name="getCookies()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCookies</h4> +<pre>public javax.servlet.http.Cookie[] getCookies()</pre> +<div class="block">The default behavior of this method is to call + <code>getCookies()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getCookies()">getCookies</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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">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>public <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">The default behavior of this method is to call + <code>getPrivateParameterMap()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPrivateParameterMap()">getPrivateParameterMap</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></dl> +</li> +</ul> +<a name="getPublicParameterMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPublicParameterMap</h4> +<pre>public <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">The default behavior of this method is to call + <code>getPublicParameterMap()</code> on the wrapped request object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../javax/portlet/PortletRequest.html#getPublicParameterMap()">getPublicParameterMap</a></code> in interface <code><a href="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a></code></dd> +<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></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/PortletRequestWrapper.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/filter/PortletFilter.html" title="interface in javax.portlet.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/PortletRequestWrapper.html" target="_top">Frames</a></li> +<li><a href="PortletRequestWrapper.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>
