Constants.HeaderConstants Class

  • java.lang.Object
    • com.microsoft.azure.storage.Constants.HeaderConstants

public class HeaderConstants

Defines constants for use with HTTP headers.

Field Summary

Modifier and Type Field and Description
final String ACCEPT

The Accept header.

final String ACCEPT_CHARSET

The Accept header.

final String ACCOUNT_KIND

The header that represents the kind of storage account.

final String AUTHORIZATION

The Authorization header.

final String BEARER

The keyword used for bearer token authorization.

final String BEGIN_RANGE_HEADER_FORMAT

The format string for specifying ranges with only begin offset.

final String BLOB_APPEND_OFFSET

The format string for specifying the blob append offset.

final String BLOB_COMMITTED_BLOCK_COUNT

The header that specifies committed block count.

final String BLOB_SEQUENCE_NUMBER

The header that specifies blob sequence number.

final String CACHE_CONTROL

The CacheControl header.

final String CACHE_CONTROL_HEADER

The header that specifies blob caching control.

final String CLIENT_PROVIDED_ENCRYPTION_ALGORITHM

The encryption algorithm header for client-provided key encryption.

final String CLIENT_PROVIDED_ENCRYPTION_ALGORITHM_SOURCE

The encryption algorithm header for client-provided key encryption.

final String CLIENT_PROVIDED_ENCRYPTION_KEY

The key header for client-provided key encryption.

final String CLIENT_PROVIDED_ENCRYPTION_KEY_HASH

The key hash header for client-provided key encryption

final String CLIENT_PROVIDED_ENCRYPTION_KEY_HASH_SOURCE

The key hash header for client-provided key encryption

final String CLIENT_PROVIDED_ENCRYPTION_KEY_SOURCE

The key header for client-provided key encryption.

final String CLIENT_PROVIDED_ENCRYPTION_SUCCESS

The key header for client-provided key encryption.

final String CLIENT_REQUEST_ID_HEADER

The header that indicates the client request ID.

final String CONTENT_DISPOSITION

The ContentDisposition header.

final String CONTENT_ENCODING

The ContentEncoding header.

final String CONTENT_ID

The ContentID header.

final String CONTENT_LANGUAGE

The ContentLangauge header.

final String CONTENT_LENGTH

The ContentLength header.

final String CONTENT_MD5

The ContentMD5 header.

final String CONTENT_RANGE

The ContentRange header.

final String CONTENT_TRANSFER_ENCODING

The ContentTransferEncoding header.

final String CONTENT_TYPE

The ContentType header.

final String COPY_ACTION_ABORT

The value of the copy action header that signifies an abort operation.

final String COPY_ACTION_HEADER

Header that specifies the copy action.

final String COPY_COMPLETION_TIME

The header that specifies copy completion time.

final String COPY_DESTINATION_SNAPSHOT_ID

The header that specifies the snapshot ID of the last successful incremental snapshot.

final String COPY_ID

The header that specifies copy id.

final String COPY_PROGRESS

The header that specifies copy progress.

final String COPY_SOURCE

The header that specifies copy source.

final String COPY_SOURCE_HEADER

The header for copy source.

final String COPY_STATUS

The header that specifies copy status.

final String COPY_STATUS_DESCRIPTION

The header that specifies copy status description.

final String DATE

The header that specifies the date.

final String DELETE_SNAPSHOT_HEADER

The header to delete snapshots.

final String ERROR_CODE

The ErrorCode header.

final String ETAG

The ETag header.

final int HTTP_UNUSED_306

An unused HTTP code used internally to indicate a non-http related failure when constructing StorageException objects

final String IF_APPEND_POSITION_EQUAL_HEADER

The blob append position equal header.

final String IF_MATCH

The IfMatch header.

final String IF_MAX_SIZE_LESS_THAN_OR_EQUAL

The blob maxsize condition header.

final String IF_MODIFIED_SINCE

The IfModifiedSince header.

final String IF_NONE_MATCH

The IfNoneMatch header.

final String IF_SEQUENCE_NUMBER_EQUAL

The blob sequence number equal condition header.

final String IF_SEQUENCE_NUMBER_LESS_THAN

The blob sequence number less than condition header.

final String IF_SEQUENCE_NUMBER_LESS_THAN_OR_EQUAL

The blob sequence number less than or equal condition header.

final String IF_UNMODIFIED_SINCE

The IfUnmodifiedSince header.

final String INCLUDE_SNAPSHOTS_VALUE

Specifies snapshots are to be included.

final String INCREMENTAL_COPY

The header that specifies copy type.

final String JSON_TYPE

Specifies the JSON content type

final String LEASE_ACTION_HEADER

The header that specifies the lease action to perform

final String LEASE_BREAK_PERIOD_HEADER

The header that specifies the break period of a lease

final String LEASE_DURATION

The header that specifies lease duration.

final String LEASE_ID_HEADER

The header that specifies lease ID.

final String LEASE_STATE

The header that specifies lease state.

final String LEASE_STATUS

The header that specifies lease status.

final String LEASE_TIME_HEADER

The header that specifies the remaining lease time

final String POP_RECEIPT_HEADER

The header that specifies the pop receipt.

final String PREFIX_FOR_STORAGE_METADATA

The header prefix for metadata.

final String PREFIX_FOR_STORAGE_PROPERTIES

The header prefix for properties.

final String PROPOSED_LEASE_ID_HEADER

The header that specifies the proposed lease ID for a leasing operation

final String RANGE

The Range header.

final String RANGE_GET_CONTENT_MD5

The header that specifies if the request will populate the ContentMD5 header for range gets.

final String RANGE_HEADER_FORMAT

The format string for specifying ranges.

final String RECURSIVE

The header that specifies recursive listing.

final String REQUEST_ID_HEADER

The header that indicates the request ID.

final String REQUIRES_SYNC_HEADER

The header for copy sync.

final String SERVER

The header field value received that indicates which server was accessed

final String SERVER_ENCRYPTED

The header that specifies whether a resource is fully encrypted server-side

final String SERVER_REQUEST_ENCRYPTED

The header that acknowledges data used for a write operation is encrypted server-side

final String SKU_NAME

The header that specifies the sku name for an account.

final String SNAPSHOT_ID_HEADER

The header that specifies the snapshot ID.

final String SOURCE_CONTENT_MD5_HEADER

The header that specifies source content MD5.

final String SOURCE_IF_MATCH_HEADER

The header for the If-Match condition.

final String SOURCE_IF_MODIFIED_SINCE_HEADER

The header for the If-Modified-Since condition.

final String SOURCE_IF_NONE_MATCH_HEADER

The header for the If-None-Match condition.

final String SOURCE_IF_UNMODIFIED_SINCE_HEADER

The header for the If-Unmodified-Since condition.

final String SOURCE_LEASE_ID_HEADER

The header for the source lease id.

final String STORAGE_RANGE_HEADER

The header for data ranges.

final String STORAGE_SOURCE_RANGE_HEADER

The header for data ranges.

final String STORAGE_VERSION_HEADER

The header for storage version.

final String TARGET_STORAGE_VERSION

The current storage version header value.

final String TIME_NEXT_VISIBLE_HEADER

The header that specifies the next visible time for a queue message.

final String USER_AGENT

The UserAgent header.

final String USER_AGENT_PREFIX

Specifies the value to use for UserAgent header.

final String USER_AGENT_VERSION

Specifies the value to use for UserAgent header.

final String XML_TYPE

The default type for content-type and accept

Field Details

ACCEPT

public static final String ACCEPT= "Accept"

The Accept header.

ACCEPT_CHARSET

public static final String ACCEPT_CHARSET= "Accept-Charset"

The Accept header.

ACCOUNT_KIND

public static final String ACCOUNT_KIND= PREFIX_FOR_STORAGE_HEADER + "account-kind"

The header that represents the kind of storage account.

AUTHORIZATION

public static final String AUTHORIZATION= "Authorization"

The Authorization header.

BEARER

public static final String BEARER= "Bearer"

The keyword used for bearer token authorization.

BEGIN_RANGE_HEADER_FORMAT

public static final String BEGIN_RANGE_HEADER_FORMAT= "bytes=%d-"

The format string for specifying ranges with only begin offset.

BLOB_APPEND_OFFSET

public static final String BLOB_APPEND_OFFSET= PREFIX_FOR_STORAGE_HEADER + "blob-append-offset"

The format string for specifying the blob append offset.

BLOB_COMMITTED_BLOCK_COUNT

public static final String BLOB_COMMITTED_BLOCK_COUNT= PREFIX_FOR_STORAGE_HEADER + "blob-committed-block-count"

The header that specifies committed block count.

BLOB_SEQUENCE_NUMBER

public static final String BLOB_SEQUENCE_NUMBER= PREFIX_FOR_STORAGE_HEADER + "blob-sequence-number"

The header that specifies blob sequence number.

CACHE_CONTROL

public static final String CACHE_CONTROL= "Cache-Control"

The CacheControl header.

CACHE_CONTROL_HEADER

public static final String CACHE_CONTROL_HEADER= PREFIX_FOR_STORAGE_HEADER + "blob-cache-control"

The header that specifies blob caching control.

CLIENT_PROVIDED_ENCRYPTION_ALGORITHM

public static final String CLIENT_PROVIDED_ENCRYPTION_ALGORITHM= PREFIX_FOR_STORAGE_HEADER + "encryption-algorithm"

The encryption algorithm header for client-provided key encryption.

CLIENT_PROVIDED_ENCRYPTION_ALGORITHM_SOURCE

public static final String CLIENT_PROVIDED_ENCRYPTION_ALGORITHM_SOURCE= PREFIX_FOR_STORAGE_HEADER + "source-encryption-algorithm"

The encryption algorithm header for client-provided key encryption.

CLIENT_PROVIDED_ENCRYPTION_KEY

public static final String CLIENT_PROVIDED_ENCRYPTION_KEY= PREFIX_FOR_STORAGE_HEADER + "encryption-key"

The key header for client-provided key encryption.

CLIENT_PROVIDED_ENCRYPTION_KEY_HASH

public static final String CLIENT_PROVIDED_ENCRYPTION_KEY_HASH= PREFIX_FOR_STORAGE_HEADER + "encryption-key-sha256"

The key hash header for client-provided key encryption

CLIENT_PROVIDED_ENCRYPTION_KEY_HASH_SOURCE

public static final String CLIENT_PROVIDED_ENCRYPTION_KEY_HASH_SOURCE= PREFIX_FOR_STORAGE_HEADER + "source-encryption-key-sha256"

The key hash header for client-provided key encryption

CLIENT_PROVIDED_ENCRYPTION_KEY_SOURCE

public static final String CLIENT_PROVIDED_ENCRYPTION_KEY_SOURCE= PREFIX_FOR_STORAGE_HEADER + "source-encryption-key"

The key header for client-provided key encryption.

CLIENT_PROVIDED_ENCRYPTION_SUCCESS

public static final String CLIENT_PROVIDED_ENCRYPTION_SUCCESS= PREFIX_FOR_STORAGE_HEADER + "request-server-encrypted"

The key header for client-provided key encryption.

CLIENT_REQUEST_ID_HEADER

public static final String CLIENT_REQUEST_ID_HEADER= PREFIX_FOR_STORAGE_HEADER + "client-request-id"

The header that indicates the client request ID.

CONTENT_DISPOSITION

public static final String CONTENT_DISPOSITION= "Content-Disposition"

The ContentDisposition header.

CONTENT_ENCODING

public static final String CONTENT_ENCODING= "Content-Encoding"

The ContentEncoding header.

CONTENT_ID

public static final String CONTENT_ID= "Content-ID"

The ContentID header.

CONTENT_LANGUAGE

public static final String CONTENT_LANGUAGE= "Content-Language"

The ContentLangauge header.

CONTENT_LENGTH

public static final String CONTENT_LENGTH= "Content-Length"

The ContentLength header.

CONTENT_MD5

public static final String CONTENT_MD5= "Content-MD5"

The ContentMD5 header.

CONTENT_RANGE

public static final String CONTENT_RANGE= "Content-Range"

The ContentRange header.

CONTENT_TRANSFER_ENCODING

public static final String CONTENT_TRANSFER_ENCODING= "Content-Transfer-Encoding"

The ContentTransferEncoding header.

CONTENT_TYPE

public static final String CONTENT_TYPE= "Content-Type"

The ContentType header.

COPY_ACTION_ABORT

public static final String COPY_ACTION_ABORT= "abort"

The value of the copy action header that signifies an abort operation.

COPY_ACTION_HEADER

public static final String COPY_ACTION_HEADER= PREFIX_FOR_STORAGE_HEADER + "copy-action"

Header that specifies the copy action.

COPY_COMPLETION_TIME

public static final String COPY_COMPLETION_TIME= PREFIX_FOR_STORAGE_HEADER + "copy-completion-time"

The header that specifies copy completion time.

COPY_DESTINATION_SNAPSHOT_ID

public static final String COPY_DESTINATION_SNAPSHOT_ID= PREFIX_FOR_STORAGE_HEADER + "copy-destination-snapshot"

The header that specifies the snapshot ID of the last successful incremental snapshot.

COPY_ID

public static final String COPY_ID= PREFIX_FOR_STORAGE_HEADER + "copy-id"

The header that specifies copy id.

COPY_PROGRESS

public static final String COPY_PROGRESS= PREFIX_FOR_STORAGE_HEADER + "copy-progress"

The header that specifies copy progress.

COPY_SOURCE

public static final String COPY_SOURCE= PREFIX_FOR_STORAGE_HEADER + "copy-source"

The header that specifies copy source.

COPY_SOURCE_HEADER

public static final String COPY_SOURCE_HEADER= PREFIX_FOR_STORAGE_HEADER + "copy-source"

The header for copy source.

COPY_STATUS

public static final String COPY_STATUS= PREFIX_FOR_STORAGE_HEADER + "copy-status"

The header that specifies copy status.

COPY_STATUS_DESCRIPTION

public static final String COPY_STATUS_DESCRIPTION= PREFIX_FOR_STORAGE_HEADER + "copy-status-description"

The header that specifies copy status description.

DATE

public static final String DATE= PREFIX_FOR_STORAGE_HEADER + "date"

The header that specifies the date.

DELETE_SNAPSHOT_HEADER

public static final String DELETE_SNAPSHOT_HEADER= PREFIX_FOR_STORAGE_HEADER + "delete-snapshots"

The header to delete snapshots.

ERROR_CODE

public static final String ERROR_CODE= "x-ms-error-code"

The ErrorCode header.

ETAG

public static final String ETAG= "ETag"

The ETag header.

HTTP_UNUSED_306

public static final int HTTP_UNUSED_306= 306

An unused HTTP code used internally to indicate a non-http related failure when constructing StorageException objects

IF_APPEND_POSITION_EQUAL_HEADER

public static final String IF_APPEND_POSITION_EQUAL_HEADER= PREFIX_FOR_STORAGE_HEADER + "blob-condition-appendpos"

The blob append position equal header.

IF_MATCH

public static final String IF_MATCH= "If-Match"

The IfMatch header.

IF_MAX_SIZE_LESS_THAN_OR_EQUAL

public static final String IF_MAX_SIZE_LESS_THAN_OR_EQUAL= PREFIX_FOR_STORAGE_HEADER + "blob-condition-maxsize"

The blob maxsize condition header.

IF_MODIFIED_SINCE

public static final String IF_MODIFIED_SINCE= "If-Modified-Since"

The IfModifiedSince header.

IF_NONE_MATCH

public static final String IF_NONE_MATCH= "If-None-Match"

The IfNoneMatch header.

IF_SEQUENCE_NUMBER_EQUAL

public static final String IF_SEQUENCE_NUMBER_EQUAL= PREFIX_FOR_STORAGE_HEADER + "if-sequence-number-eq"

The blob sequence number equal condition header.

IF_SEQUENCE_NUMBER_LESS_THAN

public static final String IF_SEQUENCE_NUMBER_LESS_THAN= PREFIX_FOR_STORAGE_HEADER + "if-sequence-number-lt"

The blob sequence number less than condition header.

IF_SEQUENCE_NUMBER_LESS_THAN_OR_EQUAL

public static final String IF_SEQUENCE_NUMBER_LESS_THAN_OR_EQUAL= PREFIX_FOR_STORAGE_HEADER + "if-sequence-number-le"

The blob sequence number less than or equal condition header.

IF_UNMODIFIED_SINCE

public static final String IF_UNMODIFIED_SINCE= "If-Unmodified-Since"

The IfUnmodifiedSince header.

INCLUDE_SNAPSHOTS_VALUE

public static final String INCLUDE_SNAPSHOTS_VALUE= "include"

Specifies snapshots are to be included.

INCREMENTAL_COPY

public static final String INCREMENTAL_COPY= PREFIX_FOR_STORAGE_HEADER + "incremental-copy"

The header that specifies copy type.

JSON_TYPE

public static final String JSON_TYPE= "application/json"

Specifies the JSON content type

LEASE_ACTION_HEADER

public static final String LEASE_ACTION_HEADER= PREFIX_FOR_STORAGE_HEADER + "lease-action"

The header that specifies the lease action to perform

LEASE_BREAK_PERIOD_HEADER

public static final String LEASE_BREAK_PERIOD_HEADER= PREFIX_FOR_STORAGE_HEADER + "lease-break-period"

The header that specifies the break period of a lease

LEASE_DURATION

public static final String LEASE_DURATION= PREFIX_FOR_STORAGE_HEADER + "lease-duration"

The header that specifies lease duration.

LEASE_ID_HEADER

public static final String LEASE_ID_HEADER= PREFIX_FOR_STORAGE_HEADER + "lease-id"

The header that specifies lease ID.

LEASE_STATE

public static final String LEASE_STATE= PREFIX_FOR_STORAGE_HEADER + "lease-state"

The header that specifies lease state.

LEASE_STATUS

public static final String LEASE_STATUS= PREFIX_FOR_STORAGE_HEADER + "lease-status"

The header that specifies lease status.

LEASE_TIME_HEADER

public static final String LEASE_TIME_HEADER= PREFIX_FOR_STORAGE_HEADER + "lease-time"

The header that specifies the remaining lease time

POP_RECEIPT_HEADER

public static final String POP_RECEIPT_HEADER= PREFIX_FOR_STORAGE_HEADER + "popreceipt"

The header that specifies the pop receipt.

PREFIX_FOR_STORAGE_METADATA

public static final String PREFIX_FOR_STORAGE_METADATA= "x-ms-meta-"

The header prefix for metadata.

PREFIX_FOR_STORAGE_PROPERTIES

public static final String PREFIX_FOR_STORAGE_PROPERTIES= "x-ms-prop-"

The header prefix for properties.

PROPOSED_LEASE_ID_HEADER

public static final String PROPOSED_LEASE_ID_HEADER= PREFIX_FOR_STORAGE_HEADER + "proposed-lease-id"

The header that specifies the proposed lease ID for a leasing operation

RANGE

public static final String RANGE= "Range"

The Range header.

RANGE_GET_CONTENT_MD5

public static final String RANGE_GET_CONTENT_MD5= PREFIX_FOR_STORAGE_HEADER + "range-get-content-md5"

The header that specifies if the request will populate the ContentMD5 header for range gets.

RANGE_HEADER_FORMAT

public static final String RANGE_HEADER_FORMAT= "bytes=%d-%d"

The format string for specifying ranges.

RECURSIVE

public static final String RECURSIVE= PREFIX_FOR_STORAGE_HEADER + "recursive"

The header that specifies recursive listing.

REQUEST_ID_HEADER

public static final String REQUEST_ID_HEADER= PREFIX_FOR_STORAGE_HEADER + "request-id"

The header that indicates the request ID.

REQUIRES_SYNC_HEADER

public static final String REQUIRES_SYNC_HEADER= PREFIX_FOR_STORAGE_HEADER + "requires-sync"

The header for copy sync.

SERVER

public static final String SERVER= "Server"

The header field value received that indicates which server was accessed

SERVER_ENCRYPTED

public static final String SERVER_ENCRYPTED= PREFIX_FOR_STORAGE_HEADER + "server-encrypted"

The header that specifies whether a resource is fully encrypted server-side

SERVER_REQUEST_ENCRYPTED

public static final String SERVER_REQUEST_ENCRYPTED= PREFIX_FOR_STORAGE_HEADER + "request-server-encrypted"

The header that acknowledges data used for a write operation is encrypted server-side

SKU_NAME

public static final String SKU_NAME= PREFIX_FOR_STORAGE_HEADER + "sku-name"

The header that specifies the sku name for an account.

SNAPSHOT_ID_HEADER

public static final String SNAPSHOT_ID_HEADER= PREFIX_FOR_STORAGE_HEADER + "snapshot"

The header that specifies the snapshot ID.

SOURCE_CONTENT_MD5_HEADER

public static final String SOURCE_CONTENT_MD5_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-content-md5"

The header that specifies source content MD5.

SOURCE_IF_MATCH_HEADER

public static final String SOURCE_IF_MATCH_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-if-match"

The header for the If-Match condition.

SOURCE_IF_MODIFIED_SINCE_HEADER

public static final String SOURCE_IF_MODIFIED_SINCE_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-if-modified-since"

The header for the If-Modified-Since condition.

SOURCE_IF_NONE_MATCH_HEADER

public static final String SOURCE_IF_NONE_MATCH_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-if-none-match"

The header for the If-None-Match condition.

SOURCE_IF_UNMODIFIED_SINCE_HEADER

public static final String SOURCE_IF_UNMODIFIED_SINCE_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-if-unmodified-since"

The header for the If-Unmodified-Since condition.

SOURCE_LEASE_ID_HEADER

public static final String SOURCE_LEASE_ID_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-lease-id"

The header for the source lease id.

STORAGE_RANGE_HEADER

public static final String STORAGE_RANGE_HEADER= PREFIX_FOR_STORAGE_HEADER + "range"

The header for data ranges.

STORAGE_SOURCE_RANGE_HEADER

public static final String STORAGE_SOURCE_RANGE_HEADER= PREFIX_FOR_STORAGE_HEADER + "source-range"

The header for data ranges.

STORAGE_VERSION_HEADER

public static final String STORAGE_VERSION_HEADER= PREFIX_FOR_STORAGE_HEADER + "version"

The header for storage version.

TARGET_STORAGE_VERSION

public static final String TARGET_STORAGE_VERSION= "2019-02-02"

The current storage version header value.

TIME_NEXT_VISIBLE_HEADER

public static final String TIME_NEXT_VISIBLE_HEADER= PREFIX_FOR_STORAGE_HEADER + "time-next-visible"

The header that specifies the next visible time for a queue message.

USER_AGENT

public static final String USER_AGENT= "User-Agent"

The UserAgent header.

USER_AGENT_PREFIX

public static final String USER_AGENT_PREFIX= "Azure-Storage"

Specifies the value to use for UserAgent header.

USER_AGENT_VERSION

public static final String USER_AGENT_VERSION= "8.6.6"

Specifies the value to use for UserAgent header.

XML_TYPE

public static final String XML_TYPE= "application/xml"

The default type for content-type and accept

Applies to