public class AttribBits extends Object
Yes, these are the "attrib-bits", even though they have "_FLAGS_" in their name. Don't ask - I did not invent it.
"These fields, taken together, reflect various attributes of the file or directory, on the server. Bits not set in 'attrib-bits-valid' MUST be ignored in the 'attrib-bits' field. This allows both the server and the client to communicate only the bits it knows about without inadvertently twiddling bits they don't understand."
Modifier and Type | Field and Description |
---|---|
static int |
SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY
Opening the file without either the SSH_FXF_ACCESS_APPEND_DATA or
the SSH_FXF_ACCESS_APPEND_DATA_ATOMIC flag (see section 8.1.1.3
of the SFTP standard draft) MUST result in an
SSH_FX_INVALID_PARAMETER error.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_ARCHIVE
The file should be included in backup / archive operations.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE
This attribute applies only to directories.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_COMPRESSED
The file is stored on disk using file-system level transparent
compression.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED
The file is stored on disk using file-system level transparent
encryption.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_HIDDEN
File SHOULD NOT be shown to user unless specifically requested.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE
The file cannot be deleted or renamed, no hard link can be created
to this file, and no data can be written to the file.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_READONLY
Advisory, read-only bit.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_SPARSE
The file is a sparse file; this means that file blocks that have
not been explicitly written are not stored on disk.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_SYNC
When the file is modified, the changes are written synchronously
to the disk.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_SYSTEM
The file is part of the operating system.
|
static int |
SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR
The server MAY include this bit in a directory listing or realpath
response.
|
Constructor and Description |
---|
AttribBits() |
public static final int SSH_FILEXFER_ATTR_FLAGS_READONLY
public static final int SSH_FILEXFER_ATTR_FLAGS_SYSTEM
public static final int SSH_FILEXFER_ATTR_FLAGS_HIDDEN
public static final int SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE
It is recommended that where possible, the server's filesystem be allowed to do comparisons. For example, if a client wished to prompt a user before overwriting a file, it should not compare the new name with the previously retrieved list of names in the directory. Rather, it should first try to create the new file by specifying SSH_FXF_CREATE_NEW flag. Then, if this fails and returns SSH_FX_FILE_ALREADY_EXISTS, it should prompt the user and then retry the create specifying SSH_FXF_CREATE_TRUNCATE.
Unless otherwise specified, filenames are assumed to be case sensitive.
public static final int SSH_FILEXFER_ATTR_FLAGS_ARCHIVE
public static final int SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED
public static final int SSH_FILEXFER_ATTR_FLAGS_COMPRESSED
public static final int SSH_FILEXFER_ATTR_FLAGS_SPARSE
Some servers may store all files as sparse files, in which case this bit will be unconditionally set. Other servers may not have a mechanism for determining if the file is sparse, and so the file MAY be stored sparse even if this flag is not set.
public static final int SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY
public static final int SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE
This bit implies a stronger level of protection than SSH_FILEXFER_ATTR_FLAGS_READONLY, the file permission mask or ACLs. Typically even the superuser cannot write to immutable files, and only the superuser can set or remove the bit.
public static final int SSH_FILEXFER_ATTR_FLAGS_SYNC
public static final int SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR
Copyright © 2023. All rights reserved.