/usr/share/doc/libganymed-ssh2-java/api/ch/ethz/ssh2/sftp/OpenFlags.html is in libganymed-ssh2-java 250-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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Wed Sep 14 21:06:28 UTC 2011 -->
<TITLE>
OpenFlags
</TITLE>
<META NAME="date" CONTENT="2011-09-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OpenFlags";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../ch/ethz/ssh2/sftp/ErrorCodes.html" title="class in ch.ethz.ssh2.sftp"><B>PREV CLASS</B></A>
<A HREF="../../../../ch/ethz/ssh2/sftp/Packet.html" title="class in ch.ethz.ssh2.sftp"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?ch/ethz/ssh2/sftp/OpenFlags.html" target="_top"><B>FRAMES</B></A>
<A HREF="OpenFlags.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
ch.ethz.ssh2.sftp</FONT>
<BR>
Class OpenFlags</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>ch.ethz.ssh2.sftp.OpenFlags</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>OpenFlags</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
SFTP Open Flags.
The following table is provided to assist in mapping POSIX semantics
to equivalent SFTP file open parameters:
<p>
TODO: This comment should be moved to the open method.
<p>
<ul>
<li>O_RDONLY
<ul><li>desired-access = READ_DATA | READ_ATTRIBUTES</li></ul>
</li>
</ul>
<ul>
<li>O_WRONLY
<ul><li>desired-access = WRITE_DATA | WRITE_ATTRIBUTES</li></ul>
</li>
</ul>
<ul>
<li>O_RDWR
<ul><li>desired-access = READ_DATA | READ_ATTRIBUTES | WRITE_DATA | WRITE_ATTRIBUTES</li></ul>
</li>
</ul>
<ul>
<li>O_APPEND
<ul>
<li>desired-access = WRITE_DATA | WRITE_ATTRIBUTES | APPEND_DATA</li>
<li>flags = SSH_FXF_ACCESS_APPEND_DATA and or SSH_FXF_ACCESS_APPEND_DATA_ATOMIC</li>
</ul>
</li>
</ul>
<ul>
<li>O_CREAT
<ul>
<li>flags = SSH_FXF_OPEN_OR_CREATE</li>
</ul>
</li>
</ul>
<ul>
<li>O_TRUNC
<ul>
<li>flags = SSH_FXF_TRUNCATE_EXISTING</li>
</ul>
</li>
</ul>
<ul>
<li>O_TRUNC|O_CREATE
<ul>
<li>flags = SSH_FXF_CREATE_TRUNCATE</li>
</ul>
</li>
</ul>
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_APPEND_DATA">SSH_FXF_ACCESS_APPEND_DATA</A></B></CODE>
<BR>
Data is always written at the end of the file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_APPEND_DATA_ATOMIC">SSH_FXF_ACCESS_APPEND_DATA_ATOMIC</A></B></CODE>
<BR>
Data is always written at the end of the file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_BLOCK_ADVISORY">SSH_FXF_ACCESS_BLOCK_ADVISORY</A></B></CODE>
<BR>
If this bit is set, the above BLOCK modes are advisory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_BLOCK_DELETE">SSH_FXF_ACCESS_BLOCK_DELETE</A></B></CODE>
<BR>
The server MUST guarantee that no other handle has been opened
with ACE4_DELETE access, opened with the
SSH_FXF_ACCESS_DELETE_ON_CLOSE flag set, and that no other handle
will be opened with ACE4_DELETE access or with the
SSH_FXF_ACCESS_DELETE_ON_CLOSE flag set, and that the file itself
is not deleted in any other way until the client closes the handle.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_BLOCK_READ">SSH_FXF_ACCESS_BLOCK_READ</A></B></CODE>
<BR>
The server MUST guarantee that no other handle has been opened
with ACE4_READ_DATA access, and that no other handle will be
opened with ACE4_READ_DATA access until the client closes the
handle.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_BLOCK_WRITE">SSH_FXF_ACCESS_BLOCK_WRITE</A></B></CODE>
<BR>
The server MUST guarantee that no other handle has been opened
with ACE4_WRITE_DATA or ACE4_APPEND_DATA access, and that no other
handle will be opened with ACE4_WRITE_DATA or ACE4_APPEND_DATA
access until the client closes the handle.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_DELETE_ON_CLOSE">SSH_FXF_ACCESS_DELETE_ON_CLOSE</A></B></CODE>
<BR>
The file should be deleted when the last handle to it is closed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_DISPOSITION">SSH_FXF_ACCESS_DISPOSITION</A></B></CODE>
<BR>
Disposition is a 3 bit field that controls how the file is opened.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_NOFOLLOW">SSH_FXF_ACCESS_NOFOLLOW</A></B></CODE>
<BR>
If the final component of the path is a symlink, then the open
MUST fail, and the error SSH_FX_LINK_LOOP MUST be returned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_ACCESS_TEXT_MODE">SSH_FXF_ACCESS_TEXT_MODE</A></B></CODE>
<BR>
Indicates that the server should treat the file as text and
convert it to the canonical newline convention in use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_CREATE_NEW">SSH_FXF_CREATE_NEW</A></B></CODE>
<BR>
A new file is created; if the file already exists, the server
MUST return status SSH_FX_FILE_ALREADY_EXISTS.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_CREATE_TRUNCATE">SSH_FXF_CREATE_TRUNCATE</A></B></CODE>
<BR>
A new file is created; if the file already exists, it is opened
and truncated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_OPEN_EXISTING">SSH_FXF_OPEN_EXISTING</A></B></CODE>
<BR>
An existing file is opened.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_OPEN_OR_CREATE">SSH_FXF_OPEN_OR_CREATE</A></B></CODE>
<BR>
If the file exists, it is opened.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#SSH_FXF_TRUNCATE_EXISTING">SSH_FXF_TRUNCATE_EXISTING</A></B></CODE>
<BR>
An existing file is opened and truncated.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../ch/ethz/ssh2/sftp/OpenFlags.html#OpenFlags()">OpenFlags</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SSH_FXF_ACCESS_DISPOSITION"><!-- --></A><H3>
SSH_FXF_ACCESS_DISPOSITION</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_DISPOSITION</B></PRE>
<DL>
<DD>Disposition is a 3 bit field that controls how the file is opened.
The server MUST support these bits (possible enumaration values:
SSH_FXF_CREATE_NEW, SSH_FXF_CREATE_TRUNCATE, SSH_FXF_OPEN_EXISTING,
SSH_FXF_OPEN_OR_CREATE or SSH_FXF_TRUNCATE_EXISTING).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_DISPOSITION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_CREATE_NEW"><!-- --></A><H3>
SSH_FXF_CREATE_NEW</H3>
<PRE>
public static final int <B>SSH_FXF_CREATE_NEW</B></PRE>
<DL>
<DD>A new file is created; if the file already exists, the server
MUST return status SSH_FX_FILE_ALREADY_EXISTS.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_CREATE_NEW">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_CREATE_TRUNCATE"><!-- --></A><H3>
SSH_FXF_CREATE_TRUNCATE</H3>
<PRE>
public static final int <B>SSH_FXF_CREATE_TRUNCATE</B></PRE>
<DL>
<DD>A new file is created; if the file already exists, it is opened
and truncated.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_CREATE_TRUNCATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_OPEN_EXISTING"><!-- --></A><H3>
SSH_FXF_OPEN_EXISTING</H3>
<PRE>
public static final int <B>SSH_FXF_OPEN_EXISTING</B></PRE>
<DL>
<DD>An existing file is opened. If the file does not exist, the
server MUST return SSH_FX_NO_SUCH_FILE. If a directory in the
path does not exist, the server SHOULD return
SSH_FX_NO_SUCH_PATH. It is also acceptable if the server
returns SSH_FX_NO_SUCH_FILE in this case.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_OPEN_EXISTING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_OPEN_OR_CREATE"><!-- --></A><H3>
SSH_FXF_OPEN_OR_CREATE</H3>
<PRE>
public static final int <B>SSH_FXF_OPEN_OR_CREATE</B></PRE>
<DL>
<DD>If the file exists, it is opened. If the file does not exist,
it is created.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_OPEN_OR_CREATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_TRUNCATE_EXISTING"><!-- --></A><H3>
SSH_FXF_TRUNCATE_EXISTING</H3>
<PRE>
public static final int <B>SSH_FXF_TRUNCATE_EXISTING</B></PRE>
<DL>
<DD>An existing file is opened and truncated. If the file does not
exist, the server MUST return the same error codes as defined
for SSH_FXF_OPEN_EXISTING.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_TRUNCATE_EXISTING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_APPEND_DATA"><!-- --></A><H3>
SSH_FXF_ACCESS_APPEND_DATA</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_APPEND_DATA</B></PRE>
<DL>
<DD>Data is always written at the end of the file. The offset field
of the SSH_FXP_WRITE requests are ignored.
<p>
Data is not required to be appended atomically. This means that
if multiple writers attempt to append data simultaneously, data
from the first may be lost. However, data MAY be appended
atomically.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_APPEND_DATA">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_APPEND_DATA_ATOMIC"><!-- --></A><H3>
SSH_FXF_ACCESS_APPEND_DATA_ATOMIC</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_APPEND_DATA_ATOMIC</B></PRE>
<DL>
<DD>Data is always written at the end of the file. The offset field
of the SSH_FXP_WRITE requests are ignored.
<p>
Data MUST be written atomically so that there is no chance that
multiple appenders can collide and result in data being lost.
<p>
If both append flags are specified, the server SHOULD use atomic
append if it is available, but SHOULD use non-atomic appends
otherwise. The server SHOULD NOT fail the request in this case.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_APPEND_DATA_ATOMIC">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_TEXT_MODE"><!-- --></A><H3>
SSH_FXF_ACCESS_TEXT_MODE</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_TEXT_MODE</B></PRE>
<DL>
<DD>Indicates that the server should treat the file as text and
convert it to the canonical newline convention in use.
(See Determining Server Newline Convention in section 5.3 in the
SFTP standard draft).
<p>
When a file is opened with this flag, the offset field in the read
and write functions is ignored.
<p>
Servers MUST process multiple, parallel reads and writes correctly
in this mode. Naturally, it is permissible for them to do this by
serializing the requests.
<p>
Clients SHOULD use the SSH_FXF_ACCESS_APPEND_DATA flag to append
data to a text file rather then using write with a calculated offset.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_TEXT_MODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_BLOCK_READ"><!-- --></A><H3>
SSH_FXF_ACCESS_BLOCK_READ</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_BLOCK_READ</B></PRE>
<DL>
<DD>The server MUST guarantee that no other handle has been opened
with ACE4_READ_DATA access, and that no other handle will be
opened with ACE4_READ_DATA access until the client closes the
handle. (This MUST apply both to other clients and to other
processes on the server.)
<p>
If there is a conflicting lock the server MUST return
SSH_FX_LOCK_CONFLICT. If the server cannot make the locking
guarantee, it MUST return SSH_FX_OP_UNSUPPORTED.
<p>
Other handles MAY be opened for ACE4_WRITE_DATA or any other
combination of accesses, as long as ACE4_READ_DATA is not included
in the mask.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_BLOCK_READ">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_BLOCK_WRITE"><!-- --></A><H3>
SSH_FXF_ACCESS_BLOCK_WRITE</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_BLOCK_WRITE</B></PRE>
<DL>
<DD>The server MUST guarantee that no other handle has been opened
with ACE4_WRITE_DATA or ACE4_APPEND_DATA access, and that no other
handle will be opened with ACE4_WRITE_DATA or ACE4_APPEND_DATA
access until the client closes the handle. (This MUST apply both
to other clients and to other processes on the server.)
<p>
If there is a conflicting lock the server MUST return
SSH_FX_LOCK_CONFLICT. If the server cannot make the locking
guarantee, it MUST return SSH_FX_OP_UNSUPPORTED.
<p>
Other handles MAY be opened for ACE4_READ_DATA or any other
combination of accesses, as long as neither ACE4_WRITE_DATA nor
ACE4_APPEND_DATA are included in the mask.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_BLOCK_WRITE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_BLOCK_DELETE"><!-- --></A><H3>
SSH_FXF_ACCESS_BLOCK_DELETE</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_BLOCK_DELETE</B></PRE>
<DL>
<DD>The server MUST guarantee that no other handle has been opened
with ACE4_DELETE access, opened with the
SSH_FXF_ACCESS_DELETE_ON_CLOSE flag set, and that no other handle
will be opened with ACE4_DELETE access or with the
SSH_FXF_ACCESS_DELETE_ON_CLOSE flag set, and that the file itself
is not deleted in any other way until the client closes the handle.
<p>
If there is a conflicting lock the server MUST return
SSH_FX_LOCK_CONFLICT. If the server cannot make the locking
guarantee, it MUST return SSH_FX_OP_UNSUPPORTED.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_BLOCK_DELETE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_BLOCK_ADVISORY"><!-- --></A><H3>
SSH_FXF_ACCESS_BLOCK_ADVISORY</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_BLOCK_ADVISORY</B></PRE>
<DL>
<DD>If this bit is set, the above BLOCK modes are advisory. In advisory
mode, only other accesses that specify a BLOCK mode need be
considered when determining whether the BLOCK can be granted,
and the server need not prevent I/O operations that violate the
block mode.
<p>
The server MAY perform mandatory locking even if the BLOCK_ADVISORY
bit is set.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_BLOCK_ADVISORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_NOFOLLOW"><!-- --></A><H3>
SSH_FXF_ACCESS_NOFOLLOW</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_NOFOLLOW</B></PRE>
<DL>
<DD>If the final component of the path is a symlink, then the open
MUST fail, and the error SSH_FX_LINK_LOOP MUST be returned.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_NOFOLLOW">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SSH_FXF_ACCESS_DELETE_ON_CLOSE"><!-- --></A><H3>
SSH_FXF_ACCESS_DELETE_ON_CLOSE</H3>
<PRE>
public static final int <B>SSH_FXF_ACCESS_DELETE_ON_CLOSE</B></PRE>
<DL>
<DD>The file should be deleted when the last handle to it is closed.
(The last handle may not be an sftp-handle.) This MAY be emulated
by a server if the OS doesn't support it by deleting the file when
this handle is closed.
<p>
It is implementation specific whether the directory entry is
removed immediately or when the handle is closed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#ch.ethz.ssh2.sftp.OpenFlags.SSH_FXF_ACCESS_DELETE_ON_CLOSE">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="OpenFlags()"><!-- --></A><H3>
OpenFlags</H3>
<PRE>
public <B>OpenFlags</B>()</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../ch/ethz/ssh2/sftp/ErrorCodes.html" title="class in ch.ethz.ssh2.sftp"><B>PREV CLASS</B></A>
<A HREF="../../../../ch/ethz/ssh2/sftp/Packet.html" title="class in ch.ethz.ssh2.sftp"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?ch/ethz/ssh2/sftp/OpenFlags.html" target="_top"><B>FRAMES</B></A>
<A HREF="OpenFlags.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|