/usr/share/doc/libcommons-net2-java/api/org/apache/commons/net/nntp/NNTPClient.html is in libcommons-net2-java-doc 2.2-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 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 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 | <!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_03) on Wed May 30 10:19:43 UTC 2012 -->
<title>NNTPClient (libcommons-net2-java API)</title>
<meta name="date" content="2012-05-30">
<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="NNTPClient (libcommons-net2-java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/net/nntp/NNTPCommand.html" title="class in org.apache.commons.net.nntp"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/net/nntp/NNTPClient.html" target="_top">Frames</a></li>
<li><a href="NNTPClient.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><a href="#fields_inherited_from_class_org.apache.commons.net.nntp.NNTP">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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">org.apache.commons.net.nntp</div>
<h2 title="Class NNTPClient" class="title">Class NNTPClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/commons/net/SocketClient.html" title="class in org.apache.commons.net">org.apache.commons.net.SocketClient</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp">org.apache.commons.net.nntp.NNTP</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.net.nntp.NNTPClient</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">NNTPClient</span>
extends <a href="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp">NNTP</a></pre>
<div class="block">NNTPClient encapsulates all the functionality necessary to post and
retrieve articles from an NNTP server. As with all classes derived
from <a href="../../../../../org/apache/commons/net/SocketClient.html" title="class in org.apache.commons.net"><code>SocketClient</code></a>,
you must first connect to the server with
<a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.net.InetAddress, int)"><code>connect </code></a>
before doing anything, and finally
<a href="../../../../../org/apache/commons/net/nntp/NNTP.html#disconnect()"><code>disconnect() </code></a>
after you're completely finished interacting with the server.
Remember that the
<a href="../../../../../org/apache/commons/net/nntp/NNTP.html#isAllowedToPost()"><code>isAllowedToPost()</code></a>
method is defined in
<a href="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp"><code>NNTP</code></a>.
<p>
You should keep in mind that the NNTP server may choose to prematurely
close a connection if the client has been idle for longer than a
given time period or if the server is being shutdown by the operator or
some other reason. The NNTP class will detect a
premature NNTP server connection closing when it receives a
<a href="../../../../../org/apache/commons/net/nntp/NNTPReply.html#SERVICE_DISCONTINUED"><code>NNTPReply.SERVICE_DISCONTINUED </code></a>
response to a command.
When that occurs, the NNTP class method encountering that reply will throw
an <a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp"><code>NNTPConnectionClosedException</code></a>
.
<code>NNTPConectionClosedException</code>
is a subclass of <code> IOException </code> and therefore need not be
caught separately, but if you are going to catch it separately, its
catch block must appear before the more general <code> IOException </code>
catch block. When you encounter an
<a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp"><code>NNTPConnectionClosedException</code></a>
, you must disconnect the connection with
<a href="../../../../../org/apache/commons/net/nntp/NNTP.html#disconnect()"><code>disconnect() </code></a>
to properly clean up the
system resources used by NNTP. Before disconnecting, you may check the
last reply code and text with
<a href="../../../../../org/apache/commons/net/nntp/NNTP.html#getReplyCode()"><code>getReplyCode </code></a> and
<a href="../../../../../org/apache/commons/net/nntp/NNTP.html#getReplyString()"><code>getReplyString </code></a>.
<p>
Rather than list it separately for each method, we mention here that
every method communicating with the server and throwing an IOException
can also throw a
<a href="../../../../../org/apache/commons/net/MalformedServerReplyException.html" title="class in org.apache.commons.net"><code>MalformedServerReplyException</code></a>
, which is a subclass
of IOException. A MalformedServerReplyException will be thrown when
the reply received from the server deviates enough from the protocol
specification that it cannot be interpreted in a useful manner despite
attempts to be as lenient as possible.
<p>
<p></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Daniel F. Savarese, Rory Winston, Ted Wise</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp"><code>NNTP</code></a>,
<a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp"><code>NNTPConnectionClosedException</code></a>,
<a href="../../../../../org/apache/commons/net/MalformedServerReplyException.html" title="class in org.apache.commons.net"><code>MalformedServerReplyException</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.net.nntp.NNTP">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.commons.net.nntp.<a href="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp">NNTP</a></h3>
<code><a href="../../../../../org/apache/commons/net/nntp/NNTP.html#_commandSupport_">_commandSupport_</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#_reader_">_reader_</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#_writer_">_writer_</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#DEFAULT_PORT">DEFAULT_PORT</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.net.SocketClient">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.commons.net.<a href="../../../../../org/apache/commons/net/SocketClient.html" title="class in org.apache.commons.net">SocketClient</a></h3>
<code><a href="../../../../../org/apache/commons/net/SocketClient.html#_defaultPort_">_defaultPort_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#_input_">_input_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#_output_">_output_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#_serverSocketFactory_">_serverSocketFactory_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#_socket_">_socket_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#_socketFactory_">_socketFactory_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#_timeout_">_timeout_</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#connectTimeout">connectTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#NETASCII_EOL">NETASCII_EOL</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#NNTPClient()">NNTPClient</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#authenticate(java.lang.String, java.lang.String)">authenticate</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code>
<div class="block">Log into a news server by sending the AUTHINFO USER/AUTHINFO
PASS command sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#completePendingCommand()">completePendingCommand</a></strong>()</code>
<div class="block">There are a few NNTPClient methods that do not complete the
entire sequence of NNTP commands to complete a transaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#forwardArticle(java.lang.String)">forwardArticle</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#listHelp()">listHelp</a></strong>()</code>
<div class="block">List the command help from the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#listNewNews(org.apache.commons.net.nntp.NewGroupsOrNewsQuery)">listNewNews</a></strong>(<a href="../../../../../org/apache/commons/net/nntp/NewGroupsOrNewsQuery.html" title="class in org.apache.commons.net.nntp">NewGroupsOrNewsQuery</a> query)</code>
<div class="block">List all new articles added to the NNTP server since a particular
date subject to the conditions of the specified query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#listNewNewsgroups(org.apache.commons.net.nntp.NewGroupsOrNewsQuery)">listNewNewsgroups</a></strong>(<a href="../../../../../org/apache/commons/net/nntp/NewGroupsOrNewsQuery.html" title="class in org.apache.commons.net.nntp">NewGroupsOrNewsQuery</a> query)</code>
<div class="block">List all new newsgroups added to the NNTP server since a particular
date subject to the conditions of the specified query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#listNewsgroups()">listNewsgroups</a></strong>()</code>
<div class="block">List all newsgroups served by the NNTP server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#listNewsgroups(java.lang.String)">listNewsgroups</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> wildmat)</code>
<div class="block">An overloaded listNewsgroups() command that allows us to
specify with a pattern what groups we want to list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#logout()">logout</a></strong>()</code>
<div class="block">Logs out of the news server gracefully by sending the QUIT command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#postArticle()">postArticle</a></strong>()</code>
<div class="block">Post an article to the NNTP server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticle()">retrieveArticle</a></strong>()</code>
<div class="block">Same as <code> retrieveArticle(null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticle(int)">retrieveArticle</a></strong>(int articleNumber)</code>
<div class="block">Same as <code> retrieveArticle(articleNumber, null) </code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticle(int, org.apache.commons.net.nntp.ArticlePointer)">retrieveArticle</a></strong>(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Retrieves an article from the currently selected newsgroup.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticle(java.lang.String)">retrieveArticle</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)</code>
<div class="block">Same as <code> retrieveArticle(articleId, null) </code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticle(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">retrieveArticle</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Retrieves an article from the NNTP server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleBody()">retrieveArticleBody</a></strong>()</code>
<div class="block">Same as <code> retrieveArticleBody(null) </code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleBody(int)">retrieveArticleBody</a></strong>(int articleNumber)</code>
<div class="block">Same as <code> retrieveArticleBody(articleNumber, null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleBody(int, org.apache.commons.net.nntp.ArticlePointer)">retrieveArticleBody</a></strong>(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Retrieves an article body from the currently selected newsgroup.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleBody(java.lang.String)">retrieveArticleBody</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)</code>
<div class="block">Same as <code> retrieveArticleBody(articleId, null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleBody(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">retrieveArticleBody</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Retrieves an article body from the NNTP server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleHeader()">retrieveArticleHeader</a></strong>()</code>
<div class="block">Same as <code> retrieveArticleHeader(null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleHeader(int)">retrieveArticleHeader</a></strong>(int articleNumber)</code>
<div class="block">Same as <code> retrieveArticleHeader(articleNumber, null) </code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleHeader(int, org.apache.commons.net.nntp.ArticlePointer)">retrieveArticleHeader</a></strong>(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Retrieves an article header from the currently selected newsgroup.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleHeader(java.lang.String)">retrieveArticleHeader</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)</code>
<div class="block">Same as <code> retrieveArticleHeader(articleId, null) </code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleHeader(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">retrieveArticleHeader</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Retrieves an article header from the NNTP server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleInfo(int)">retrieveArticleInfo</a></strong>(int articleNumber)</code>
<div class="block">Return article headers for a specified post.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveArticleInfo(int, int)">retrieveArticleInfo</a></strong>(int lowArticleNumber,
int highArticleNumber)</code>
<div class="block">Return article headers for all articles between lowArticleNumber
and highArticleNumber, inclusively.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveHeader(java.lang.String, int)">retrieveHeader</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header,
int articleNumber)</code>
<div class="block">Return an article header for a specified post.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#retrieveHeader(java.lang.String, int, int)">retrieveHeader</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header,
int lowArticleNumber,
int highArticleNumber)</code>
<div class="block">Return an article header for all articles between lowArticleNumber
and highArticleNumber, inclusively.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectArticle(org.apache.commons.net.nntp.ArticlePointer)">selectArticle</a></strong>(<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Same as <code> selectArticle(null, articleId) </code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectArticle(int)">selectArticle</a></strong>(int articleNumber)</code>
<div class="block">Same as <code> selectArticle(articleNumber, null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectArticle(int, org.apache.commons.net.nntp.ArticlePointer)">selectArticle</a></strong>(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Select an article in the currently selected newsgroup by its number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectArticle(java.lang.String)">selectArticle</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)</code>
<div class="block">Same as <code> selectArticle(articleId, null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectArticle(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">selectArticle</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Select an article by its unique identifier (including enclosing
< and >) and return its article number and id through the
pointer parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectNewsgroup(java.lang.String)">selectNewsgroup</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newsgroup)</code>
<div class="block">Same as <code> selectNewsgroup(newsgroup, null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectNewsgroup(java.lang.String, org.apache.commons.net.nntp.NewsgroupInfo)">selectNewsgroup</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newsgroup,
<a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a> info)</code>
<div class="block">Select the specified newsgroup to be the target of for future article
retrieval and posting operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectNextArticle()">selectNextArticle</a></strong>()</code>
<div class="block">Same as <code> selectNextArticle(null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectNextArticle(org.apache.commons.net.nntp.ArticlePointer)">selectNextArticle</a></strong>(<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Select the article following the currently selected article in the
currently selected newsgroup and return its number and unique id
through the pointer parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectPreviousArticle()">selectPreviousArticle</a></strong>()</code>
<div class="block">Same as <code> selectPreviousArticle(null) </code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#selectPreviousArticle(org.apache.commons.net.nntp.ArticlePointer)">selectPreviousArticle</a></strong>(<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)</code>
<div class="block">Select the article preceeding the currently selected article in the
currently selected newsgroup and return its number and unique id
through the pointer parameter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.net.nntp.NNTP">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.commons.net.nntp.<a href="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp">NNTP</a></h3>
<code><a href="../../../../../org/apache/commons/net/nntp/NNTP.html#_connectAction_()">_connectAction_</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#addProtocolCommandListener(org.apache.commons.net.ProtocolCommandListener)">addProtocolCommandListener</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#article()">article</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#article(int)">article</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#article(java.lang.String)">article</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#authinfoPass(java.lang.String)">authinfoPass</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#authinfoUser(java.lang.String)">authinfoUser</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#body()">body</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#body(int)">body</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#body(java.lang.String)">body</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#disconnect()">disconnect</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#getReply()">getReply</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#getReplyCode()">getReplyCode</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#getReplyString()">getReplyString</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#group(java.lang.String)">group</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#head()">head</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#head(int)">head</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#head(java.lang.String)">head</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#help()">help</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#ihave(java.lang.String)">ihave</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#isAllowedToPost()">isAllowedToPost</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#last()">last</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#list()">list</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#listActive(java.lang.String)">listActive</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#newgroups(java.lang.String, java.lang.String, boolean, java.lang.String)">newgroups</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#newnews(java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String)">newnews</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#next()">next</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#post()">post</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#quit()">quit</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#removeProtocolCommandListener(org.apache.commons.net.ProtocolCommandListener)">removeProtocolCommandListener</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#sendCommand(int)">sendCommand</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#sendCommand(int, java.lang.String)">sendCommand</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#sendCommand(java.lang.String)">sendCommand</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#sendCommand(java.lang.String, java.lang.String)">sendCommand</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#stat()">stat</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#stat(int)">stat</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#stat(java.lang.String)">stat</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#xhdr(java.lang.String, java.lang.String)">xhdr</a>, <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#xover(java.lang.String)">xover</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.net.SocketClient">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.commons.net.<a href="../../../../../org/apache/commons/net/SocketClient.html" title="class in org.apache.commons.net">SocketClient</a></h3>
<code><a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.net.InetAddress)">connect</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.net.InetAddress, int)">connect</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.net.InetAddress, int, java.net.InetAddress, int)">connect</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.lang.String)">connect</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.lang.String, int)">connect</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#connect(java.lang.String, int, java.net.InetAddress, int)">connect</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getConnectTimeout()">getConnectTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getDefaultPort()">getDefaultPort</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getDefaultTimeout()">getDefaultTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getKeepAlive()">getKeepAlive</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getLocalAddress()">getLocalAddress</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getLocalPort()">getLocalPort</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getRemoteAddress()">getRemoteAddress</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getRemotePort()">getRemotePort</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getServerSocketFactory()">getServerSocketFactory</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getSoLinger()">getSoLinger</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getSoTimeout()">getSoTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#getTcpNoDelay()">getTcpNoDelay</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#isConnected()">isConnected</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setConnectTimeout(int)">setConnectTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setDefaultPort(int)">setDefaultPort</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setDefaultTimeout(int)">setDefaultTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setKeepAlive(boolean)">setKeepAlive</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setReceiveBufferSize(int)">setReceiveBufferSize</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setSendBufferSize(int)">setSendBufferSize</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setServerSocketFactory(javax.net.ServerSocketFactory)">setServerSocketFactory</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setSocketFactory(javax.net.SocketFactory)">setSocketFactory</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setSoLinger(boolean, int)">setSoLinger</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setSoTimeout(int)">setSoTimeout</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#setTcpNoDelay(boolean)">setTcpNoDelay</a>, <a href="../../../../../org/apache/commons/net/SocketClient.html#verifyRemote(java.net.Socket)">verifyRemote</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NNTPClient()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NNTPClient</h4>
<pre>public NNTPClient()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="retrieveArticle(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticle(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Retrieves an article from the NNTP server. The article is referenced
by its unique article identifier (including the enclosing < and >).
The article number and identifier contained in the server reply
are returned through an ArticlePointer. The <code> articleId </code>
field of the ArticlePointer cannot always be trusted because some
NNTP servers do not correctly follow the RFC 977 reply format.
<p>
A DotTerminatedMessageReader is returned from which the article can
be read. If the article does not exist, null is returned.
<p>
You must not issue any commands to the NNTP server (i.e., call any
other methods) until you finish reading the message from the returned
Reader instance.
The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Reader actually reads
directly from the NNTP connection. After the end of message has been
reached, new commands can be executed and their replies read. If
you do not follow these requirements, your program will not work
properly.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleId</code> - The unique article identifier of the article to
retrieve. If this parameter is null, the currently selected
article is retrieved.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageReader instance from which the article
be read. null if the article does not exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="retrieveArticle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticle(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticle(articleId, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticle()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticle(null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticle(int, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticle(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Retrieves an article from the currently selected newsgroup. The
article is referenced by its article number.
The article number and identifier contained in the server reply
are returned through an ArticlePointer. The <code> articleId </code>
field of the ArticlePointer cannot always be trusted because some
NNTP servers do not correctly follow the RFC 977 reply format.
<p>
A DotTerminatedMessageReader is returned from which the article can
be read. If the article does not exist, null is returned.
<p>
You must not issue any commands to the NNTP server (i.e., call any
other methods) until you finish reading the message from the returned
Reader instance.
The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Reader actually reads
directly from the NNTP connection. After the end of message has been
reached, new commands can be executed and their replies read. If
you do not follow these requirements, your program will not work
properly.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleNumber</code> - The number of the the article to
retrieve.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageReader instance from which the article
be read. null if the article does not exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="retrieveArticle(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticle(int articleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticle(articleNumber, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleHeader(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleHeader(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Retrieves an article header from the NNTP server. The article is
referenced
by its unique article identifier (including the enclosing < and >).
The article number and identifier contained in the server reply
are returned through an ArticlePointer. The <code> articleId </code>
field of the ArticlePointer cannot always be trusted because some
NNTP servers do not correctly follow the RFC 977 reply format.
<p>
A DotTerminatedMessageReader is returned from which the article can
be read. If the article does not exist, null is returned.
<p>
You must not issue any commands to the NNTP server (i.e., call any
other methods) until you finish reading the message from the returned
Reader instance.
The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Reader actually reads
directly from the NNTP connection. After the end of message has been
reached, new commands can be executed and their replies read. If
you do not follow these requirements, your program will not work
properly.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleId</code> - The unique article identifier of the article whose
header is being retrieved. If this parameter is null, the
header of the currently selected article is retrieved.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageReader instance from which the article
header can be read. null if the article does not exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="retrieveArticleHeader(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleHeader(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticleHeader(articleId, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleHeader()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticleHeader(null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleHeader(int, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleHeader(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Retrieves an article header from the currently selected newsgroup. The
article is referenced by its article number.
The article number and identifier contained in the server reply
are returned through an ArticlePointer. The <code> articleId </code>
field of the ArticlePointer cannot always be trusted because some
NNTP servers do not correctly follow the RFC 977 reply format.
<p>
A DotTerminatedMessageReader is returned from which the article can
be read. If the article does not exist, null is returned.
<p>
You must not issue any commands to the NNTP server (i.e., call any
other methods) until you finish reading the message from the returned
Reader instance.
The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Reader actually reads
directly from the NNTP connection. After the end of message has been
reached, new commands can be executed and their replies read. If
you do not follow these requirements, your program will not work
properly.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleNumber</code> - The number of the the article whose header is
being retrieved.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageReader instance from which the article
header can be read. null if the article does not exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="retrieveArticleHeader(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleHeader(int articleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticleHeader(articleNumber, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleBody(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleBody</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleBody(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Retrieves an article body from the NNTP server. The article is
referenced
by its unique article identifier (including the enclosing < and >).
The article number and identifier contained in the server reply
are returned through an ArticlePointer. The <code> articleId </code>
field of the ArticlePointer cannot always be trusted because some
NNTP servers do not correctly follow the RFC 977 reply format.
<p>
A DotTerminatedMessageReader is returned from which the article can
be read. If the article does not exist, null is returned.
<p>
You must not issue any commands to the NNTP server (i.e., call any
other methods) until you finish reading the message from the returned
Reader instance.
The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Reader actually reads
directly from the NNTP connection. After the end of message has been
reached, new commands can be executed and their replies read. If
you do not follow these requirements, your program will not work
properly.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleId</code> - The unique article identifier of the article whose
body is being retrieved. If this parameter is null, the
body of the currently selected article is retrieved.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageReader instance from which the article
body can be read. null if the article does not exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="retrieveArticleBody(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleBody</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleBody(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticleBody(articleId, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleBody()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleBody</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleBody()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticleBody(null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleBody(int, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleBody</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleBody(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Retrieves an article body from the currently selected newsgroup. The
article is referenced by its article number.
The article number and identifier contained in the server reply
are returned through an ArticlePointer. The <code> articleId </code>
field of the ArticlePointer cannot always be trusted because some
NNTP servers do not correctly follow the RFC 977 reply format.
<p>
A DotTerminatedMessageReader is returned from which the article can
be read. If the article does not exist, null is returned.
<p>
You must not issue any commands to the NNTP server (i.e., call any
other methods) until you finish reading the message from the returned
Reader instance.
The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Reader actually reads
directly from the NNTP connection. After the end of message has been
reached, new commands can be executed and their replies read. If
you do not follow these requirements, your program will not work
properly.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleNumber</code> - The number of the the article whose body is
being retrieved.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageReader instance from which the article
body can be read. null if the article does not exist.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="retrieveArticleBody(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleBody</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleBody(int articleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> retrieveArticleBody(articleNumber, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="selectNewsgroup(java.lang.String, org.apache.commons.net.nntp.NewsgroupInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNewsgroup</h4>
<pre>public boolean selectNewsgroup(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newsgroup,
<a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a> info)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Select the specified newsgroup to be the target of for future article
retrieval and posting operations. Also return the newsgroup
information contained in the server reply through the info parameter.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newsgroup</code> - The newsgroup to select.</dd><dd><code>info</code> - A parameter through which the newsgroup information of
the selected newsgroup contained in the server reply is returned.
Set this to null if you do not desire this information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if the newsgroup exists and was selected, false otherwise.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="selectNewsgroup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNewsgroup</h4>
<pre>public boolean selectNewsgroup(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newsgroup)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> selectNewsgroup(newsgroup, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="listHelp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listHelp</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> listHelp()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">List the command help from the server.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The sever help information.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="selectArticle(java.lang.String, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectArticle</h4>
<pre>public boolean selectArticle(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Select an article by its unique identifier (including enclosing
< and >) and return its article number and id through the
pointer parameter. This is achieved through the STAT command.
According to RFC 977, this will NOT set the current article pointer
on the server. To do that, you must reference the article by its
number.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleId</code> - The unique article identifier of the article that
is being selectedd. If this parameter is null, the
body of the current article is selected</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if successful, false if not.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="selectArticle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectArticle</h4>
<pre>public boolean selectArticle(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> selectArticle(articleId, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="selectArticle(org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectArticle</h4>
<pre>public boolean selectArticle(<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> selectArticle(null, articleId) </code>. Useful
for retrieving the current article number.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="selectArticle(int, org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectArticle</h4>
<pre>public boolean selectArticle(int articleNumber,
<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Select an article in the currently selected newsgroup by its number.
and return its article number and id through the
pointer parameter. This is achieved through the STAT command.
According to RFC 977, this WILL set the current article pointer
on the server. Use this command to select an article before retrieving
it, or to obtain an article's unique identifier given its number.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleNumber</code> - The number of the article to select from the
currently selected newsgroup.</dd><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. Although the articleId field cannot always
be trusted because of server deviations from RFC 977 reply formats,
we haven't found a server that misformats this information in response
to this particular command. You may set this parameter to null if
you do not desire to retrieve the returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if successful, false if not.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="selectArticle(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectArticle</h4>
<pre>public boolean selectArticle(int articleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> selectArticle(articleNumber, null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="selectPreviousArticle(org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectPreviousArticle</h4>
<pre>public boolean selectPreviousArticle(<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Select the article preceeding the currently selected article in the
currently selected newsgroup and return its number and unique id
through the pointer parameter. Because of deviating server
implementations, the articleId information cannot be trusted. To
obtain the article identifier, issue a
<code> selectArticle(pointer.articleNumber, pointer) </code> immediately
afterward.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if successful, false if not (e.g., there is no previous
article).</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="selectPreviousArticle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectPreviousArticle</h4>
<pre>public boolean selectPreviousArticle()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> selectPreviousArticle(null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="selectNextArticle(org.apache.commons.net.nntp.ArticlePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNextArticle</h4>
<pre>public boolean selectNextArticle(<a href="../../../../../org/apache/commons/net/nntp/ArticlePointer.html" title="class in org.apache.commons.net.nntp">ArticlePointer</a> pointer)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Select the article following the currently selected article in the
currently selected newsgroup and return its number and unique id
through the pointer parameter. Because of deviating server
implementations, the articleId information cannot be trusted. To
obtain the article identifier, issue a
<code> selectArticle(pointer.articleNumber, pointer) </code> immediately
afterward.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pointer</code> - A parameter through which to return the article's
number and unique id. The articleId field cannot always be trusted
because of server deviations from RFC 977 reply formats. You may
set this parameter to null if you do not desire to retrieve the
returned article information.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if successful, false if not (e.g., there is no following
article).</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="selectNextArticle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNextArticle</h4>
<pre>public boolean selectNextArticle()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Same as <code> selectNextArticle(null) </code></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="listNewsgroups()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listNewsgroups</h4>
<pre>public <a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a>[] listNewsgroups()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">List all newsgroups served by the NNTP server. If no newsgroups
are served, a zero length array will be returned. If the command
fails, null will be returned.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of NewsgroupInfo instances containing the information
for each newsgroup served by the NNTP server. If no newsgroups
are served, a zero length array will be returned. If the command
fails, null will be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="listNewsgroups(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listNewsgroups</h4>
<pre>public <a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a>[] listNewsgroups(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> wildmat)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">An overloaded listNewsgroups() command that allows us to
specify with a pattern what groups we want to list. Wraps the
LIST ACTIVE command.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>wildmat</code> - a pseudo-regex pattern (cf. RFC 2980)</dd>
<dt><span class="strong">Returns:</span></dt><dd>An array of NewsgroupInfo instances containing the information
for each newsgroup served by the NNTP server corresponding to the
supplied pattern. If no such newsgroups are served, a zero length
array will be returned. If the command fails, null will be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="listNewNewsgroups(org.apache.commons.net.nntp.NewGroupsOrNewsQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listNewNewsgroups</h4>
<pre>public <a href="../../../../../org/apache/commons/net/nntp/NewsgroupInfo.html" title="class in org.apache.commons.net.nntp">NewsgroupInfo</a>[] listNewNewsgroups(<a href="../../../../../org/apache/commons/net/nntp/NewGroupsOrNewsQuery.html" title="class in org.apache.commons.net.nntp">NewGroupsOrNewsQuery</a> query)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">List all new newsgroups added to the NNTP server since a particular
date subject to the conditions of the specified query. If no new
newsgroups were added, a zero length array will be returned. If the
command fails, null will be returned.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>query</code> - The query restricting how to search for new newsgroups.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An array of NewsgroupInfo instances containing the information
for each new newsgroup added to the NNTP server. If no newsgroups
were added, a zero length array will be returned. If the command
fails, null will be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="listNewNews(org.apache.commons.net.nntp.NewGroupsOrNewsQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listNewNews</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] listNewNews(<a href="../../../../../org/apache/commons/net/nntp/NewGroupsOrNewsQuery.html" title="class in org.apache.commons.net.nntp">NewGroupsOrNewsQuery</a> query)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">List all new articles added to the NNTP server since a particular
date subject to the conditions of the specified query. If no new
new news is found, a zero length array will be returned. If the
command fails, null will be returned. You must add at least one
newsgroup to the query, else the command will fail. Each String
in the returned array is a unique message identifier including the
enclosing < and >.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>query</code> - The query restricting how to search for new news. You
must add at least one newsgroup to the query.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An array of String instances containing the unique message
identifiers for each new article added to the NNTP server. If no
new news is found, a zero length array will be returned. If the
command fails, null will be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="completePendingCommand()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completePendingCommand</h4>
<pre>public boolean completePendingCommand()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">There are a few NNTPClient methods that do not complete the
entire sequence of NNTP commands to complete a transaction. These
commands require some action by the programmer after the reception
of a positive preliminary command. After the programmer's code
completes its actions, it must call this method to receive
the completion reply from the server and verify the success of the
entire transaction.
<p>
For example
<pre>
writer = client.postArticle();
if(writer == null) // failure
return false;
header = new SimpleNNTPHeader("foobar@foo.com", "Just testing");
header.addNewsgroup("alt.test");
writer.write(header.toString());
writer.write("This is just a test");
writer.close();
if(!client.completePendingCommand()) // failure
return false;
</pre>
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if successfully completed, false if not.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/net/nntp/NNTPConnectionClosedException.html" title="class in org.apache.commons.net.nntp">NNTPConnectionClosedException</a></code> - If the NNTP server prematurely closes the connection as a result
of the client being idle or some other reason causing the server
to send NNTP reply code 400. This exception may be caught either
as an IOException or independently as itself.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="postArticle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> postArticle()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Post an article to the NNTP server. This method returns a
DotTerminatedMessageWriter instance to which the article can be
written. Null is returned if the posting attempt fails. You
should check <a href="../../../../../org/apache/commons/net/nntp/NNTP.html#isAllowedToPost()"><code>isAllowedToPost() </code></a>
before trying to post. However, a posting
attempt can fail due to malformed headers.
<p>
You must not issue any commands to the NNTP server (i.e., call any
(other methods) until you finish writing to the returned Writer
instance and close it. The NNTP protocol uses the same stream for
issuing commands as it does for returning results. Therefore the
returned Writer actually writes directly to the NNTP connection.
After you close the writer, you can execute new commands. If you
do not follow these requirements your program will not work properly.
<p>
Different NNTP servers will require different header formats, but
you can use the provided
<a href="../../../../../org/apache/commons/net/nntp/SimpleNNTPHeader.html" title="class in org.apache.commons.net.nntp"><code>SimpleNNTPHeader</code></a>
class to construct the bare minimum acceptable header for most
news readers. To construct more complicated headers you should
refer to RFC 822. When the Java Mail API is finalized, you will be
able to use it to compose fully compliant Internet text messages.
The DotTerminatedMessageWriter takes care of doubling line-leading
dots and ending the message with a single dot upon closing, so all
you have to worry about is writing the header and the message.
<p>
Upon closing the returned Writer, you need to call
<a href="../../../../../org/apache/commons/net/nntp/NNTPClient.html#completePendingCommand()"><code>completePendingCommand() </code></a>
to finalize the posting and verify its success or failure from
the server reply.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A DotTerminatedMessageWriter to which the article (including
header) can be written. Returns null if the command fails.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="forwardArticle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forwardArticle</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> forwardArticle(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> articleId)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="logout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logout</h4>
<pre>public boolean logout()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Logs out of the news server gracefully by sending the QUIT command.
However, you must still disconnect from the server before you can open
a new connection.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if successfully completed, false if not.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.</dd></dl>
</li>
</ul>
<a name="authenticate(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre>public boolean authenticate(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Log into a news server by sending the AUTHINFO USER/AUTHINFO
PASS command sequence. This is usually sent in response to a
480 reply code from the NNTP server.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - a valid username</dd><dd><code>password</code> - the corresponding password</dd>
<dt><span class="strong">Returns:</span></dt><dd>True for successful login, false for a failure</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleInfo(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleInfo</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleInfo(int articleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Return article headers for a specified post.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>articleNumber</code> - the article to retrieve headers for</dd>
<dt><span class="strong">Returns:</span></dt><dd>a DotTerminatedReader if successful, null otherwise</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveArticleInfo(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveArticleInfo</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveArticleInfo(int lowArticleNumber,
int highArticleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Return article headers for all articles between lowArticleNumber
and highArticleNumber, inclusively.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lowArticleNumber</code> - </dd><dd><code>highArticleNumber</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>a DotTerminatedReader if successful, null otherwise</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveHeader(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveHeader(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header,
int articleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Return an article header for a specified post.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> - the header to retrieve</dd><dd><code>articleNumber</code> - the article to retrieve the header for</dd>
<dt><span class="strong">Returns:</span></dt><dd>a DotTerminatedReader if successful, null otherwise</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="retrieveHeader(java.lang.String, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>retrieveHeader</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> retrieveHeader(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header,
int lowArticleNumber,
int highArticleNumber)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Return an article header for all articles between lowArticleNumber
and highArticleNumber, inclusively.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> - </dd><dd><code>lowArticleNumber</code> - </dd><dd><code>highArticleNumber</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>a DotTerminatedReader if successful, null otherwise</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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="../../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/net/nntp/NNTPCommand.html" title="class in org.apache.commons.net.nntp"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/net/nntp/NNTPClient.html" target="_top">Frames</a></li>
<li><a href="NNTPClient.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><a href="#fields_inherited_from_class_org.apache.commons.net.nntp.NNTP">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|