/usr/share/doc/libservlet2.5-java/api/javax/servlet/ServletContext.html is in libservlet2.5-java-doc 6.0.45+dfsg-1~deb8u1.
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 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 | <!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_91) on Fri Apr 01 14:23:31 UTC 2016 -->
<title>ServletContext (Tomcat API Documentation)</title>
<meta name="date" content="2016-04-01">
<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="ServletContext (Tomcat API Documentation)";
}
//-->
</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="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/servlet/ServletConfig.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../javax/servlet/ServletContextAttributeEvent.html" title="class in javax.servlet"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/ServletContext.html" target="_top">Frames</a></li>
<li><a href="ServletContext.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.servlet</div>
<h2 title="Interface ServletContext" class="title">Interface ServletContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">ServletContext</span></pre>
<div class="block">Defines a set of methods that a servlet uses to communicate with its
servlet container, for example, to get the MIME type of a file, dispatch
requests, or write to a log file.
<p>There is one context per "web application" per Java Virtual Machine. (A
"web application" is a collection of servlets and content installed under a
specific subset of the server's URL namespace such as <code>/catalog</code>
and possibly installed via a <code>.war</code> file.)
<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 won't be truly global). Use an external resource like
a database instead.
<p>The <code>ServletContext</code> object is contained within
the <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><code>ServletConfig</code></a> object, which the Web server provides the
servlet when the servlet is initialized.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Various</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/Servlet.html#getServletConfig()"><code>Servlet.getServletConfig()</code></a>,
<a href="../../javax/servlet/ServletConfig.html#getServletContext()"><code>ServletConfig.getServletContext()</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>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getAttribute(java.lang.String)">getAttribute</a></strong>(java.lang.String name)</code>
<div class="block">Returns the servlet container attribute with the given name,
or <code>null</code> if there is no attribute by that name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getAttributeNames()">getAttributeNames</a></strong>()</code>
<div class="block">Returns an <code>Enumeration</code> containing the
attribute names available
within this servlet context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getContext(java.lang.String)">getContext</a></strong>(java.lang.String uripath)</code>
<div class="block">Returns a <code>ServletContext</code> object that
corresponds to a specified URL on the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getContextPath()">getContextPath</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getInitParameter(java.lang.String)">getInitParameter</a></strong>(java.lang.String name)</code>
<div class="block">Returns a <code>String</code> 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="rowColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getInitParameterNames()">getInitParameterNames</a></strong>()</code>
<div class="block">Returns the names of the context's initialization parameters as an
<code>Enumeration</code> of <code>String</code> objects, or an
empty <code>Enumeration</code> if the context has no initialization
parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getMajorVersion()">getMajorVersion</a></strong>()</code>
<div class="block">Returns the major version of the Java Servlet API that this
servlet container supports.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getMimeType(java.lang.String)">getMimeType</a></strong>(java.lang.String 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="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getMinorVersion()">getMinorVersion</a></strong>()</code>
<div class="block">Returns the minor version of the Servlet API that this
servlet container supports.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet">RequestDispatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getNamedDispatcher(java.lang.String)">getNamedDispatcher</a></strong>(java.lang.String name)</code>
<div class="block">Returns a <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a> object that acts
as a wrapper for the named servlet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getRealPath(java.lang.String)">getRealPath</a></strong>(java.lang.String 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/servlet/RequestDispatcher.html" title="interface in javax.servlet">RequestDispatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getRequestDispatcher(java.lang.String)">getRequestDispatcher</a></strong>(java.lang.String path)</code>
<div class="block">Returns a <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</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>java.net.URL</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getResource(java.lang.String)">getResource</a></strong>(java.lang.String 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>java.io.InputStream</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getResourceAsStream(java.lang.String)">getResourceAsStream</a></strong>(java.lang.String path)</code>
<div class="block">Returns the resource located at the named path as
an <code>InputStream</code> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getResourcePaths(java.lang.String)">getResourcePaths</a></strong>(java.lang.String path)</code>
<div class="block">Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path
matches the supplied path argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getServerInfo()">getServerInfo</a></strong>()</code>
<div class="block">Returns the name and version of the servlet container on which
the servlet is running.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getServlet(java.lang.String)">getServlet</a></strong>(java.lang.String name)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.1, with no direct replacement.
<p>This method was originally defined to retrieve a servlet
from a <code>ServletContext</code>. In this version, this method
always returns <code>null</code> and remains only to preserve
binary compatibility. This method will be permanently removed
in a future version of the Java Servlet API.
<p>In lieu of this method, servlets can share information using the
<code>ServletContext</code> class and can perform shared business logic
by invoking methods on common non-servlet classes.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getServletContextName()">getServletContextName</a></strong>()</code>
<div class="block">Returns the name of this web application corresponding to this ServletContext as specified in the deployment
descriptor for this web application by the display-name element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getServletNames()">getServletNames</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.1, with no replacement.
<p>This method was originally defined to return an
<code>Enumeration</code>
of all the servlet names known to this context. In this version,
this method always returns an empty <code>Enumeration</code> and
remains only to preserve binary compatibility. This method will
be permanently removed in a future version of the Java Servlet API.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#getServlets()">getServlets</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.0, with no replacement.
<p>This method was originally defined to return an <code>Enumeration</code>
of all the servlets known to this servlet context. In this
version, this method always returns an empty enumeration and
remains only to preserve binary compatibility. This method
will be permanently removed in a future version of the Java
Servlet API.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#log(java.lang.Exception,%20java.lang.String)">log</a></strong>(java.lang.Exception exception,
java.lang.String msg)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.1, use
<a href="../../javax/servlet/ServletContext.html#log(java.lang.String,%20java.lang.Throwable)"><code>log(String message, Throwable throwable)</code></a>
instead.
<p>This method was originally defined to write an
exception's stack trace and an explanatory error message
to the servlet log file.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#log(java.lang.String)">log</a></strong>(java.lang.String msg)</code>
<div class="block">Writes the specified message to a servlet log file, usually
an event log.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#log(java.lang.String,%20java.lang.Throwable)">log</a></strong>(java.lang.String message,
java.lang.Throwable throwable)</code>
<div class="block">Writes an explanatory message and a stack trace
for a given <code>Throwable</code> exception
to the servlet log file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#removeAttribute(java.lang.String)">removeAttribute</a></strong>(java.lang.String name)</code>
<div class="block">Removes the attribute with the given name from
the servlet context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContext.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</a></strong>(java.lang.String name,
java.lang.Object object)</code>
<div class="block">Binds an object to a given attribute name in this servlet 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="getContext(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a> getContext(java.lang.String uripath)</pre>
<div class="block">Returns a <code>ServletContext</code> object that
corresponds to a specified URL on the server.
<p>This method allows servlets to gain
access to the context for various parts of the server, and as
needed obtain <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a> objects from the context.
The given path must be begin with "/", is interpreted relative
to the server's document root and is matched against the context roots of
other web applications hosted on this container.
<p>In a security conscious environment, the servlet container may
return <code>null</code> for a given URL.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uripath</code> - a <code>String</code> specifying the context path of
another web application in the container.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>ServletContext</code> object that
corresponds to the named URL, or null if either
none exists or the container wishes to restrict
this access.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a></dd></dl>
</li>
</ul>
<a name="getContextPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextPath</h4>
<pre>java.lang.String getContextPath()</pre>
</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 Java Servlet API that this
servlet container supports. All implementations that comply
with Version 2.4 must have this method
return the integer 2.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>2</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 Servlet API that this
servlet container supports. All implementations that comply
with Version 2.5 must have this method
return the integer 5.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>5</dd></dl>
</li>
</ul>
<a name="getMimeType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMimeType</h4>
<pre>java.lang.String getMimeType(java.lang.String 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 servlet 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 file's MIME type</dd></dl>
</li>
</ul>
<a name="getResourcePaths(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourcePaths</h4>
<pre>java.util.Set getResourcePaths(java.lang.String path)</pre>
<div class="block">Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path
matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all
relative to the root of the web application and have a leading '/'. For example, for a web application
containing<br><br>
/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.OrderServlet.class,<br><br>
getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}<br>
getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.<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 /</dd>
<dt><span class="strong">Returns:</span></dt><dd>a Set containing the directory listing, or null if there are no resources in the web application whose path
begins with the supplied path.</dd><dt><span class="strong">Since:</span></dt>
<dd>Servlet 2.3</dd></dl>
</li>
</ul>
<a name="getResource(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre>java.net.URL getResource(java.lang.String path)
throws java.net.MalformedURLException</pre>
<div class="block">Returns a URL to the resource that is mapped to a specified
path. The path must begin with a "/" and is interpreted
as relative to the current context root.
<p>This method allows the servlet container to make a resource
available to servlets 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 servlet 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>java.net.MalformedURLException</code> - if the pathname is not given in
the correct form</dd></dl>
</li>
</ul>
<a name="getResourceAsStream(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceAsStream</h4>
<pre>java.io.InputStream getResourceAsStream(java.lang.String path)</pre>
<div class="block">Returns the resource located at the named path as
an <code>InputStream</code> object.
<p>The data in the <code>InputStream</code> can be
of any type or length. The path must be specified according
to the rules given in <code>getResource</code>.
This method returns <code>null</code> if no resource exists at
the specified path.
<p>Meta-information such as content length and content type
that is available via <code>getResource</code>
method is lost when using this method.
<p>The servlet container must implement the URL handlers
and <code>URLConnection</code> objects necessary to access
the resource.
<p>This method is different from
<code>java.lang.Class.getResourceAsStream</code>,
which uses a class loader. This method allows servlet containers
to make a resource available
to a servlet from any location, without using a class loader.</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 <code>InputStream</code> returned to the
servlet, or <code>null</code> if no resource
exists at the specified path</dd></dl>
</li>
</ul>
<a name="getRequestDispatcher(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestDispatcher</h4>
<pre><a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet">RequestDispatcher</a> getRequestDispatcher(java.lang.String path)</pre>
<div class="block">Returns a <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a> object that acts
as a wrapper for the resource located at the given path.
A <code>RequestDispatcher</code> object can be used to forward
a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
<p>The pathname must begin with a "/" and is interpreted as relative
to the current context root. Use <code>getContext</code> to obtain
a <code>RequestDispatcher</code> for resources in foreign contexts.
This method returns <code>null</code> if the <code>ServletContext</code>
cannot return a <code>RequestDispatcher</code>.</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>RequestDispatcher</code> object
that acts as a wrapper for the resource
at the specified path, or <code>null</code> if
the <code>ServletContext</code> cannot return
a <code>RequestDispatcher</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a>,
<a href="../../javax/servlet/ServletContext.html#getContext(java.lang.String)"><code>getContext(java.lang.String)</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/servlet/RequestDispatcher.html" title="interface in javax.servlet">RequestDispatcher</a> getNamedDispatcher(java.lang.String name)</pre>
<div class="block">Returns a <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a> object that acts
as a wrapper for the named servlet.
<p>Servlets (and JSP pages also) may be given names via server
administration or via a web application deployment descriptor.
A servlet instance can determine its name using
<a href="../../javax/servlet/ServletConfig.html#getServletName()"><code>ServletConfig.getServletName()</code></a>.
<p>This method returns <code>null</code> if the
<code>ServletContext</code>
cannot return a <code>RequestDispatcher</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 wrap</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>RequestDispatcher</code> object
that acts as a wrapper for the named servlet,
or <code>null</code> if the <code>ServletContext</code>
cannot return a <code>RequestDispatcher</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a>,
<a href="../../javax/servlet/ServletContext.html#getContext(java.lang.String)"><code>getContext(java.lang.String)</code></a>,
<a href="../../javax/servlet/ServletConfig.html#getServletName()"><code>ServletConfig.getServletName()</code></a></dd></dl>
</li>
</ul>
<a name="getServlet(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServlet</h4>
<pre><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a> getServlet(java.lang.String name)
throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.1, with no direct replacement.
<p>This method was originally defined to retrieve a servlet
from a <code>ServletContext</code>. In this version, this method
always returns <code>null</code> and remains only to preserve
binary compatibility. This method will be permanently removed
in a future version of the Java Servlet API.
<p>In lieu of this method, servlets can share information using the
<code>ServletContext</code> class and can perform shared business logic
by invoking methods on common non-servlet classes.</i></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></code></dd></dl>
</li>
</ul>
<a name="getServlets()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServlets</h4>
<pre>java.util.Enumeration getServlets()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.0, with no replacement.
<p>This method was originally defined to return an <code>Enumeration</code>
of all the servlets known to this servlet context. In this
version, this method always returns an empty enumeration and
remains only to preserve binary compatibility. This method
will be permanently removed in a future version of the Java
Servlet API.</i></div>
</li>
</ul>
<a name="getServletNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletNames</h4>
<pre>java.util.Enumeration getServletNames()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.1, with no replacement.
<p>This method was originally defined to return an
<code>Enumeration</code>
of all the servlet names known to this context. In this version,
this method always returns an empty <code>Enumeration</code> and
remains only to preserve binary compatibility. This method will
be permanently removed in a future version of the Java Servlet API.</i></div>
</li>
</ul>
<a name="log(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>void log(java.lang.String msg)</pre>
<div class="block">Writes the specified message to a servlet log file, usually
an event log. The name and type of the servlet log file is
specific to the servlet container.</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.Exception, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>void log(java.lang.Exception exception,
java.lang.String msg)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.1, use
<a href="../../javax/servlet/ServletContext.html#log(java.lang.String,%20java.lang.Throwable)"><code>log(String message, Throwable throwable)</code></a>
instead.
<p>This method was originally defined to write an
exception's stack trace and an explanatory error message
to the servlet log file.</i></div>
</li>
</ul>
<a name="log(java.lang.String, java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>void log(java.lang.String message,
java.lang.Throwable throwable)</pre>
<div class="block">Writes an explanatory message and a stack trace
for a given <code>Throwable</code> exception
to the servlet log file. The name and type of the servlet log
file is specific to the servlet container, usually an event log.</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="getRealPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRealPath</h4>
<pre>java.lang.String getRealPath(java.lang.String path)</pre>
<div class="block">Returns a <code>String</code> containing the real path
for a given virtual path. For example, the path "/index.html"
returns the absolute file path on the server's filesystem would be
served by a request for "http://host/contextPath/index.html",
where contextPath is the context path of this ServletContext..
<p>The real path returned will be in a form
appropriate to the computer and operating system on
which the servlet container is running, including the
proper path separators. This method returns <code>null</code>
if the servlet 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 translation cannot be performed</dd></dl>
</li>
</ul>
<a name="getServerInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerInfo</h4>
<pre>java.lang.String getServerInfo()</pre>
<div class="block">Returns the name and version of the servlet container on which
the servlet is running.
<p>The form of the returned string is
<i>servername</i>/<i>versionnumber</i>.
For example, the JavaServer Web Development Kit may return the string
<code>JavaServer Web Dev Kit/1.0</code>.
<p>The servlet container may return other optional information
after the primary string in parentheses, for example,
<code>JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing at least the
servlet container name and version number</dd></dl>
</li>
</ul>
<a name="getInitParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitParameter</h4>
<pre>java.lang.String getInitParameter(java.lang.String name)</pre>
<div class="block">Returns a <code>String</code> containing the value of the named
context-wide initialization parameter, or <code>null</code> if the
parameter does not exist.
<p>This method can make available configuration information useful
to an entire "web application". For example, it can provide a
webmaster's email address or the name of a system that holds
critical data.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> containing the name of the parameter
whose value is requested</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">See Also:</span></dt><dd><a href="../../javax/servlet/ServletConfig.html#getInitParameter(java.lang.String)"><code>ServletConfig.getInitParameter(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="getInitParameterNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitParameterNames</h4>
<pre>java.util.Enumeration getInitParameterNames()</pre>
<div class="block">Returns the names of the context's initialization parameters as an
<code>Enumeration</code> of <code>String</code> objects, or an
empty <code>Enumeration</code> 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's
initialization parameters</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/ServletConfig.html#getInitParameter(java.lang.String)"><code>ServletConfig.getInitParameter(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="getAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.Object getAttribute(java.lang.String name)</pre>
<div class="block">Returns the servlet container attribute with the given name,
or <code>null</code> if there is no attribute by that name.
An attribute allows a servlet container to give the
servlet additional information not
already provided by this interface. See your
server documentation for information about its attributes.
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 Servlet 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">See Also:</span></dt><dd><a href="../../javax/servlet/ServletContext.html#getAttributeNames()"><code>getAttributeNames()</code></a></dd></dl>
</li>
</ul>
<a name="getAttributeNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNames</h4>
<pre>java.util.Enumeration getAttributeNames()</pre>
<div class="block">Returns an <code>Enumeration</code> containing the
attribute names available
within this servlet context. Use the
<a href="../../javax/servlet/ServletContext.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/servlet/ServletContext.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a></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(java.lang.String name,
java.lang.Object object)</pre>
<div class="block">Binds an object to a given attribute name in this servlet context. If
the name specified is already used for an attribute, this
method will replace the attribute with the new to the new attribute.
<p>If listeners are configured on the <code>ServletContext</code> the
container notifies them accordingly.
<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 Servlet 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></dl>
</li>
</ul>
<a name="removeAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAttribute</h4>
<pre>void removeAttribute(java.lang.String name)</pre>
<div class="block">Removes the attribute with the given name from
the servlet context. After removal, subsequent calls to
<a href="../../javax/servlet/ServletContext.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a> to retrieve the attribute's value
will return <code>null</code>.
<p>If listeners are configured on the <code>ServletContext</code> the
container notifies them accordingly.</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></dl>
</li>
</ul>
<a name="getServletContextName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServletContextName</h4>
<pre>java.lang.String getServletContextName()</pre>
<div class="block">Returns the name of this web application corresponding to this ServletContext as specified in the deployment
descriptor for this web application by the display-name 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><dt><span class="strong">Since:</span></dt>
<dd>Servlet 2.3</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="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/servlet/ServletConfig.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../javax/servlet/ServletContextAttributeEvent.html" title="class in javax.servlet"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/ServletContext.html" target="_top">Frames</a></li>
<li><a href="ServletContext.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 © 2000-2008 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|