/usr/share/doc/libservlet2.5-java/api/javax/servlet/ServletRequest.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 | <!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>ServletRequest (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="ServletRequest (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/ServletOutputStream.html" title="class in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../javax/servlet/ServletRequestAttributeEvent.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/ServletRequest.html" target="_top">Frames</a></li>
<li><a href="ServletRequest.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 ServletRequest" class="title">Interface ServletRequest</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../javax/servlet/http/HttpServletRequest.html" title="interface in javax.servlet.http">HttpServletRequest</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../javax/servlet/http/HttpServletRequestWrapper.html" title="class in javax.servlet.http">HttpServletRequestWrapper</a>, <a href="../../javax/servlet/ServletRequestWrapper.html" title="class in javax.servlet">ServletRequestWrapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ServletRequest</span></pre>
<div class="block">Defines an object to provide client request information to a servlet. The
servlet container creates a <code>ServletRequest</code> object and passes
it as an argument to the servlet's <code>service</code> method.
<p>A <code>ServletRequest</code> object provides data including
parameter name and values, attributes, and an input stream.
Interfaces that extend <code>ServletRequest</code> can provide
additional protocol-specific data (for example, HTTP data is
provided by <a href="../../javax/servlet/http/HttpServletRequest.html" title="interface in javax.servlet.http"><code>HttpServletRequest</code></a>.</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/http/HttpServletRequest.html" title="interface in javax.servlet.http"><code>HttpServletRequest</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/ServletRequest.html#getAttribute(java.lang.String)">getAttribute</a></strong>(java.lang.String name)</code>
<div class="block">Returns the value of the named attribute as an <code>Object</code>,
or <code>null</code> if no attribute of the given name exists.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getAttributeNames()">getAttributeNames</a></strong>()</code>
<div class="block">Returns an <code>Enumeration</code> containing the
names of the attributes available to this request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getCharacterEncoding()">getCharacterEncoding</a></strong>()</code>
<div class="block">Returns the name of the character encoding used in the body of this
request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getContentLength()">getContentLength</a></strong>()</code>
<div class="block">Returns the length, in bytes, of the request body
and made available by the input stream, or -1 if the
length is not known.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getContentType()">getContentType</a></strong>()</code>
<div class="block">Returns the MIME type of the body of the request, or
<code>null</code> if the type is not known.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../javax/servlet/ServletInputStream.html" title="class in javax.servlet">ServletInputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getInputStream()">getInputStream</a></strong>()</code>
<div class="block">Retrieves the body of the request as binary data using
a <a href="../../javax/servlet/ServletInputStream.html" title="class in javax.servlet"><code>ServletInputStream</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getLocalAddr()">getLocalAddr</a></strong>()</code>
<div class="block">Returns the Internet Protocol (IP) address of the interface on
which the request was received.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Locale</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getLocale()">getLocale</a></strong>()</code>
<div class="block">Returns the preferred <code>Locale</code> that the client will
accept content in, based on the Accept-Language header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getLocales()">getLocales</a></strong>()</code>
<div class="block">Returns an <code>Enumeration</code> of <code>Locale</code> objects
indicating, in decreasing order starting with the preferred locale, the
locales that are acceptable to the client based on the Accept-Language
header.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getLocalName()">getLocalName</a></strong>()</code>
<div class="block">Returns the host name of the Internet Protocol (IP) interface on
which the request was received.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getLocalPort()">getLocalPort</a></strong>()</code>
<div class="block">Returns the Internet Protocol (IP) port number of the interface
on which the request was received.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getParameter(java.lang.String)">getParameter</a></strong>(java.lang.String name)</code>
<div class="block">Returns the value of a request parameter as a <code>String</code>,
or <code>null</code> if the parameter does not exist.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getParameterMap()">getParameterMap</a></strong>()</code>
<div class="block">Returns a java.util.Map of the parameters of this request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getParameterNames()">getParameterNames</a></strong>()</code>
<div class="block">Returns an <code>Enumeration</code> of <code>String</code>
objects containing the names of the parameters contained
in this request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getParameterValues(java.lang.String)">getParameterValues</a></strong>(java.lang.String name)</code>
<div class="block">Returns an array of <code>String</code> objects containing
all of the values the given request parameter has, or
<code>null</code> if the parameter does not exist.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getProtocol()">getProtocol</a></strong>()</code>
<div class="block">Returns the name and version of the protocol the request uses
in the form <i>protocol/majorVersion.minorVersion</i>, for
example, HTTP/1.1.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.BufferedReader</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getReader()">getReader</a></strong>()</code>
<div class="block">Retrieves the body of the request as character data using
a <code>BufferedReader</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getRealPath(java.lang.String)">getRealPath</a></strong>(java.lang.String path)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Version 2.1 of the Java Servlet API,
use <a href="../../javax/servlet/ServletContext.html#getRealPath(java.lang.String)"><code>ServletContext.getRealPath(java.lang.String)</code></a> instead.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getRemoteAddr()">getRemoteAddr</a></strong>()</code>
<div class="block">Returns the Internet Protocol (IP) address of the client
or last proxy that sent the request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getRemoteHost()">getRemoteHost</a></strong>()</code>
<div class="block">Returns the fully qualified name of the client
or the last proxy that sent the request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getRemotePort()">getRemotePort</a></strong>()</code>
<div class="block">Returns the Internet Protocol (IP) source port of the client
or last proxy that sent the request.</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/ServletRequest.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.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getScheme()">getScheme</a></strong>()</code>
<div class="block">Returns the name of the scheme used to make this request,
for example,
<code>http</code>, <code>https</code>, or <code>ftp</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getServerName()">getServerName</a></strong>()</code>
<div class="block">Returns the host name of the server to which the request was sent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#getServerPort()">getServerPort</a></strong>()</code>
<div class="block">Returns the port number to which the request was sent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#isSecure()">isSecure</a></strong>()</code>
<div class="block">Returns a boolean indicating whether this request was made using a
secure channel, such as HTTPS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#removeAttribute(java.lang.String)">removeAttribute</a></strong>(java.lang.String name)</code>
<div class="block">Removes an attribute from this request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</a></strong>(java.lang.String name,
java.lang.Object o)</code>
<div class="block">Stores an attribute in this request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/ServletRequest.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</a></strong>(java.lang.String env)</code>
<div class="block">Overrides the name of the character encoding used in the body of this
request.</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="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 value of the named attribute as an <code>Object</code>,
or <code>null</code> if no attribute of the given name exists.
<p> Attributes can be set two ways. The servlet container may set
attributes to make available custom information about a request.
For example, for requests made using HTTPS, the attribute
<code>javax.servlet.request.X509Certificate</code> can be used to
retrieve information on the certificate of the client. Attributes
can also be set programatically using
<a href="../../javax/servlet/ServletRequest.html#setAttribute(java.lang.String,%20java.lang.Object)"><code>setAttribute(java.lang.String, java.lang.Object)</code></a>. This allows information to be
embedded into a request before a <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a> call.
<p>Attribute names should follow the same conventions as package
names. This 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
the attribute does not exist</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
names of the attributes available to this request.
This method returns an empty <code>Enumeration</code>
if the request has no attributes available to it.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of strings
containing the names
of the request's attributes</dd></dl>
</li>
</ul>
<a name="getCharacterEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharacterEncoding</h4>
<pre>java.lang.String getCharacterEncoding()</pre>
<div class="block">Returns the name of the character encoding used in the body of this
request. This method returns <code>null</code> if the request
does not specify a character encoding</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name of
the character encoding, or <code>null</code>
if the request does not specify a character encoding</dd></dl>
</li>
</ul>
<a name="setCharacterEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCharacterEncoding</h4>
<pre>void setCharacterEncoding(java.lang.String env)
throws java.io.UnsupportedEncodingException</pre>
<div class="block">Overrides the name of the character encoding used in the body of this
request. This method must be called prior to reading request parameters
or reading input using getReader().</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - a <code>String</code> containing the name of
the character encoding.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.UnsupportedEncodingException</code> - if this is not a valid encoding</dd></dl>
</li>
</ul>
<a name="getContentLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentLength</h4>
<pre>int getContentLength()</pre>
<div class="block">Returns the length, in bytes, of the request body
and made available by the input stream, or -1 if the
length is not known. For HTTP servlets, same as the value
of the CGI variable CONTENT_LENGTH.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer containing the length of the
request body or -1 if the length is not known</dd></dl>
</li>
</ul>
<a name="getContentType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentType</h4>
<pre>java.lang.String getContentType()</pre>
<div class="block">Returns the MIME type of the body of the request, or
<code>null</code> if the type is not known. For HTTP servlets,
same as the value of the CGI variable CONTENT_TYPE.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name
of the MIME type of
the request, or null if the type is not known</dd></dl>
</li>
</ul>
<a name="getInputStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputStream</h4>
<pre><a href="../../javax/servlet/ServletInputStream.html" title="class in javax.servlet">ServletInputStream</a> getInputStream()
throws java.io.IOException</pre>
<div class="block">Retrieves the body of the request as binary data using
a <a href="../../javax/servlet/ServletInputStream.html" title="class in javax.servlet"><code>ServletInputStream</code></a>. Either this method or
<a href="../../javax/servlet/ServletRequest.html#getReader()"><code>getReader()</code></a> may be called to read the body, not both.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <a href="../../javax/servlet/ServletInputStream.html" title="class in javax.servlet"><code>ServletInputStream</code></a> object containing
the body of the request</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the <a href="../../javax/servlet/ServletRequest.html#getReader()"><code>getReader()</code></a> method
has already been called for this request</dd>
<dd><code>java.io.IOException</code> - if an input or output exception occurred</dd></dl>
</li>
</ul>
<a name="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameter</h4>
<pre>java.lang.String getParameter(java.lang.String name)</pre>
<div class="block">Returns the value of a request parameter as a <code>String</code>,
or <code>null</code> if the parameter does not exist. Request parameters
are extra information sent with the request. For HTTP servlets,
parameters are contained in the query string or posted form data.
<p>You should only use this method when you are sure the
parameter has only one value. If the parameter might have
more than one value, use <a href="../../javax/servlet/ServletRequest.html#getParameterValues(java.lang.String)"><code>getParameterValues(java.lang.String)</code></a>.
<p>If you use this method with a multivalued
parameter, the value returned is equal to the first value
in the array returned by <code>getParameterValues</code>.
<p>If the parameter data was sent in the request body, such as occurs
with an HTTP POST request, then reading the body directly via <a href="../../javax/servlet/ServletRequest.html#getInputStream()"><code>getInputStream()</code></a> or <a href="../../javax/servlet/ServletRequest.html#getReader()"><code>getReader()</code></a> can interfere
with the execution of this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the
name of the parameter</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> representing the
single value of the parameter</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/ServletRequest.html#getParameterValues(java.lang.String)"><code>getParameterValues(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="getParameterNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterNames</h4>
<pre>java.util.Enumeration getParameterNames()</pre>
<div class="block">Returns an <code>Enumeration</code> of <code>String</code>
objects containing the names of the parameters contained
in this request. If the request has
no parameters, the method returns an
empty <code>Enumeration</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code>
objects, each <code>String</code> containing
the name of a request parameter; or an
empty <code>Enumeration</code> if the
request has no parameters</dd></dl>
</li>
</ul>
<a name="getParameterValues(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterValues</h4>
<pre>java.lang.String[] getParameterValues(java.lang.String name)</pre>
<div class="block">Returns an array of <code>String</code> objects containing
all of the values the given request parameter has, or
<code>null</code> if the parameter does not exist.
<p>If the parameter has a single value, the array has a length
of 1.</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>an array of <code>String</code> objects
containing the parameter's values</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/ServletRequest.html#getParameter(java.lang.String)"><code>getParameter(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="getParameterMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterMap</h4>
<pre>java.util.Map getParameterMap()</pre>
<div class="block">Returns a java.util.Map of the parameters of this request.
Request parameters
are extra information sent with the request. For HTTP servlets,
parameters are contained in the query string or posted form data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an immutable java.util.Map containing parameter names as
keys and parameter values as map values. The keys in the parameter
map are of type String. The values in the parameter map are of type
String array.</dd></dl>
</li>
</ul>
<a name="getProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>java.lang.String getProtocol()</pre>
<div class="block">Returns the name and version of the protocol the request uses
in the form <i>protocol/majorVersion.minorVersion</i>, for
example, HTTP/1.1. For HTTP servlets, the value
returned is the same as the value of the CGI variable
<code>SERVER_PROTOCOL</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the protocol
name and version number</dd></dl>
</li>
</ul>
<a name="getScheme()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheme</h4>
<pre>java.lang.String getScheme()</pre>
<div class="block">Returns the name of the scheme used to make this request,
for example,
<code>http</code>, <code>https</code>, or <code>ftp</code>.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name
of the scheme used to make this request</dd></dl>
</li>
</ul>
<a name="getServerName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerName</h4>
<pre>java.lang.String getServerName()</pre>
<div class="block">Returns the host name of the server to which the request was sent.
It is the value of the part before ":" in the <code>Host</code>
header value, if any, or the resolved server name, or the server IP address.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the name
of the server</dd></dl>
</li>
</ul>
<a name="getServerPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerPort</h4>
<pre>int getServerPort()</pre>
<div class="block">Returns the port number to which the request was sent.
It is the value of the part after ":" in the <code>Host</code>
header value, if any, or the server port where the client connection
was accepted on.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the port number</dd></dl>
</li>
</ul>
<a name="getReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReader</h4>
<pre>java.io.BufferedReader getReader()
throws java.io.IOException</pre>
<div class="block">Retrieves the body of the request as character data using
a <code>BufferedReader</code>. The reader translates the character
data according to the character encoding used on the body.
Either this method or <a href="../../javax/servlet/ServletRequest.html#getInputStream()"><code>getInputStream()</code></a> may be called to read the
body, not both.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>BufferedReader</code>
containing the body of the request</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>UnsupportedEncodingException</code> - if the character set encoding
used is not supported and the
text cannot be decoded</dd>
<dd><code>java.lang.IllegalStateException</code> - if <a href="../../javax/servlet/ServletRequest.html#getInputStream()"><code>getInputStream()</code></a> method
has been called on this request</dd>
<dd><code>java.io.IOException</code> - if an input or output exception occurred</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/ServletRequest.html#getInputStream()"><code>getInputStream()</code></a></dd></dl>
</li>
</ul>
<a name="getRemoteAddr()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddr</h4>
<pre>java.lang.String getRemoteAddr()</pre>
<div class="block">Returns the Internet Protocol (IP) address of the client
or last proxy that sent the request.
For HTTP servlets, same as the value of the
CGI variable <code>REMOTE_ADDR</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the
IP address of the client that sent the request</dd></dl>
</li>
</ul>
<a name="getRemoteHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteHost</h4>
<pre>java.lang.String getRemoteHost()</pre>
<div class="block">Returns the fully qualified name of the client
or the last proxy that sent the request.
If the engine cannot or chooses not to resolve the hostname
(to improve performance), this method returns the dotted-string form of
the IP address. For HTTP servlets, same as the value of the CGI variable
<code>REMOTE_HOST</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the fully
qualified name of the client</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 o)</pre>
<div class="block">Stores an attribute in this request.
Attributes are reset between requests. This method is most
often used in conjunction with <a href="../../javax/servlet/RequestDispatcher.html" title="interface in javax.servlet"><code>RequestDispatcher</code></a>.
<p>Attribute names should follow the same conventions as
package names. Names beginning with <code>java.*</code>,
<code>javax.*</code>, and <code>com.sun.*</code>, are
reserved for use by Sun Microsystems.
<br> If the object passed in is null, the effect is the same as
calling <a href="../../javax/servlet/ServletRequest.html#removeAttribute(java.lang.String)"><code>removeAttribute(java.lang.String)</code></a>.
<br> It is warned that when the request is dispatched from the
servlet resides in a different web application by
<code>RequestDispatcher</code>, the object set by this method
may not be correctly retrieved in the caller servlet.</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>o</code> - the <code>Object</code> to be stored</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 an attribute from this request. This method is not
generally needed as attributes only persist as long as the request
is being handled.
<p>Attribute names should follow the same conventions as
package names. Names beginning with <code>java.*</code>,
<code>javax.*</code>, and <code>com.sun.*</code>, are
reserved for use by Sun Microsystems.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying
the name of the attribute to remove</dd></dl>
</li>
</ul>
<a name="getLocale()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocale</h4>
<pre>java.util.Locale getLocale()</pre>
<div class="block">Returns the preferred <code>Locale</code> that the client will
accept content in, based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header,
this method returns the default locale for the server.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the preferred <code>Locale</code> for the client</dd></dl>
</li>
</ul>
<a name="getLocales()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocales</h4>
<pre>java.util.Enumeration getLocales()</pre>
<div class="block">Returns an <code>Enumeration</code> of <code>Locale</code> objects
indicating, in decreasing order starting with the preferred locale, the
locales that are acceptable to the client based on the Accept-Language
header.
If the client request doesn't provide an Accept-Language header,
this method returns an <code>Enumeration</code> containing one
<code>Locale</code>, the default locale for the server.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of preferred
<code>Locale</code> objects for the client</dd></dl>
</li>
</ul>
<a name="isSecure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecure</h4>
<pre>boolean isSecure()</pre>
<div class="block">Returns a boolean indicating whether this request was made using a
secure channel, such as HTTPS.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a boolean indicating if the request was made using a
secure channel</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 specified may be relative, although it cannot extend
outside the current servlet context. If the path begins with
a "/" it is interpreted as relative to the current context root.
This method returns <code>null</code> if the servlet container
cannot return a <code>RequestDispatcher</code>.
<p>The difference between this method and <a href="../../javax/servlet/ServletContext.html#getRequestDispatcher(java.lang.String)"><code>ServletContext.getRequestDispatcher(java.lang.String)</code></a> is that this method can take a
relative path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - a <code>String</code> specifying the pathname
to the resource. If it is relative, it must be
relative against the current servlet.</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 servlet container 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#getRequestDispatcher(java.lang.String)"><code>ServletContext.getRequestDispatcher(java.lang.String)</code></a></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"><span class="strong">Deprecated.</span> <i>As of Version 2.1 of the Java Servlet API,
use <a href="../../javax/servlet/ServletContext.html#getRealPath(java.lang.String)"><code>ServletContext.getRealPath(java.lang.String)</code></a> instead.</i></div>
</li>
</ul>
<a name="getRemotePort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemotePort</h4>
<pre>int getRemotePort()</pre>
<div class="block">Returns the Internet Protocol (IP) source port of the client
or last proxy that sent the request.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the port number</dd><dt><span class="strong">Since:</span></dt>
<dd>2.4</dd></dl>
</li>
</ul>
<a name="getLocalName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalName</h4>
<pre>java.lang.String getLocalName()</pre>
<div class="block">Returns the host name of the Internet Protocol (IP) interface on
which the request was received.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the host
name of the IP on which the request was received.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.4</dd></dl>
</li>
</ul>
<a name="getLocalAddr()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddr</h4>
<pre>java.lang.String getLocalAddr()</pre>
<div class="block">Returns the Internet Protocol (IP) address of the interface on
which the request was received.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the
IP address on which the request was received.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.4</dd></dl>
</li>
</ul>
<a name="getLocalPort()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocalPort</h4>
<pre>int getLocalPort()</pre>
<div class="block">Returns the Internet Protocol (IP) port number of the interface
on which the request was received.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the port number</dd><dt><span class="strong">Since:</span></dt>
<dd>2.4</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/ServletOutputStream.html" title="class in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../javax/servlet/ServletRequestAttributeEvent.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/ServletRequest.html" target="_top">Frames</a></li>
<li><a href="ServletRequest.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>
|