Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletConfig.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletConfig.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletConfig.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletConfig.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,527 @@ +<!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>PortletConfig (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="PortletConfig (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/PortletConfig.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/Portlet.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletContext.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/PortletConfig.html" target="_top">Frames</a></li> +<li><a href="PortletConfig.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 PortletConfig" class="title">Interface PortletConfig</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">PortletConfig</span></pre> +<div class="block">The <CODE>PortletConfig</CODE> interface provides the portlet with + its configuration. The configuration holds information about the + portlet that is valid for all users. The configuration is retrieved + from the portlet definition in the deployment descriptor. + The portlet can only read the configuration data. + <p> + The configuration information contains the portlet name, the portlet + initialization parameters, the portlet resource bundle and the portlet + application context.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/Portlet.html" title="interface in javax.portlet"><code>Portlet</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><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/PortletConfig.html#getContainerRuntimeOptions()">getContainerRuntimeOptions</a></strong>()</code> +<div class="block">Returns the container runtime options + and values for this portlet.</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/PortletConfig.html#getDefaultNamespace()">getDefaultNamespace</a></strong>()</code> +<div class="block">Returns the default namespace for events and public render parameters.</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/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns a String containing the value of the named initialization parameter, + or null if the parameter does not exist.</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/PortletConfig.html#getInitParameterNames()">getInitParameterNames</a></strong>()</code> +<div class="block">Returns the names of the portlet initialization parameters as an + <code>Enumeration</code> of String objects, or an empty <code>Enumeration</code> if the + portlet has no initialization parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</a></strong>()</code> +<div class="block">Returns the <code>PortletContext</code> of the portlet application + the portlet is in.</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/PortletConfig.html#getPortletName()">getPortletName</a></strong>()</code> +<div class="block">Returns the name of the portlet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/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/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">getProcessingEventQNames</a></strong>()</code> +<div class="block">Returns the QNames of the processing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any processing events.</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/PortletConfig.html#getPublicRenderParameterNames()">getPublicRenderParameterNames</a></strong>()</code> +<div class="block">Returns the names of the public render parameters supported by the portlet + as an <code>Enumeration</code> of <code>String</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined public render parameters.</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/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">getPublishingEventQNames</a></strong>()</code> +<div class="block">Returns the QNames of the publishing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any publishing events.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/ResourceBundle.html?is-external=true"; title="class or interface in java.util">ResourceBundle</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</a></strong>(<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> locale)</code> +<div class="block">Gets the resource bundle for the given locale based on the + resource bundle defined in the deployment descriptor + with <code>resource-bundle</code> tag or the inlined resources + defined in the deployment descriptor.</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/PortletConfig.html#getSupportedLocales()">getSupportedLocales</a></strong>()</code> +<div class="block">Returns the locales supported by the portlet + as an <code>Enumeration</code> of <code>Locale</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any supported locales.</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="getPortletName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletName</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> getPortletName()</pre> +<div class="block">Returns the name of the portlet. + <P> + The name may be provided via server administration, assigned in the + portlet application deployment descriptor with the <code>portlet-name</code> + tag.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet name</dd></dl> +</li> +</ul> +<a name="getPortletContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletContext</h4> +<pre><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</a> getPortletContext()</pre> +<div class="block">Returns the <code>PortletContext</code> of the portlet application + the portlet is in.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>PortletContext</code> object, used by the + caller to interact with its portlet container</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><code>PortletContext</code></a></dd></dl> +</li> +</ul> +<a name="getResourceBundle(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceBundle</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/ResourceBundle.html?is-external=true"; title="class or interface in java.util">ResourceBundle</a> getResourceBundle(<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> locale)</pre> +<div class="block">Gets the resource bundle for the given locale based on the + resource bundle defined in the deployment descriptor + with <code>resource-bundle</code> tag or the inlined resources + defined in the deployment descriptor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the locale for which to retrieve the resource bundle</dd> +<dt><span class="strong">Returns:</span></dt><dd>the resource bundle for the given locale</dd></dl> +</li> +</ul> +<a name="getInitParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameter</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> getInitParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns a String containing the value of the named initialization parameter, + or null if the parameter does not exist.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name + of the initialization parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the value + of the initialization parameter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getInitParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameterNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getInitParameterNames()</pre> +<div class="block">Returns the names of the portlet initialization parameters as an + <code>Enumeration</code> of String objects, or an empty <code>Enumeration</code> if the + portlet has no initialization parameters.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> + objects containing the names of the portlet + initialization parameters, or an empty <code>Enumeration</code> if the + portlet has no initialization parameters.</dd></dl> +</li> +</ul> +<a name="getPublicRenderParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPublicRenderParameterNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getPublicRenderParameterNames()</pre> +<div class="block">Returns the names of the public render parameters supported by the portlet + as an <code>Enumeration</code> of <code>String</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined public render parameters. + <p> + Public render parameters are defined in the portlet deployment descriptor + with the <code>supported-public-render-parameter</code> element.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> + objects containing the names of the public + render parameters, or an empty <code>Enumeration</code> if the + portlet has not defined support for any public render parameters + in the portlet deployment descriptor.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getDefaultNamespace()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultNamespace</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> getDefaultNamespace()</pre> +<div class="block">Returns the default namespace for events and public render parameters. + This namespace is defined in the portlet deployment descriptor + with the <code>default-namespace</code> element. + <p> + If no default namespace is defined in the portlet deployment + descriptor this methods returns the XML default namespace + <code>XMLConstants.NULL_NS_URI</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the default namespace defined in the portlet deployment + descriptor, or <code>XMLConstants.NULL_NS_URI</code> is non is + defined.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getPublishingEventQNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPublishingEventQNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>> getPublishingEventQNames()</pre> +<div class="block">Returns the QNames of the publishing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any publishing events. + <p> + Publishing events are defined in the portlet deployment descriptor + with the <code>supported-publishing-event</code> element. + <p> + Note that this call does not return any events published that have not been + declared in the deployment descriptor as supported. + <p> + If the event was defined using the <code>name</code> element instead of + the <code>qname</code> element the defined default namespace + is added as namespace for the returned QName.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>QName</code> + objects containing the names of the publishing events, + or an empty <code>Enumeration</code> if the + portlet has not defined any support for publishing events in + the deployment descriptor.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getProcessingEventQNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProcessingEventQNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a>> getProcessingEventQNames()</pre> +<div class="block">Returns the QNames of the processing events supported by the portlet + as an <code>Enumeration</code> of <code>QName</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any processing events. + <p> + Processing events are defined in the portlet deployment descriptor + with the <code>supported-processing-event</code> element. + <p> + If the event was defined using the <code>name</code> element instead of + the <code>qname</code> element the defined default namespace + is added as namespace for the returned QName.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>QName</code> + objects containing the names of the processing events, + or an empty <code>Enumeration</code> if the + portlet has not defined any support for processing events in + the deployment descriptor.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getSupportedLocales()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedLocales</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a>> getSupportedLocales()</pre> +<div class="block">Returns the locales supported by the portlet + as an <code>Enumeration</code> of <code>Locale</code> objects, + or an empty <code>Enumeration</code> if the + portlet has not defined any supported locales. + <p> + Supported locales are defined in the portlet deployment descriptor + with the <code>supported-locale</code> element.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>Locale</code> + objects containing the supported locales, + or an empty <code>Enumeration</code> if the + portlet has not defined any supported locales in + the deployment descriptor.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getContainerRuntimeOptions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getContainerRuntimeOptions</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getContainerRuntimeOptions()</pre> +<div class="block">Returns the container runtime options + and values for this portlet. + <p> + The portlet can set container runtime + options in the <code>portlet.xml</code> via the + <code>container-runtime-option</code> element with a name and a + value on the application and portlet level.<br> + If a container runtime option is set on the portlet application + level and on the portlet level with the same name the setting + on the portlet level takes precedence and overwrites the one + set on the portal application level. + <p> + The map returned from this method will provide the subset the + portlet container supports of the options the portlet has specified + in the <code>portlet.xml</code>. Options that the portlet container + does not support will not be returned in this map. + <p> + The map will contain name of the runtime option as key of type String + and the runtime options as values of type String array (<code>String[]</code>) + with the values specified in the <code>portlet.xml</code> deployment descriptor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable <code>Map</code> containing portlet + container runtime options names as keys and the + container runtime values as map values, or an empty <code>Map</code> + if no portlet container runtime options are set + in the <code>portlet.xml</code> or supported by this portlet container. + The keys in the map are of type String. The values in the map are of type + String array (<code>String[]</code>).</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PortletConfig.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/Portlet.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletContext.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/PortletConfig.html" target="_top">Frames</a></li> +<li><a href="PortletConfig.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/PortletContext.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletContext.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletContext.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/PortletContext.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,775 @@ +<!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>PortletContext (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="PortletContext (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/PortletContext.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/PortletConfig.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletException.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/PortletContext.html" target="_top">Frames</a></li> +<li><a href="PortletContext.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 PortletContext" class="title">Interface PortletContext</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">PortletContext</span></pre> +<div class="block">The <CODE>PortletContext</CODE> interface defines a portlet view + of the portlet container. + The <CODE>PortletContext</CODE> also makes resources available + to the portlet. Using the context, a portlet can access + the portlet log, and obtain URL references to resources. + + <p>There is one context per "portlet application" per Java Virtual Machine. (A + "portlet application" is a collection of portlets, servlets, and content installed + under a specific subset of the server URL namespace, such as <code>/catalog</code>. + They are possibly installed via a <code>.war</code> file.) + As a web application, a portlet application also has a servlet context. + The portlet context leverages most of its functionality from the + servlet context of the portlet application. + <p> + Attributes stored in the context are global for <I>all</I> users and <I>all</I> + components in the portlet application. + <p> + In the case of a web + application marked "distributed" in its deployment descriptor, there will + be one context instance for each virtual machine. In this situation, the + context cannot be used as a location to share global information (because + the information is not truly global). Use an external resource, such as + a database to achieve sharing on a global scope.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="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/PortletContext.html#getAttribute(java.lang.String)">getAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the portlet container attribute with the given name, + or null if there is no attribute by that name.</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/PortletContext.html#getAttributeNames()">getAttributeNames</a></strong>()</code> +<div class="block">Returns an <code>Enumeration</code> containing the attribute names + available within this portlet context, or an empty + <code>Enumeration</code> if no attributes are available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getContainerRuntimeOptions()">getContainerRuntimeOptions</a></strong>()</code> +<div class="block">Returns the container container runtime options + keys supported by this portlet container.</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/PortletContext.html#getInitParameter(java.lang.String)">getInitParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns a String containing the value of the named context-wide + initialization parameter, or <code>null</code> if the parameter does not exist.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/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/PortletContext.html#getInitParameterNames()">getInitParameterNames</a></strong>()</code> +<div class="block">Returns the names of the context initialization parameters as an + <code>Enumeration</code> of String objects, or an empty Enumeration if the context + has no initialization parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getMajorVersion()">getMajorVersion</a></strong>()</code> +<div class="block">Returns the major version of the Portlet API that this portlet + container supports.</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/PortletContext.html#getMimeType(java.lang.String)">getMimeType</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> file)</code> +<div class="block">Returns the MIME type of the specified file, or <code>null</code> if + the MIME type is not known.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getMinorVersion()">getMinorVersion</a></strong>()</code> +<div class="block">Returns the minor version of the Portlet API that this portlet + container supports.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet">PortletRequestDispatcher</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getNamedDispatcher(java.lang.String)">getNamedDispatcher</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns a <a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a> object that acts + as a wrapper for the named servlet.</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/PortletContext.html#getPortletContextName()">getPortletContextName</a></strong>()</code> +<div class="block">Returns the name of this portlet application correponding to this PortletContext as specified + in the <code>web.xml</code> deployment descriptor for this web application by the + <code>display-name</code> element.</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/PortletContext.html#getRealPath(java.lang.String)">getRealPath</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 a <code>String</code> containing the real path + for a given virtual path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet">PortletRequestDispatcher</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getRequestDispatcher(java.lang.String)">getRequestDispatcher</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 a <a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a> object that acts + as a wrapper for the resource located at the given path.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getResource(java.lang.String)">getResource</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 a URL to the resource that is mapped to a specified + path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#getResourceAsStream(java.lang.String)">getResourceAsStream</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 resource located at the given path as an InputStream 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/Set.html?is-external=true"; title="class or interface in java.util">Set</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/PortletContext.html#getResourcePaths(java.lang.String)">getResourcePaths</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 a directory-like listing of all the paths to resources within + the web application longest sub-path of which + matches the supplied path argument.</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/PortletContext.html#getServerInfo()">getServerInfo</a></strong>()</code> +<div class="block">Returns the name and version of the portlet container in which the + portlet is running.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#log(java.lang.String)">log</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> msg)</code> +<div class="block">Writes the specified message to a portlet log file, usually an event log.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#log(java.lang.String,%20java.lang.Throwable)">log</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> message, + <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> throwable)</code> +<div class="block">Writes an explanatory message and a stack trace for a given + Throwable exception to the portlet log file.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.html#removeAttribute(java.lang.String)">removeAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Removes the attribute with the given name from the portlet context.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/PortletContext.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> object)</code> +<div class="block">Binds an object to a given attribute name in this portlet context.</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="getServerInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getServerInfo</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> getServerInfo()</pre> +<div class="block">Returns the name and version of the portlet container in which the + portlet is running. + + <P> + The form of the returned string is <code>containername/versionnumber</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the string containing at least name and version number</dd></dl> +</li> +</ul> +<a name="getRequestDispatcher(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequestDispatcher</h4> +<pre><a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet">PortletRequestDispatcher</a> getRequestDispatcher(<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 a <a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a> object that acts + as a wrapper for the resource located at the given path. + A <code>PortletRequestDispatcher</code> object can be used include the + resource in a response. The resource can be dynamic or static. + + <p>The pathname must begin with a slash (<code> / </code>) and is interpreted as relative + to the current context root. + + <p>This method returns <code>null</code> if the <code>PortletContext</code> + cannot return a <code>PortletRequestDispatcher</code> + for any reason.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - a <code>String</code> specifying the pathname + to the resource</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>PortletRequestDispatcher</code> object + that acts as a wrapper for the resource + at the specified path.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a></dd></dl> +</li> +</ul> +<a name="getNamedDispatcher(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamedDispatcher</h4> +<pre><a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet">PortletRequestDispatcher</a> getNamedDispatcher(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns a <a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a> object that acts + as a wrapper for the named servlet. + + <p>Servlets (and also JSP pages) may be given names via server + administration or via a web application deployment descriptor. + + <p>This method returns <code>null</code> if the + <code>PortletContext</code> cannot return a + <code>PortletRequestDispatcher</code> for any reason.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name + of a servlet to be wrapped</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>PortletRequestDispatcher</code> object + that acts as a wrapper for the named servlet</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletRequestDispatcher.html" title="interface in javax.portlet"><code>PortletRequestDispatcher</code></a></dd></dl> +</li> +</ul> +<a name="getResourceAsStream(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceAsStream</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getResourceAsStream(<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 resource located at the given path as an InputStream object. + The data in the InputStream can be of any type or length. The method returns + null if no resource exists at the given path. + <p> + In order to access protected resources the path has to be prefixed with + <code>/WEB-INF/</code> (for example <code>/WEB-INF/myportlet/myportlet.jsp</code>). + Otherwise, the direct path is used + (for example <code>/myportlet/myportlet.jsp</code>).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path to the resource</dd> +<dt><span class="strong">Returns:</span></dt><dd>the input stream</dd></dl> +</li> +</ul> +<a name="getMajorVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMajorVersion</h4> +<pre>int getMajorVersion()</pre> +<div class="block">Returns the major version of the Portlet API that this portlet + container supports.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the major version</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html#getMinorVersion()"><code>getMinorVersion()</code></a></dd></dl> +</li> +</ul> +<a name="getMinorVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinorVersion</h4> +<pre>int getMinorVersion()</pre> +<div class="block">Returns the minor version of the Portlet API that this portlet + container supports.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the minor version</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html#getMajorVersion()"><code>getMajorVersion()</code></a></dd></dl> +</li> +</ul> +<a name="getMimeType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMimeType</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> getMimeType(<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> file)</pre> +<div class="block">Returns the MIME type of the specified file, or <code>null</code> if + the MIME type is not known. The MIME type is determined + by the configuration of the portlet container and may be specified + in a web application deployment descriptor. Common MIME + types are <code>text/html</code> and <code>image/gif</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - a <code>String</code> specifying the name + of a file</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the MIME type of the file</dd></dl> +</li> +</ul> +<a name="getRealPath(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRealPath</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> getRealPath(<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 a <code>String</code> containing the real path + for a given virtual path. For example, the path <code>/index.html</code> + returns the absolute file path of the portlet container file system. + + <p>The real path returned will be in a form + appropriate to the computer and operating system on + which the portlet container is running, including the + proper path separators. This method returns <code>null</code> + if the portlet container cannot translate the virtual path + to a real path for any reason (such as when the content is + being made available from a <code>.war</code> archive).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - a <code>String</code> specifying a virtual path</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> specifying the real path, + or null if the transformation cannot be performed.</dd></dl> +</li> +</ul> +<a name="getResourcePaths(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourcePaths</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> getResourcePaths(<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 a directory-like listing of all the paths to resources within + the web application longest sub-path of which + matches the supplied path argument. Paths indicating subdirectory paths + end with a slash (<code>/</code>). The returned paths are all + relative to the root of the web application and have a leading slash. + For example, for a web application + containing<br><br> + <code> + /welcome.html<br> + /catalog/index.html<br> + /catalog/products.html<br> + /catalog/offers/books.html<br> + /catalog/offers/music.html<br> + /customer/login.jsp<br> + /WEB-INF/web.xml<br> + /WEB-INF/classes/com.acme.OrderPortlet.class,<br><br> + </code> + + <code>getResourcePaths("/")</code> returns + <code>{"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}</code><br> + <code>getResourcePaths("/catalog/")</code> returns + <code>{"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}</code>.<br></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the partial path used to match the resources, which must start with a slash</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Set containing the directory listing, or <code>null</code> if there + are no resources in the web application of which the path + begins with the supplied path.</dd></dl> +</li> +</ul> +<a name="getResource(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResource</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> getResource(<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) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/MalformedURLException.html?is-external=true"; title="class or interface in java.net">MalformedURLException</a></pre> +<div class="block">Returns a URL to the resource that is mapped to a specified + path. The path must begin with a slash (<code>/</code>) and is interpreted + as relative to the current context root. + + <p>This method allows the portlet container to make a resource + available to portlets from any source. Resources + can be located on a local or remote + file system, in a database, or in a <code>.war</code> file. + + <p>The portlet container must implement the URL handlers + and <code>URLConnection</code> objects that are necessary + to access the resource. + + <p>This method returns <code>null</code> + if no resource is mapped to the pathname. + + <p>Some containers may allow writing to the URL returned by + this method using the methods of the URL class. + + <p>The resource content is returned directly, so be aware that + requesting a <code>.jsp</code> page returns the JSP source code. + Use a <code>RequestDispatcher</code> instead to include results of + an execution. + + <p>This method has a different purpose than + <code>java.lang.Class.getResource</code>, + which looks up resources based on a class loader. This + method does not use class loaders.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - a <code>String</code> specifying + the path to the resource</dd> +<dt><span class="strong">Returns:</span></dt><dd>the resource located at the named path, + or <code>null</code> if there is no resource + at that path</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/MalformedURLException.html?is-external=true"; title="class or interface in java.net">MalformedURLException</a></code> - if the pathname is not given in + the correct form</dd></dl> +</li> +</ul> +<a name="getAttribute(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttribute</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the portlet container attribute with the given name, + or null if there is no attribute by that name. + An attribute allows a portlet container to give the + portlet additional information not + already provided by this interface. + A list of supported attributes can be retrieved using + <code>getAttributeNames</code>. + + <p>The attribute is returned as a <code>java.lang.Object</code> + or some subclass. + Attribute names should follow the same convention as package + names. The Java Portlet API specification reserves names + matching <code>java.*</code>, <code>javax.*</code>, + and <code>sun.*</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name + of the attribute</dd> +<dt><span class="strong">Returns:</span></dt><dd>an <code>Object</code> containing the value + of the attribute, or <code>null</code> + if no attribute exists matching the given + name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html#getAttributeNames()"><code>getAttributeNames()</code></a></dd></dl> +</li> +</ul> +<a name="getAttributeNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttributeNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getAttributeNames()</pre> +<div class="block">Returns an <code>Enumeration</code> containing the attribute names + available within this portlet context, or an empty + <code>Enumeration</code> if no attributes are available. Use the + <a href="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a> method with an attribute name + to get the value of an attribute.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of attribute names</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="getInitParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameter</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> getInitParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns a String containing the value of the named context-wide + initialization parameter, or <code>null</code> if the parameter does not exist. + This method provides configuration information which may be useful for + an entire "portlet application".</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> containing the name of the + requested parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the value + of the initialization parameter, or + <code>null</code> if the parameter does not exist.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html#getInitParameterNames()"><code>getInitParameterNames()</code></a></dd></dl> +</li> +</ul> +<a name="getInitParameterNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitParameterNames</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getInitParameterNames()</pre> +<div class="block">Returns the names of the context initialization parameters as an + <code>Enumeration</code> of String objects, or an empty Enumeration if the context + has no initialization parameters.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> + objects containing the names of the context + initialization parameters</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletContext.html#getInitParameter(java.lang.String)"><code>getInitParameter(java.lang.String)</code></a></dd></dl> +</li> +</ul> +<a name="log(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>log</h4> +<pre>void log(<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> msg)</pre> +<div class="block">Writes the specified message to a portlet log file, usually an event log. + The name and type of the portlet log file is specific to the portlet container. + <p> + This method mapps to the <code>ServletContext.log</code> method. + The portlet container may in addition log this message in a + portlet container specific log file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - a <code>String</code> specifying the + message to be written to the log file</dd></dl> +</li> +</ul> +<a name="log(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>log</h4> +<pre>void log(<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> message, + <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> throwable)</pre> +<div class="block">Writes an explanatory message and a stack trace for a given + Throwable exception to the portlet log file. + The name and type of the portlet log file is specific to the + portlet container, usually an event log. + <p> + This method is mapped to the <code>ServletContext.log</code> method. + The portlet container may in addition log this message in a + portlet container specific log file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - a <code>String</code> that + describes the error or exception</dd><dd><code>throwable</code> - the <code>Throwable</code> error + or exception</dd></dl> +</li> +</ul> +<a name="removeAttribute(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeAttribute</h4> +<pre>void removeAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Removes the attribute with the given name from the portlet context. + After removal, subsequent calls to + <a href="../../javax/portlet/PortletContext.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a> to retrieve the attribute's value + will return <code>null</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name + of the attribute to be removed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="setAttribute(java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAttribute</h4> +<pre>void setAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> object)</pre> +<div class="block">Binds an object to a given attribute name in this portlet context. + If the name specified is already used for an attribute, this method + removes the old attribute and binds the name to the new attribute. + <p> + If a null value is passed, the effect is the same as calling + <code>removeAttribute()</code>. + + <p>Attribute names should follow the same convention as package + names. The Java Portlet API specification reserves names + matching <code>java.*</code>, <code>javax.*</code>, and + <code>sun.*</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name + of the attribute</dd><dd><code>object</code> - an <code>Object</code> representing the + attribute to be bound</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getPortletContextName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletContextName</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> getPortletContextName()</pre> +<div class="block">Returns the name of this portlet application correponding to this PortletContext as specified + in the <code>web.xml</code> deployment descriptor for this web application by the + <code>display-name</code> element.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The name of the web application or null if no name has been declared in the deployment descriptor.</dd></dl> +</li> +</ul> +<a name="getContainerRuntimeOptions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getContainerRuntimeOptions</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getContainerRuntimeOptions()</pre> +<div class="block">Returns the container container runtime options + keys supported by this portlet container.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>container runtime options keys supported by this + container as String values.</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/PortletContext.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/PortletConfig.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/PortletException.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/PortletContext.html" target="_top">Frames</a></li> +<li><a href="PortletContext.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>
