/usr/share/doc/libportlet-api-2.0-spec-java/api/javax/portlet/PortletConfig.html is in libportlet-api-2.0-spec-java-doc 1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Sun Jun 27 09:02:34 UTC 2010 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PortletConfig (Java Portlet Specification V2.0 1.0 API)
</TITLE>
<META NAME="date" CONTENT="2010-06-27">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PortletConfig (Java Portlet Specification V2.0 1.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PortletConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/PortletConfig.html" target="_top"><B>FRAMES</B></A>
<A HREF="PortletConfig.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.portlet</FONT>
<BR>
Interface PortletConfig</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>PortletConfig</B></DL>
</PRE>
<P>
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.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet"><CODE>Portlet</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map<java.lang.String,java.lang.String[]></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getContainerRuntimeOptions()">getContainerRuntimeOptions</A></B>()</CODE>
<BR>
Returns the container runtime options
and values for this portlet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getDefaultNamespace()">getDefaultNamespace</A></B>()</CODE>
<BR>
Returns the default namespace for events and public render parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</A></B>(java.lang.String name)</CODE>
<BR>
Returns a String containing the value of the named initialization parameter,
or null if the parameter does not exist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames</A></B>()</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</A></B>()</CODE>
<BR>
Returns the <code>PortletContext</code> of the portlet application
the portlet is in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPortletName()">getPortletName</A></B>()</CODE>
<BR>
Returns the name of the portlet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<javax.xml.namespace.QName></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">getProcessingEventQNames</A></B>()</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPublicRenderParameterNames()">getPublicRenderParameterNames</A></B>()</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<javax.xml.namespace.QName></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">getPublishingEventQNames</A></B>()</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.ResourceBundle</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></B>(java.util.Locale locale)</CODE>
<BR>
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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<java.util.Locale></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getSupportedLocales()">getSupportedLocales</A></B>()</CODE>
<BR>
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.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getPortletName()"><!-- --></A><H3>
getPortletName</H3>
<PRE>
java.lang.String <B>getPortletName</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the portlet name</DL>
</DD>
</DL>
<HR>
<A NAME="getPortletContext()"><!-- --></A><H3>
getPortletContext</H3>
<PRE>
<A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A> <B>getPortletContext</B>()</PRE>
<DL>
<DD>Returns the <code>PortletContext</code> of the portlet application
the portlet is in.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <code>PortletContext</code> object, used by the
caller to interact with its portlet container<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><CODE>PortletContext</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getResourceBundle(java.util.Locale)"><!-- --></A><H3>
getResourceBundle</H3>
<PRE>
java.util.ResourceBundle <B>getResourceBundle</B>(java.util.Locale locale)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which to retrieve the resource bundle
<DT><B>Returns:</B><DD>the resource bundle for the given locale</DL>
</DD>
</DL>
<HR>
<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
getInitParameter</H3>
<PRE>
java.lang.String <B>getInitParameter</B>(java.lang.String name)</PRE>
<DL>
<DD>Returns a String containing the value of the named initialization parameter,
or null if the parameter does not exist.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
of the initialization parameter
<DT><B>Returns:</B><DD>a <code>String</code> containing the value
of the initialization parameter
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="getInitParameterNames()"><!-- --></A><H3>
getInitParameterNames</H3>
<PRE>
java.util.Enumeration<java.lang.String> <B>getInitParameterNames</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><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.</DL>
</DD>
</DL>
<HR>
<A NAME="getPublicRenderParameterNames()"><!-- --></A><H3>
getPublicRenderParameterNames</H3>
<PRE>
java.util.Enumeration<java.lang.String> <B>getPublicRenderParameterNames</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><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.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultNamespace()"><!-- --></A><H3>
getDefaultNamespace</H3>
<PRE>
java.lang.String <B>getDefaultNamespace</B>()</PRE>
<DL>
<DD>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>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the default namespace defined in the portlet deployment
descriptor, or <code>XMLConstants.NULL_NS_URI</code> is non is
defined.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPublishingEventQNames()"><!-- --></A><H3>
getPublishingEventQNames</H3>
<PRE>
java.util.Enumeration<javax.xml.namespace.QName> <B>getPublishingEventQNames</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><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.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProcessingEventQNames()"><!-- --></A><H3>
getProcessingEventQNames</H3>
<PRE>
java.util.Enumeration<javax.xml.namespace.QName> <B>getProcessingEventQNames</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><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.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSupportedLocales()"><!-- --></A><H3>
getSupportedLocales</H3>
<PRE>
java.util.Enumeration<java.util.Locale> <B>getSupportedLocales</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><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.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getContainerRuntimeOptions()"><!-- --></A><H3>
getContainerRuntimeOptions</H3>
<PRE>
java.util.Map<java.lang.String,java.lang.String[]> <B>getContainerRuntimeOptions</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><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>).<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PortletConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/PortletConfig.html" target="_top"><B>FRAMES</B></A>
<A HREF="PortletConfig.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2010. All Rights Reserved.
</BODY>
</HTML>
|