Package com.hierynomus.mssmb2
Enum Class SMB2CreateOptions
- All Implemented Interfaces:
EnumWithValue<SMB2CreateOptions>
,Serializable
,Comparable<SMB2CreateOptions>
,Constable
public enum SMB2CreateOptions
extends Enum<SMB2CreateOptions>
implements EnumWithValue<SMB2CreateOptions>
SMB2 Create 2.2.13 - CreateOptions
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface com.hierynomus.protocol.commons.EnumWithValue
EnumWithValue.EnumUtils
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDeprecated.The file MUST be automatically deleted when the last open request on this file is closed.The file being created or opened is a directory file.Deprecated.The file cannot be compressed.The caller does not understand how to handle extended attributes.The server or underlying object store SHOULD NOT cache data at intermediate layers and SHOULD allow it to flow through to persistent storage.If the name of the file being created or opened matches with an existing directory file, the server MUST fail the request with STATUS_FILE_IS_A_DIRECTORY.Deprecated.The file is being opened for backup intent.Deprecated.In an HSM (Hierarchical Storage Management) environment, this flag means the file SHOULD NOT be recalled from tertiary storage such as tape.Deprecated.If the file or directory being opened is a reparse point, open the reparse point itself rather than the target that the reparse point references.Deprecated.This indicates that the application intends to read or write at random offsets using this handle, so the server SHOULD optimize for random access.Deprecated.This indicates that the application intends to read or write at sequential offsets using this handle, so the server SHOULD optimize for sequential access.Deprecated.Deprecated.The server MUST propagate writes to this open to persistent storage before returning success to the client on write operations. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlong
getValue()
static SMB2CreateOptions
Returns the enum constant of this class with the specified name.static SMB2CreateOptions[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FILE_DIRECTORY_FILE
The file being created or opened is a directory file. With this flag, the CreateDisposition field MUST be set to FILE_CREATE, FILE_OPEN_IF, or FILE_OPEN. With this flag, only the following CreateOptions values are valid: FILE_WRITE_THROUGH, FILE_OPEN_FOR_BACKUP_INTENT, FILE_DELETE_ON_CLOSE, and FILE_OPEN_REPARSE_POINT. If the file being created or opened already exists and is not a directory file and FILE_CREATE is specified in the CreateDisposition field, then the server MUST fail the request with STATUS_OBJECT_NAME_COLLISION. If the file being created or opened already exists and is not a directory file and FILE_CREATE is not specified in the CreateDisposition field, then the server MUST fail the request with STATUS_NOT_A_DIRECTORY. The server MUST fail an invalid CreateDisposition field or an invalid combination of CreateOptions flags with STATUS_INVALID_PARAMETER. -
FILE_WRITE_THROUGH
The server MUST propagate writes to this open to persistent storage before returning success to the client on write operations. -
FILE_SEQUENTIAL_ONLY
This indicates that the application intends to read or write at sequential offsets using this handle, so the server SHOULD optimize for sequential access. However, the server MUST accept any access pattern. This flag value is incompatible with the FILE_RANDOM_ACCESS value. -
FILE_NO_INTERMEDIATE_BUFFERING
The server or underlying object store SHOULD NOT cache data at intermediate layers and SHOULD allow it to flow through to persistent storage. -
FILE_SYNCHRONOUS_IO_ALERT
Deprecated.This bit SHOULD be set to 0 and MUST be ignored by the server. -
FILE_SYNCHRONOUS_IO_NONALERT
Deprecated.This bit SHOULD be set to 0 and MUST be ignored by the server. -
FILE_NON_DIRECTORY_FILE
If the name of the file being created or opened matches with an existing directory file, the server MUST fail the request with STATUS_FILE_IS_A_DIRECTORY. This flag MUST NOT be used with FILE_DIRECTORY_FILE or the server MUST fail the request with STATUS_INVALID_PARAMETER. -
FILE_COMPLETE_IF_OPLOCKED
Deprecated.This bit SHOULD be set to 0 and MUST be ignored by the server. -
FILE_NO_EA_KNOWLEDGE
The caller does not understand how to handle extended attributes. If the request includes an SMB2_CREATE_EA_BUFFER create context, then the server MUST fail this request with STATUS_ACCESS_DENIED. If extended attributes with the FILE_NEED_EA flag (see [MS-FSCC] section 2.4.15) set are associated with the file being opened, then the server MUST fail this request with STATUS_ACCESS_DENIED. -
FILE_RANDOM_ACCESS
This indicates that the application intends to read or write at random offsets using this handle, so the server SHOULD optimize for random access. However, the server MUST accept any access pattern. This flag value is incompatible with the FILE_SEQUENTIAL_ONLY value. If both FILE_RANDOM_ACCESS and FILE_SEQUENTIAL_ONLY are set, then FILE_SEQUENTIAL_ONLY is ignored. -
FILE_DELETE_ON_CLOSE
The file MUST be automatically deleted when the last open request on this file is closed. When this option is set, the DesiredAccess field MUST include the DELETE flag. This option is often used for temporary files. -
FILE_OPEN_BY_FILE_ID
Deprecated.This bit SHOULD be set to 0 and the server MUST fail the request with a STATUS_NOT_SUPPORTED error if this bit is set. -
FILE_OPEN_FOR_BACKUP_INTENT
The file is being opened for backup intent. That is, it is being opened or created for the purposes of either a backup or a restore operation. The server can check to ensure that the caller is capable of overriding whatever security checks have been placed on the file to allow a backup or restore operation to occur. The server can check for access rights to the file before checking the DesiredAccess field. -
FILE_NO_COMPRESSION
The file cannot be compressed. This bit is ignored when FILE_DIRECTORY_FILE is set in CreateOptions. -
FILE_OPEN_REMOTE_INSTANCE
Deprecated.This bit SHOULD be set to 0 and MUST be ignored by the server. -
FILE_OPEN_REQUIRING_OPLOCK
Deprecated.This bit SHOULD be set to 0 and MUST be ignored by the server. -
FILE_DISALLOW_EXCLUSIVE
Deprecated.This bit SHOULD be set to 0 and MUST be ignored by the server. -
FILE_RESERVE_OPFILTER
Deprecated.This bit SHOULD be set to 0 and the server MUST fail the request with a STATUS_NOT_SUPPORTED error if this bit is set. -
FILE_OPEN_REPARSE_POINT
If the file or directory being opened is a reparse point, open the reparse point itself rather than the target that the reparse point references. -
FILE_OPEN_NO_RECALL
In an HSM (Hierarchical Storage Management) environment, this flag means the file SHOULD NOT be recalled from tertiary storage such as tape. The recall can take several minutes. The caller can specify this flag to avoid those delays. -
FILE_OPEN_FOR_FREE_SPACE_QUERY
Deprecated.Open file to query for free space. The client SHOULD set this to 0 and the server MUST ignore it.
-
-
Field Details
-
value
private long value
-
-
Constructor Details
-
SMB2CreateOptions
private SMB2CreateOptions(long value)
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getValue
public long getValue()- Specified by:
getValue
in interfaceEnumWithValue<SMB2CreateOptions>
-