|
0
|
1
|
|
|
2 package com.trilead.ssh2.sftp;
|
|
|
3
|
|
|
4 /**
|
|
|
5 *
|
|
|
6 * SFTP Attribute Bits for the "attrib-bits" and "attrib-bits-valid" fields
|
|
|
7 * of the SFTP ATTR data type.
|
|
|
8 * <p>
|
|
|
9 * Yes, these are the "attrib-bits", even though they have "_FLAGS_" in
|
|
|
10 * their name. Don't ask - I did not invent it.
|
|
|
11 * <p>
|
|
|
12 * "<i>These fields, taken together, reflect various attributes of the file
|
|
|
13 * or directory, on the server. Bits not set in 'attrib-bits-valid' MUST be
|
|
|
14 * ignored in the 'attrib-bits' field. This allows both the server and the
|
|
|
15 * client to communicate only the bits it knows about without inadvertently
|
|
|
16 * twiddling bits they don't understand.</i>"
|
|
|
17 *
|
|
|
18 * @author Christian Plattner, plattner@trilead.com
|
|
|
19 * @version $Id: AttribBits.java,v 1.1 2007/10/15 12:49:55 cplattne Exp $
|
|
|
20 *
|
|
|
21 */
|
|
|
22 public class AttribBits {
|
|
|
23 /**
|
|
|
24 * Advisory, read-only bit. This bit is not part of the access
|
|
|
25 * control information on the file, but is rather an advisory field
|
|
|
26 * indicating that the file should not be written.
|
|
|
27 */
|
|
|
28 public static final int SSH_FILEXFER_ATTR_FLAGS_READONLY = 0x00000001;
|
|
|
29
|
|
|
30 /**
|
|
|
31 * The file is part of the operating system.
|
|
|
32 */
|
|
|
33 public static final int SSH_FILEXFER_ATTR_FLAGS_SYSTEM = 0x00000002;
|
|
|
34
|
|
|
35 /**
|
|
|
36 * File SHOULD NOT be shown to user unless specifically requested.
|
|
|
37 * For example, most UNIX systems SHOULD set this bit if the filename
|
|
|
38 * begins with a 'period'. This bit may be read-only (see section 5.4 of
|
|
|
39 * the SFTP standard draft). Most UNIX systems will not allow this to be
|
|
|
40 * changed.
|
|
|
41 */
|
|
|
42 public static final int SSH_FILEXFER_ATTR_FLAGS_HIDDEN = 0x00000004;
|
|
|
43
|
|
|
44 /**
|
|
|
45 * This attribute applies only to directories. This attribute is
|
|
|
46 * always read-only, and cannot be modified. This attribute means
|
|
|
47 * that files and directory names in this directory should be compared
|
|
|
48 * without regard to case.
|
|
|
49 * <p>
|
|
|
50 * It is recommended that where possible, the server's filesystem be
|
|
|
51 * allowed to do comparisons. For example, if a client wished to prompt
|
|
|
52 * a user before overwriting a file, it should not compare the new name
|
|
|
53 * with the previously retrieved list of names in the directory. Rather,
|
|
|
54 * it should first try to create the new file by specifying
|
|
|
55 * SSH_FXF_CREATE_NEW flag. Then, if this fails and returns
|
|
|
56 * SSH_FX_FILE_ALREADY_EXISTS, it should prompt the user and then retry
|
|
|
57 * the create specifying SSH_FXF_CREATE_TRUNCATE.
|
|
|
58 * <p>
|
|
|
59 * Unless otherwise specified, filenames are assumed to be case sensitive.
|
|
|
60 */
|
|
|
61 public static final int SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE = 0x00000008;
|
|
|
62
|
|
|
63 /**
|
|
|
64 * The file should be included in backup / archive operations.
|
|
|
65 */
|
|
|
66 public static final int SSH_FILEXFER_ATTR_FLAGS_ARCHIVE = 0x00000010;
|
|
|
67
|
|
|
68 /**
|
|
|
69 * The file is stored on disk using file-system level transparent
|
|
|
70 * encryption. This flag does not affect the file data on the wire
|
|
|
71 * (for either READ or WRITE requests.)
|
|
|
72 */
|
|
|
73 public static final int SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED = 0x00000020;
|
|
|
74
|
|
|
75 /**
|
|
|
76 * The file is stored on disk using file-system level transparent
|
|
|
77 * compression. This flag does not affect the file data on the wire.
|
|
|
78 */
|
|
|
79 public static final int SSH_FILEXFER_ATTR_FLAGS_COMPRESSED = 0x00000040;
|
|
|
80
|
|
|
81 /**
|
|
|
82 * The file is a sparse file; this means that file blocks that have
|
|
|
83 * not been explicitly written are not stored on disk. For example, if
|
|
|
84 * a client writes a buffer at 10 M from the beginning of the file,
|
|
|
85 * the blocks between the previous EOF marker and the 10 M offset would
|
|
|
86 * not consume physical disk space.
|
|
|
87 * <p>
|
|
|
88 * Some servers may store all files as sparse files, in which case
|
|
|
89 * this bit will be unconditionally set. Other servers may not have
|
|
|
90 * a mechanism for determining if the file is sparse, and so the file
|
|
|
91 * MAY be stored sparse even if this flag is not set.
|
|
|
92 */
|
|
|
93 public static final int SSH_FILEXFER_ATTR_FLAGS_SPARSE = 0x00000080;
|
|
|
94
|
|
|
95 /**
|
|
|
96 * Opening the file without either the SSH_FXF_ACCESS_APPEND_DATA or
|
|
|
97 * the SSH_FXF_ACCESS_APPEND_DATA_ATOMIC flag (see section 8.1.1.3
|
|
|
98 * of the SFTP standard draft) MUST result in an
|
|
|
99 * SSH_FX_INVALID_PARAMETER error.
|
|
|
100 */
|
|
|
101 public static final int SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY = 0x00000100;
|
|
|
102
|
|
|
103 /**
|
|
|
104 * The file cannot be deleted or renamed, no hard link can be created
|
|
|
105 * to this file, and no data can be written to the file.
|
|
|
106 * <p>
|
|
|
107 * This bit implies a stronger level of protection than
|
|
|
108 * SSH_FILEXFER_ATTR_FLAGS_READONLY, the file permission mask or ACLs.
|
|
|
109 * Typically even the superuser cannot write to immutable files, and
|
|
|
110 * only the superuser can set or remove the bit.
|
|
|
111 */
|
|
|
112 public static final int SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE = 0x00000200;
|
|
|
113
|
|
|
114 /**
|
|
|
115 * When the file is modified, the changes are written synchronously
|
|
|
116 * to the disk.
|
|
|
117 */
|
|
|
118 public static final int SSH_FILEXFER_ATTR_FLAGS_SYNC = 0x00000400;
|
|
|
119
|
|
|
120 /**
|
|
|
121 * The server MAY include this bit in a directory listing or realpath
|
|
|
122 * response. It indicates there was a failure in the translation to UTF-8.
|
|
|
123 * If this flag is included, the server SHOULD also include the
|
|
|
124 * UNTRANSLATED_NAME attribute.
|
|
|
125 */
|
|
|
126 public static final int SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR = 0x00000800;
|
|
|
127
|
|
|
128 }
|
