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