/usr/share/doc/libtrilead-ssh2-java/api/com/trilead/ssh2/SFTPv3Client.html is in libtrilead-ssh2-java 6401+svn158-1.
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 | <!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_65) on Fri Dec 12 11:10:37 UTC 2014 -->
<title>SFTPv3Client</title>
<meta name="date" content="2014-12-12">
<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="SFTPv3Client";
}
//-->
</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="../../../com/trilead/ssh2/SFTPException.html" title="class in com.trilead.ssh2"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/trilead/ssh2/SFTPv3DirectoryEntry.html" title="class in com.trilead.ssh2"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/trilead/ssh2/SFTPv3Client.html" target="_top">Frames</a></li>
<li><a href="SFTPv3Client.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><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">com.trilead.ssh2</div>
<h2 title="Class SFTPv3Client" class="title">Class SFTPv3Client</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.trilead.ssh2.SFTPv3Client</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SFTPv3Client</span>
extends java.lang.Object</pre>
<div class="block">A <code>SFTPv3Client</code> represents a SFTP (protocol version 3)
client connection tunnelled over a SSH-2 connection. This is a very simple
(synchronous) implementation.
<p>
Basically, most methods in this class map directly to one of
the packet types described in draft-ietf-secsh-filexfer-02.txt.
<p>
Note: this is experimental code.
<p>
Error handling: the methods of this class throw IOExceptions. However, unless
there is catastrophic failure, exceptions of the type <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>SFTPv3Client</code></a> will
be thrown (a subclass of IOException). Therefore, you can implement more verbose
behavior by checking if a thrown exception if of this type. If yes, then you
can cast the exception and access detailed information about the failure.
<p>
Notes about file names, directory names and paths, copy-pasted
from the specs:
<ul>
<li>SFTP v3 represents file names as strings. File names are
assumed to use the slash ('/') character as a directory separator.</li>
<li>File names starting with a slash are "absolute", and are relative to
the root of the file system. Names starting with any other character
are relative to the user's default directory (home directory).</li>
<li>Servers SHOULD interpret a path name component ".." as referring to
the parent directory, and "." as referring to the current directory.
If the server implementation limits access to certain parts of the
file system, it must be extra careful in parsing file names when
enforcing such restrictions. There have been numerous reported
security bugs where a ".." in a path name has allowed access outside
the intended area.</li>
<li>An empty path name is valid, and it refers to the user's default
directory (usually the user's home directory).</li>
</ul>
<p>
If you are still not tired then please go on and read the comment for
<a href="../../../com/trilead/ssh2/SFTPv3Client.html#setCharset(java.lang.String)"><code>setCharset(String)</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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="../../../com/trilead/ssh2/SFTPv3Client.html#SFTPv3Client(com.trilead.ssh2.Connection)">SFTPv3Client</a></strong>(<a href="../../../com/trilead/ssh2/Connection.html" title="class in com.trilead.ssh2">Connection</a> conn)</code>
<div class="block">Create a SFTP v3 client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#SFTPv3Client(com.trilead.ssh2.Connection,%20java.io.PrintStream)">SFTPv3Client</a></strong>(<a href="../../../com/trilead/ssh2/Connection.html" title="class in com.trilead.ssh2">Connection</a> conn,
java.io.PrintStream debug)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>this constructor (debug version) will disappear in the future,
use <a href="../../../com/trilead/ssh2/SFTPv3Client.html#SFTPv3Client(com.trilead.ssh2.Connection)"><code>SFTPv3Client(Connection)</code></a> instead.</i></div>
</div>
</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>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#canonicalPath(java.lang.String)">canonicalPath</a></strong>(java.lang.String path)</code>
<div class="block">Have the server canonicalize any given path name to an absolute path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#close()">close</a></strong>()</code>
<div class="block">Close this SFTP session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#closeFile(com.trilead.ssh2.SFTPv3FileHandle)">closeFile</a></strong>(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle)</code>
<div class="block">Close a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#createFile(java.lang.String)">createFile</a></strong>(java.lang.String fileName)</code>
<div class="block">Create a file and open it for reading and writing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#createFile(java.lang.String,%20com.trilead.ssh2.SFTPv3FileAttributes)">createFile</a></strong>(java.lang.String fileName,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)</code>
<div class="block">Create a file and open it for reading and writing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#createFileTruncate(java.lang.String)">createFileTruncate</a></strong>(java.lang.String fileName)</code>
<div class="block">Create a file (truncate it if it already exists) and open it for reading and writing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#createFileTruncate(java.lang.String,%20com.trilead.ssh2.SFTPv3FileAttributes)">createFileTruncate</a></strong>(java.lang.String fileName,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)</code>
<div class="block">reate a file (truncate it if it already exists) and open it for reading and writing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#createSymlink(java.lang.String,%20java.lang.String)">createSymlink</a></strong>(java.lang.String src,
java.lang.String target)</code>
<div class="block">Create a symbolic link on the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#fsetstat(com.trilead.ssh2.SFTPv3FileHandle,%20com.trilead.ssh2.SFTPv3FileAttributes)">fsetstat</a></strong>(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)</code>
<div class="block">Modify the attributes of a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#fstat(com.trilead.ssh2.SFTPv3FileHandle)">fstat</a></strong>(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle)</code>
<div class="block">Retrieve the file attributes of an open file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#getCharset()">getCharset</a></strong>()</code>
<div class="block">The currently used charset for filename encoding/decoding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#getProtocolVersion()">getProtocolVersion</a></strong>()</code>
<div class="block">Returns the negotiated SFTP protocol version between the client and the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Vector</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#ls(java.lang.String)">ls</a></strong>(java.lang.String dirName)</code>
<div class="block">List the contents of a directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#lstat(java.lang.String)">lstat</a></strong>(java.lang.String path)</code>
<div class="block">Retrieve the file attributes of a file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#mkdir(java.lang.String,%20int)">mkdir</a></strong>(java.lang.String dirName,
int posixPermissions)</code>
<div class="block">Create a new directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#mv(java.lang.String,%20java.lang.String)">mv</a></strong>(java.lang.String oldPath,
java.lang.String newPath)</code>
<div class="block">Move a file or directory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#openFileRO(java.lang.String)">openFileRO</a></strong>(java.lang.String fileName)</code>
<div class="block">Open a file for reading.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#openFileRW(java.lang.String)">openFileRW</a></strong>(java.lang.String fileName)</code>
<div class="block">Open a file for reading and writing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#read(com.trilead.ssh2.SFTPv3FileHandle,%20long,%20byte[],%20int,%20int)">read</a></strong>(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle,
long fileOffset,
byte[] dst,
int dstoff,
int len)</code>
<div class="block">Read bytes from a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#readLink(java.lang.String)">readLink</a></strong>(java.lang.String path)</code>
<div class="block">Read the target of a symbolic link.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#rm(java.lang.String)">rm</a></strong>(java.lang.String fileName)</code>
<div class="block">Remove a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#rmdir(java.lang.String)">rmdir</a></strong>(java.lang.String dirName)</code>
<div class="block">Remove an empty directory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#setCharset(java.lang.String)">setCharset</a></strong>(java.lang.String charset)</code>
<div class="block">Set the charset used to convert between Java Unicode Strings and byte encodings
used by the server for paths and file names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#setstat(java.lang.String,%20com.trilead.ssh2.SFTPv3FileAttributes)">setstat</a></strong>(java.lang.String path,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)</code>
<div class="block">Modify the attributes of a file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#stat(java.lang.String)">stat</a></strong>(java.lang.String path)</code>
<div class="block">Retrieve the file attributes of a file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/trilead/ssh2/SFTPv3Client.html#write(com.trilead.ssh2.SFTPv3FileHandle,%20long,%20byte[],%20int,%20int)">write</a></strong>(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle,
long fileOffset,
byte[] src,
int srcoff,
int len)</code>
<div class="block">Write bytes to a file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="SFTPv3Client(com.trilead.ssh2.Connection, java.io.PrintStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SFTPv3Client</h4>
<pre>public SFTPv3Client(<a href="../../../com/trilead/ssh2/Connection.html" title="class in com.trilead.ssh2">Connection</a> conn,
java.io.PrintStream debug)
throws java.io.IOException</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>this constructor (debug version) will disappear in the future,
use <a href="../../../com/trilead/ssh2/SFTPv3Client.html#SFTPv3Client(com.trilead.ssh2.Connection)"><code>SFTPv3Client(Connection)</code></a> instead.</i></div>
<div class="block">Create a SFTP v3 client.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conn</code> - The underlying SSH-2 connection to be used.</dd><dd><code>debug</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="SFTPv3Client(com.trilead.ssh2.Connection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SFTPv3Client</h4>
<pre>public SFTPv3Client(<a href="../../../com/trilead/ssh2/Connection.html" title="class in com.trilead.ssh2">Connection</a> conn)
throws java.io.IOException</pre>
<div class="block">Create a SFTP v3 client.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conn</code> - The underlying SSH-2 connection to be used.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setCharset(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCharset</h4>
<pre>public void setCharset(java.lang.String charset)
throws java.io.IOException</pre>
<div class="block">Set the charset used to convert between Java Unicode Strings and byte encodings
used by the server for paths and file names. Unfortunately, the SFTP v3 draft
says NOTHING about such conversions (well, with the exception of error messages
which have to be in UTF-8). Newer drafts specify to use UTF-8 for file names
(if I remember correctly). However, a quick test using OpenSSH serving a EXT-3
filesystem has shown that UTF-8 seems to be a bad choice for SFTP v3 (tested with
filenames containing german umlauts). "windows-1252" seems to work better for Europe.
Luckily, "windows-1252" is the platform default in my case =).
<p>
If you don't set anything, then the platform default will be used (this is the default
behavior).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - the name of the charset to be used or <code>null</code> to use the platform's
default encoding.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/trilead/ssh2/SFTPv3Client.html#getCharset()"><code>getCharset()</code></a></dd></dl>
</li>
</ul>
<a name="getCharset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharset</h4>
<pre>public java.lang.String getCharset()</pre>
<div class="block">The currently used charset for filename encoding/decoding.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The name of the charset (<code>null</code> if the platform's default charset is being used)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/trilead/ssh2/SFTPv3Client.html#setCharset(java.lang.String)"><code>setCharset(String)</code></a></dd></dl>
</li>
</ul>
<a name="fstat(com.trilead.ssh2.SFTPv3FileHandle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fstat</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> fstat(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle)
throws java.io.IOException</pre>
<div class="block">Retrieve the file attributes of an open file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - a SFTPv3FileHandle handle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileAttributes object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="stat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stat</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> stat(java.lang.String path)
throws java.io.IOException</pre>
<div class="block">Retrieve the file attributes of a file. This method
follows symbolic links on the server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileAttributes object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/trilead/ssh2/SFTPv3Client.html#lstat(java.lang.String)"><code>lstat(String)</code></a></dd></dl>
</li>
</ul>
<a name="lstat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lstat</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> lstat(java.lang.String path)
throws java.io.IOException</pre>
<div class="block">Retrieve the file attributes of a file. This method
does NOT follow symbolic links on the server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileAttributes object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/trilead/ssh2/SFTPv3Client.html#stat(java.lang.String)"><code>stat(String)</code></a></dd></dl>
</li>
</ul>
<a name="readLink(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLink</h4>
<pre>public java.lang.String readLink(java.lang.String path)
throws java.io.IOException</pre>
<div class="block">Read the target of a symbolic link.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The target of the link.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="setstat(java.lang.String, com.trilead.ssh2.SFTPv3FileAttributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setstat</h4>
<pre>public void setstat(java.lang.String path,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)
throws java.io.IOException</pre>
<div class="block">Modify the attributes of a file. Used for operations such as changing
the ownership, permissions or access times, as well as for truncating a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd><dd><code>attr</code> - A SFTPv3FileAttributes object. Specifies the modifications to be
made to the attributes of the file. Empty fields will be ignored.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="fsetstat(com.trilead.ssh2.SFTPv3FileHandle, com.trilead.ssh2.SFTPv3FileAttributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fsetstat</h4>
<pre>public void fsetstat(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)
throws java.io.IOException</pre>
<div class="block">Modify the attributes of a file. Used for operations such as changing
the ownership, permissions or access times, as well as for truncating a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - a SFTPv3FileHandle handle</dd><dd><code>attr</code> - A SFTPv3FileAttributes object. Specifies the modifications to be
made to the attributes of the file. Empty fields will be ignored.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createSymlink(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSymlink</h4>
<pre>public void createSymlink(java.lang.String src,
java.lang.String target)
throws java.io.IOException</pre>
<div class="block">Create a symbolic link on the server. Creates a link "src" that points
to "target".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd><dd><code>target</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="canonicalPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canonicalPath</h4>
<pre>public java.lang.String canonicalPath(java.lang.String path)
throws java.io.IOException</pre>
<div class="block">Have the server canonicalize any given path name to an absolute path.
This is useful for converting path names containing ".." components or
relative pathnames without a leading slash into absolute paths.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An absolute path.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getProtocolVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolVersion</h4>
<pre>public int getProtocolVersion()</pre>
<div class="block">Returns the negotiated SFTP protocol version between the client and the server.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>SFTP protocol version, i.e., "3".</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()</pre>
<div class="block">Close this SFTP session. NEVER forget to call this method to free up
resources - even if you got an exception from one of the other methods.
Sometimes these other methods may throw an exception, saying that the
underlying channel is closed (this can happen, e.g., if the other server
sent a close message.) However, as long as you have not called the
<code>close()</code> method, you are likely wasting resources.</div>
</li>
</ul>
<a name="ls(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ls</h4>
<pre>public java.util.Vector ls(java.lang.String dirName)
throws java.io.IOException</pre>
<div class="block">List the contents of a directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dirName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A Vector containing <a href="../../../com/trilead/ssh2/SFTPv3DirectoryEntry.html" title="class in com.trilead.ssh2"><code>SFTPv3DirectoryEntry</code></a> objects.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="mkdir(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mkdir</h4>
<pre>public void mkdir(java.lang.String dirName,
int posixPermissions)
throws java.io.IOException</pre>
<div class="block">Create a new directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dirName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd><dd><code>posixPermissions</code> - the permissions for this directory, e.g., "0700" (remember that
this is octal noation). The server will likely apply a umask.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="rm(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rm</h4>
<pre>public void rm(java.lang.String fileName)
throws java.io.IOException</pre>
<div class="block">Remove a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="rmdir(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rmdir</h4>
<pre>public void rmdir(java.lang.String dirName)
throws java.io.IOException</pre>
<div class="block">Remove an empty directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dirName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="mv(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mv</h4>
<pre>public void mv(java.lang.String oldPath,
java.lang.String newPath)
throws java.io.IOException</pre>
<div class="block">Move a file or directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldPath</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd><dd><code>newPath</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="openFileRO(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openFileRO</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> openFileRO(java.lang.String fileName)
throws java.io.IOException</pre>
<div class="block">Open a file for reading.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="openFileRW(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openFileRW</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> openFileRW(java.lang.String fileName)
throws java.io.IOException</pre>
<div class="block">Open a file for reading and writing.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFile</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> createFile(java.lang.String fileName)
throws java.io.IOException</pre>
<div class="block">Create a file and open it for reading and writing.
Same as <a href="../../../com/trilead/ssh2/SFTPv3Client.html#createFile(java.lang.String,%20com.trilead.ssh2.SFTPv3FileAttributes)"><code>createFile(fileName, null)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createFile(java.lang.String, com.trilead.ssh2.SFTPv3FileAttributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFile</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> createFile(java.lang.String fileName,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)
throws java.io.IOException</pre>
<div class="block">Create a file and open it for reading and writing.
You can specify the default attributes of the file (the server may or may
not respect your wishes).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd><dd><code>attr</code> - may be <code>null</code> to use server defaults. Probably only
the <code>uid</code>, <code>gid</code> and <code>permissions</code>
(remember the server may apply a umask) entries of the <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2"><code>SFTPv3FileHandle</code></a>
structure make sense. You need only to set those fields where you want
to override the server's defaults.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createFileTruncate(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFileTruncate</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> createFileTruncate(java.lang.String fileName)
throws java.io.IOException</pre>
<div class="block">Create a file (truncate it if it already exists) and open it for reading and writing.
Same as <a href="../../../com/trilead/ssh2/SFTPv3Client.html#createFileTruncate(java.lang.String,%20com.trilead.ssh2.SFTPv3FileAttributes)"><code>createFileTruncate(fileName, null)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createFileTruncate(java.lang.String, com.trilead.ssh2.SFTPv3FileAttributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFileTruncate</h4>
<pre>public <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> createFileTruncate(java.lang.String fileName,
<a href="../../../com/trilead/ssh2/SFTPv3FileAttributes.html" title="class in com.trilead.ssh2">SFTPv3FileAttributes</a> attr)
throws java.io.IOException</pre>
<div class="block">reate a file (truncate it if it already exists) and open it for reading and writing.
You can specify the default attributes of the file (the server may or may
not respect your wishes).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - See the <a href="../../../com/trilead/ssh2/SFTPv3Client.html" title="class in com.trilead.ssh2"><code>comment</code></a> for the class for more details.</dd><dd><code>attr</code> - may be <code>null</code> to use server defaults. Probably only
the <code>uid</code>, <code>gid</code> and <code>permissions</code>
(remember the server may apply a umask) entries of the <a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2"><code>SFTPv3FileHandle</code></a>
structure make sense. You need only to set those fields where you want
to override the server's defaults.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="read(com.trilead.ssh2.SFTPv3FileHandle, long, byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle,
long fileOffset,
byte[] dst,
int dstoff,
int len)
throws java.io.IOException</pre>
<div class="block">Read bytes from a file. No more than 32768 bytes may be read at once.
Be aware that the semantics of read() are different than for Java streams.
<p>
<ul>
<li>The server will read as many bytes as it can from the file (up to <code>len</code>),
and return them.</li>
<li>If EOF is encountered before reading any data, <code>-1</code> is returned.
<li>If an error occurs, an exception is thrown</li>.
<li>For normal disk files, it is guaranteed that the server will return the specified
number of bytes, or up to end of file. For, e.g., device files this may return
fewer bytes than requested.</li>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - a SFTPv3FileHandle handle</dd><dd><code>fileOffset</code> - offset (in bytes) in the file</dd><dd><code>dst</code> - the destination byte array</dd><dd><code>dstoff</code> - offset in the destination byte array</dd><dd><code>len</code> - how many bytes to read, 0 < len <= 32768 bytes</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes that could be read, may be less than requested if
the end of the file is reached, -1 is returned in case of <code>EOF</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="write(com.trilead.ssh2.SFTPv3FileHandle, long, byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public void write(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle,
long fileOffset,
byte[] src,
int srcoff,
int len)
throws java.io.IOException</pre>
<div class="block">Write bytes to a file. If <code>len</code> > 32768, then the write operation will
be split into multiple writes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - a SFTPv3FileHandle handle.</dd><dd><code>fileOffset</code> - offset (in bytes) in the file.</dd><dd><code>src</code> - the source byte array.</dd><dd><code>srcoff</code> - offset in the source byte array.</dd><dd><code>len</code> - how many bytes to write.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="closeFile(com.trilead.ssh2.SFTPv3FileHandle)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>closeFile</h4>
<pre>public void closeFile(<a href="../../../com/trilead/ssh2/SFTPv3FileHandle.html" title="class in com.trilead.ssh2">SFTPv3FileHandle</a> handle)
throws java.io.IOException</pre>
<div class="block">Close a file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - a SFTPv3FileHandle handle</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</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="../../../com/trilead/ssh2/SFTPException.html" title="class in com.trilead.ssh2"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/trilead/ssh2/SFTPv3DirectoryEntry.html" title="class in com.trilead.ssh2"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/trilead/ssh2/SFTPv3Client.html" target="_top">Frames</a></li>
<li><a href="SFTPv3Client.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><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>
|