Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequestDispatcher.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequestDispatcher.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequestDispatcher.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletRequestDispatcher.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,318 @@ +<!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>PortletRequestDispatcher (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="PortletRequestDispatcher (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/PortletRequestDispatcher.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/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletRequestDispatcher.html" target="_top">Frames</a></li> +<li><a href="PortletRequestDispatcher.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Interface PortletRequestDispatcher" class="title">Interface PortletRequestDispatcher</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">PortletRequestDispatcher</span></pre> +<div class="block">The <code>PortletRequestDispatcher</code> interface defines an object that + receives requests from the client and sends them to the specified resources + (such as a servlet, HTML file, or JSP file) on the server. The portlet + container creates the <code>PortletRequestDispatcher</code> object, which + is used as a wrapper around a server resource located at a particular path or + given by a particular name.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequestDispatcher.html#forward(javax.portlet.PortletRequest,%20javax.portlet.PortletResponse)">forward</a></strong>(<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request, + <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response)</code> +<div class="block">Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) + on the server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequestDispatcher.html#include(javax.portlet.PortletRequest,%20javax.portlet.PortletResponse)">include</a></strong>(<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request, + <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response)</code> +<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the + response.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletRequestDispatcher.html#include(javax.portlet.RenderRequest,%20javax.portlet.RenderResponse)">include</a></strong>(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response)</code> +<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the + response.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="include(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>include</h4> +<pre>void include(<a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</a> request, + <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the + response. In essence, this method enables programmatic server-side + includes. + <p> + The included servlet cannot set or change the response status code or set + headers; any attempt to make a change is ignored. + <p> + This method is kept in order to provide backward compatibility with + version 1.0. Please use <a href="../../javax/portlet/PortletRequestDispatcher.html#include(javax.portlet.PortletRequest,%20javax.portlet.PortletResponse)"><code>include(PortletRequest, PortletResponse)</code></a> instead + of this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - a <a href="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet"><code>RenderRequest</code></a> object that contains the client + request. Must be either the render request passed to the + portlet in <code>render</code> or a wrapped version of this + render request.</dd><dd><code>response</code> - a <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet"><code>RenderResponse</code></a> object that contains the render + response. Must be either the render response passed to the + portlet in <code>render</code> or a wrapped version of this + render response.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the included resource throws a ServletException, or + other exceptions that are not Runtime- or IOExceptions.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the included resource throws this exception</dd></dl> +</li> +</ul> +<a name="include(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>include</h4> +<pre>void include(<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request, + <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the + response. In essence, this method enables programmatic server-side + includes. + <p> + The included servlet cannot set or change the response status code or set + headers; any attempt to make a change is ignored.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - a <a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet"><code>PortletRequest</code></a> object that contains the portlet + request. Must be either the original request passed to the + portlet or a wrapped version of this request.</dd><dd><code>response</code> - a <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><code>PortletResponse</code></a> object that contains the portlet + response. Must be either the portlet response passed to the + portlet or a wrapped version of this response.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the included resource throws a ServletException, or + other exceptions that are not Runtime- or IOExceptions.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the included resource throws this exception</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="forward(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forward</h4> +<pre>void forward(<a href="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</a> request, + <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a> response) + throws <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a>, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) + on the server. This method allows the portlet to do preliminary processing of a + request and another resource to generate the response. + <p> + The <code>forward</code> method should be called before the response has been + committed to the portlet container (before response body output has been flushed). + If the response already has been committed, this method throws an + <code>IllegalStateException</code>. Uncommitted output in the response buffer + is automatically cleared before the forward. + <p> + The request and response parameters must be either the same objects as were passed to + the calling portlet or be wrapped versions of these.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - a request object that represents the request to the + portlet</dd><dd><code>response</code> - a reponse object that contains the portlet response</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if the included resource throws a ServletException, or + other exceptions that are not Runtime- or IOExceptions.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the included resource throws this exception</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the response was already committed</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/PortletRequestDispatcher.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/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletRequestDispatcher.html" target="_top">Frames</a></li> +<li><a href="PortletRequestDispatcher.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,425 @@ +<!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>PortletResponse (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="PortletResponse (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/PortletResponse.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/PortletRequestDispatcher.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletResponse.html" target="_top">Frames</a></li> +<li><a href="PortletResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Interface PortletResponse" class="title">Interface PortletResponse</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/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a>, <a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</a>, <a href="../../javax/portlet/MimeResponse.html" title="interface in javax.portlet">MimeResponse</a>, <a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</a>, <a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet">ResourceResponse</a>, <a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter">ActionResponseWrapper</a>, <a href="../../javax/portlet/filter/EventResponseWrapper.html" title="class in javax.portlet.filter">EventResponseWrapper</a>, <a href="../../javax/portlet/filter/PortletResponseWrapper.html" title="class in javax.portlet.filter">PortletResponseWrapper</a>, <a href="../../javax/portlet/filter/RenderResponseWrapper.html" title="class in javax.portlet.filter">RenderResponseWrapper</a>, <a href="../../javax/portlet/filter/ResourceResponseWrapper.html" title="class in javax.portlet.filter">ResourceResponseWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">PortletResponse</span></pre> +<div class="block">The <CODE>PortletResponse</CODE> defines the base interface to assist a + portlet in creating and sending a response to the client. The portlet + container uses specialized versions of this interface when invoking a + portlet. + The portlet container creates these objects and passes them as arguments to + the portlet's <CODE>processAction, processEvent, serveResource</CODE> and <CODE>render</CODE> methods.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet"><code>ActionResponse</code></a>, +<a href="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet"><code>RenderResponse</code></a>, +<a href="../../javax/portlet/EventResponse.html" title="interface in javax.portlet"><code>EventResponse</code></a>, +<a href="../../javax/portlet/ResourceResponse.html" title="interface in javax.portlet"><code>ResourceResponse</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty</a></strong>(javax.servlet.http.Cookie cookie)</code> +<div class="block">Adds a HTTP Cookie property to the response.<br> + The portlet should note that the cookie may not make + it to the client, but may be stored at the portal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</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> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a> element)</code> +<div class="block">Adds an XML DOM element property to the response.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</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> key, + <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> value)</code> +<div class="block">Adds a String property to an existing key to be returned to the portal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletResponse.html#createElement(java.lang.String)">createElement</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> tagName)</code> +<div class="block">Creates an element of the type specified to be used in the + <a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)"><code>addProperty(String,Element)</code></a> method.</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/PortletResponse.html#encodeURL(java.lang.String)">encodeURL</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> path)</code> +<div class="block">Returns the encoded URL of the resource, like servlets, JSPs, images and + other static files, at the given path.</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/PortletResponse.html#getNamespace()">getNamespace</a></strong>()</code> +<div class="block">The value returned by this method should be prefixed or appended to + elements, such as JavaScript variables or function names, to ensure they + are unique in the context of the portal page.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletResponse.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</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> key, + <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> value)</code> +<div class="block">Sets a String property to be returned to the portal.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>void addProperty(<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> key, + <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> value)</pre> +<div class="block">Adds a String property to an existing key to be returned to the portal. + If there are no property values already associated with the key, + a new key is created. + <p> + This method allows response properties to have multiple values. + <p> + Response properties can be viewed as header values set for the portal application. + If these header values are intended to be transmitted to the client they should be + set before the response is committed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property to be returned to the portal</dd><dd><code>value</code> - the value of the property to be returned to the portal</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if key is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="setProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>void setProperty(<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> key, + <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> value)</pre> +<div class="block">Sets a String property to be returned to the portal. + <p> + Response properties can be viewed as header values set for the portal application. + If these header values are intended to be transmitted to the client they should be + set before the response is committed. + <p> + This method resets all properties previously added with the same key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property to be returned to the portal</dd><dd><code>value</code> - the value of the property to be returned to the portal</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if key is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="encodeURL(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeURL</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> encodeURL(<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> path)</pre> +<div class="block">Returns the encoded URL of the resource, like servlets, JSPs, images and + other static files, at the given path. + <p> + Portlets should encode all resource URLs pointing to resources in the + portlet application via this method in order to ensure that they get + served via the portal application. + <p> + Some portal/portlet-container implementation may require those URLs to + contain implementation specific data encoded in it. Because of that, + portlets should use this method to create such URLs. + <p> + The <code>encodeURL</code> method may include the session ID and other + portal/portlet-container specific information into the URL. If encoding + is not needed, it returns the URL unchanged. + <p> + Portlet developer should be aware that the returned URL might not be a well formed + URL but a special token at the time the portlet is generating its content. + Thus portlets should not add additional parameters on the resulting URL or + expect to be able to parse the URL. As a result, the outcome of the encodeURL + call may be different than calling encodeURL in the servlet world.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the URI path to the resource. This must be either an absolute + URL (e.g. + <code>http://my.co/myportal/mywebap/myfolder/myresource.gif</code>) + or a full path URI (e.g. + <code>/myportal/mywebap/myfolder/myresource.gif</code>).</dd> +<dt><span class="strong">Returns:</span></dt><dd>the encoded resource URL as string, may not be a valid URL</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 path doesn't have a leading slash or is not an absolute + URL</dd></dl> +</li> +</ul> +<a name="getNamespace()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamespace</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> getNamespace()</pre> +<div class="block">The value returned by this method should be prefixed or appended to + elements, such as JavaScript variables or function names, to ensure they + are unique in the context of the portal page. + <p> + The namespace value must be constant for the lifetime of the portlet + window.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the namespace</dd></dl> +</li> +</ul> +<a name="addProperty(javax.servlet.http.Cookie)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>void addProperty(javax.servlet.http.Cookie cookie)</pre> +<div class="block">Adds a HTTP Cookie property to the response.<br> + The portlet should note that the cookie may not make + it to the client, but may be stored at the portal. + <p> + This method allows response properties to have multiple cookies. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cookie</code> - the cookie to be added to the response</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 cookie is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="addProperty(java.lang.String, org.w3c.dom.Element)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>void addProperty(<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> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a> element)</pre> +<div class="block">Adds an XML DOM element property to the response. + <p> + If a DOM element with the provided key already exists + the provided element will be stored in addition to the + existing element under the same key. + <p> + If the element is <code>null</code> the key is removed from + the response. + <p> + Response XML DOM element properties can be viewed as + additional response document sections + set for the portal application. + If these header values are intended to be transmitted to the client they should be + set before the response is committed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the property to be returned to the portal</dd><dd><code>element</code> - the XML DOM element to be added to the response</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 key is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="createElement(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createElement</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true"; title="class or interface in org.w3c.dom">Element</a> createElement(<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> tagName) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/DOMException.html?is-external=true"; title="class or interface in org.w3c.dom">DOMException</a></pre> +<div class="block">Creates an element of the type specified to be used in the + <a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)"><code>addProperty(String,Element)</code></a> method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tagName</code> - name of the element type to instantiate</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new Element object with the nodeName attribute set to tagName, + and localName, prefix, and namespaceURI set to null.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/DOMException.html?is-external=true"; title="class or interface in org.w3c.dom">DOMException</a></code> - INVALID_CHARACTER_ERR: Raised if the specified name + contains an illegal character.</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/PortletResponse.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/PortletRequestDispatcher.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletResponse.html" target="_top">Frames</a></li> +<li><a href="PortletResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSecurityException.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSecurityException.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSecurityException.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletSecurityException.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,316 @@ +<!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>PortletSecurityException (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="PortletSecurityException (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/PortletSecurityException.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/PortletResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletSecurityException.html" target="_top">Frames</a></li> +<li><a href="PortletSecurityException.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="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Class PortletSecurityException" class="title">Class PortletSecurityException</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><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">javax.portlet.PortletException</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.PortletSecurityException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PortletSecurityException</span> +extends <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<div class="block">A portlet should throw a <CODE>PortletSecurityException</CODE> + when a call fails because of security reasons.<br> + Additionally it can be thrown by the portal/portlet-container.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#javax.portlet.PortletSecurityException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/PortletSecurityException.html#PortletSecurityException(java.lang.String)">PortletSecurityException</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> text)</code> +<div class="block">Constructs a new security exception with the given text.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/PortletSecurityException.html#PortletSecurityException(java.lang.String,%20java.lang.Throwable)">PortletSecurityException</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> text, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<div class="block">Constructs a new portlet security exception when the portlet needs to do + the following: + + <il>throw an exception + include a message about the "root cause" that interfered + with its normal operation + include a description message + </div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/PortletSecurityException.html#PortletSecurityException(java.lang.Throwable)">PortletSecurityException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<div class="block">Constructs a new portlet security exception when the portlet needs to throw an + exception.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace( )" title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http: //docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code></li> +</ul> +<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#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="PortletSecurityException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PortletSecurityException</h4> +<pre>public PortletSecurityException(<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> text)</pre> +<div class="block">Constructs a new security exception with the given text. The + portlet container may use the text write it to a log.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the exception text</dd></dl> +</li> +</ul> +<a name="PortletSecurityException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PortletSecurityException</h4> +<pre>public PortletSecurityException(<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> text, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<div class="block">Constructs a new portlet security exception when the portlet needs to do + the following: + <ul> + <il>throw an exception + <li>include a message about the "root cause" that interfered + with its normal operation + <li>include a description message + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the exception text</dd><dd><code>cause</code> - the root cause</dd></dl> +</li> +</ul> +<a name="PortletSecurityException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PortletSecurityException</h4> +<pre>public PortletSecurityException(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<div class="block">Constructs a new portlet security exception when the portlet needs to throw an + exception. The exception message is based on the localized message + of the underlying exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - the root cause</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/PortletSecurityException.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/PortletResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletSession.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/PortletSecurityException.html" target="_top">Frames</a></li> +<li><a href="PortletSecurityException.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="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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>
