com.github.ambry.rest

Class RestUtils.Headers

java.lang.Object

com.github.ambry.rest.RestUtils.Headers

Enclosing class:

RestUtils

public static final class RestUtils.Headers
extends java.lang.Object

Ambry specific HTTP headers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_RANGES "Accept-Ranges"
static java.lang.String	ACCESS_CONTROL_ALLOW_METHODS Header that is set in the response of OPTIONS request that specifies the allowed methods.
static java.lang.String	ACCESS_CONTROL_MAX_AGE Header that is set in the response of OPTIONS request that specifies the validity of the options returned.
static java.lang.String	ALLOW "allow"
static java.lang.String	AMBRY_CONTENT_TYPE mandatory in request; string; default unset; content type of blob
static java.lang.String	BLOB_ID The blob ID requested by the URL.
static java.lang.String	BLOB_SIZE mandatory in request; long; size of blob in bytes
static java.lang.String	CACHE_CONTROL "Cache-Control"
static java.lang.String	CHUNK_UPLOAD Boolean field set to "true" for getting chunk upload URLs with GET /signedUrl that will eventually be stitched together.
static java.lang.String	CONTENT_LENGTH "Content-Length"
static java.lang.String	CONTENT_RANGE "Content-Range"
static java.lang.String	CONTENT_TYPE "Content-Type"
static java.lang.String	COOKIE Header to contain the Cookies
static java.lang.String	CREATION_TIME not allowed in request.
static java.lang.String	DATE "Date"
static java.lang.String	ENCRYPTED_IN_STORAGE Header that is set in the response of GetBlobInfo.
static java.lang.String	EXPIRES "Expires"
static java.lang.String	EXTERNAL_ASSET_TAG An externalAssetTag for this blob.
static java.lang.String	GET_OPTION optional in request; defines an option while getting the blob and is optional support in a RestRequestService.
static java.lang.String	IF_MODIFIED_SINCE Header to be set by the clients during a Get blob call to denote, that blob should be served only if the blob has been modified after the value set for this header.
static java.lang.String	LAST_MODIFIED "Last-Modified"
static java.lang.String	LOCATION "Location"
static java.lang.String	MAX_UPLOAD_SIZE The maximum size of the blob that can be uploaded using the URL.
static java.lang.String	NON_COMPLIANCE_WARNING Response header indicating the reason a request is non compliant.
static java.lang.String	OWNER_ID optional in request; string; default unset; member id.
static java.lang.String	PRAGMA "Pragma"
static java.lang.String	PRIVATE optional in request; 'true' or 'false' case insensitive; default 'false'; indicates private content
static java.lang.String	RANGE "Range"
static java.lang.String	SERVICE_ID mandatory in request; string; name of service
static java.lang.String	SESSION This header will carry a UUID that represents a "session." For example, when performing a stitched upload, each chunk upload should be a part of the same session.
static java.lang.String	SIGNED_URL The signed URL header name in the response for signed url requests.
static java.lang.String	TARGET_ACCOUNT_ID for get account request; short; numerical ID of target account
static java.lang.String	TARGET_ACCOUNT_NAME for put or get account request; string; name of target account
static java.lang.String	TARGET_CONTAINER_NAME for put request; string; name of the target container
static java.lang.String	TTL optional in request; date string; default unset ("infinite ttl")
static java.lang.String	URL_TTL The TTL (in secs) of the signed URL.
static java.lang.String	URL_TYPE The type of signed URL requested (for e.g, POST or GET).
static java.lang.String	USER_META_DATA_HEADER_PREFIX prefix for any header to be set as user metadata for the given blob

Constructor Summary

Constructors

Constructor and Description
Headers()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CACHE_CONTROL

public static final java.lang.String CACHE_CONTROL

"Cache-Control"

See Also:

Constant Field Values

CONTENT_LENGTH

public static final java.lang.String CONTENT_LENGTH

"Content-Length"

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

"Content-Type"

See Also:

Constant Field Values

DATE

public static final java.lang.String DATE

"Date"

See Also:

Constant Field Values

EXPIRES

public static final java.lang.String EXPIRES

"Expires"

See Also:

Constant Field Values

LAST_MODIFIED

public static final java.lang.String LAST_MODIFIED

"Last-Modified"

See Also:

Constant Field Values

LOCATION

public static final java.lang.String LOCATION

"Location"

See Also:

Constant Field Values

PRAGMA

public static final java.lang.String PRAGMA

"Pragma"

See Also:

Constant Field Values

ACCEPT_RANGES

public static final java.lang.String ACCEPT_RANGES

"Accept-Ranges"

See Also:

Constant Field Values

CONTENT_RANGE

public static final java.lang.String CONTENT_RANGE

"Content-Range"

See Also:

Constant Field Values

RANGE

public static final java.lang.String RANGE

"Range"

See Also:

Constant Field Values

COOKIE

public static final java.lang.String COOKIE

Header to contain the Cookies

See Also:

Constant Field Values

IF_MODIFIED_SINCE

public static final java.lang.String IF_MODIFIED_SINCE

Header to be set by the clients during a Get blob call to denote, that blob should be served only if the blob has been modified after the value set for this header.

See Also:

Constant Field Values

ACCESS_CONTROL_ALLOW_METHODS

public static final java.lang.String ACCESS_CONTROL_ALLOW_METHODS

Header that is set in the response of OPTIONS request that specifies the allowed methods.

See Also:

Constant Field Values

ACCESS_CONTROL_MAX_AGE

public static final java.lang.String ACCESS_CONTROL_MAX_AGE

Header that is set in the response of OPTIONS request that specifies the validity of the options returned.

See Also:

Constant Field Values

ALLOW

public static final java.lang.String ALLOW

"allow"

See Also:

Constant Field Values

BLOB_SIZE

public static final java.lang.String BLOB_SIZE

mandatory in request; long; size of blob in bytes

See Also:

Constant Field Values

SERVICE_ID

public static final java.lang.String SERVICE_ID

mandatory in request; string; name of service

See Also:

Constant Field Values

TARGET_ACCOUNT_NAME

public static final java.lang.String TARGET_ACCOUNT_NAME

for put or get account request; string; name of target account

See Also:

Constant Field Values

TARGET_ACCOUNT_ID

public static final java.lang.String TARGET_ACCOUNT_ID

for get account request; short; numerical ID of target account

See Also:

Constant Field Values

TARGET_CONTAINER_NAME

public static final java.lang.String TARGET_CONTAINER_NAME

for put request; string; name of the target container

See Also:

Constant Field Values

TTL

public static final java.lang.String TTL

optional in request; date string; default unset ("infinite ttl")

See Also:

Constant Field Values

PRIVATE

public static final java.lang.String PRIVATE

optional in request; 'true' or 'false' case insensitive; default 'false'; indicates private content

See Also:

Constant Field Values

AMBRY_CONTENT_TYPE

public static final java.lang.String AMBRY_CONTENT_TYPE

mandatory in request; string; default unset; content type of blob

See Also:

Constant Field Values

OWNER_ID

public static final java.lang.String OWNER_ID

optional in request; string; default unset; member id.

Expected usage is to set to member id of content owner.

See Also:

Constant Field Values

ENCRYPTED_IN_STORAGE

public static final java.lang.String ENCRYPTED_IN_STORAGE

Header that is set in the response of GetBlobInfo. 'true' or 'false'; case insensitive; true indicates content is encrypted at the storage layer. false otherwise

See Also:

Constant Field Values

GET_OPTION

public static final java.lang.String GET_OPTION

optional in request; defines an option while getting the blob and is optional support in a RestRequestService. Valid values are available in GetOption. Defaults to GetOption.None

See Also:

Constant Field Values

CREATION_TIME

public static final java.lang.String CREATION_TIME

not allowed in request. Allowed in response only; string; time at which blob was created.

See Also:

Constant Field Values

URL_TYPE

public static final java.lang.String URL_TYPE

The type of signed URL requested (for e.g, POST or GET).

See Also:

Constant Field Values

URL_TTL

public static final java.lang.String URL_TTL

The TTL (in secs) of the signed URL.

See Also:

Constant Field Values

MAX_UPLOAD_SIZE

public static final java.lang.String MAX_UPLOAD_SIZE

The maximum size of the blob that can be uploaded using the URL.

See Also:

Constant Field Values

EXTERNAL_ASSET_TAG

public static final java.lang.String EXTERNAL_ASSET_TAG

An externalAssetTag for this blob.

See Also:

Constant Field Values

BLOB_ID

public static final java.lang.String BLOB_ID

The blob ID requested by the URL.

See Also:

Constant Field Values

SIGNED_URL

public static final java.lang.String SIGNED_URL

The signed URL header name in the response for signed url requests.

See Also:

Constant Field Values

CHUNK_UPLOAD

public static final java.lang.String CHUNK_UPLOAD

Boolean field set to "true" for getting chunk upload URLs with GET /signedUrl that will eventually be stitched together.

See Also:

Constant Field Values

SESSION

public static final java.lang.String SESSION

This header will carry a UUID that represents a "session." For example, when performing a stitched upload, each chunk upload should be a part of the same session.

See Also:

Constant Field Values

USER_META_DATA_HEADER_PREFIX

public static final java.lang.String USER_META_DATA_HEADER_PREFIX

prefix for any header to be set as user metadata for the given blob

See Also:

Constant Field Values

NON_COMPLIANCE_WARNING

public static final java.lang.String NON_COMPLIANCE_WARNING

Response header indicating the reason a request is non compliant.

See Also:

Constant Field Values

Constructor Detail

Headers

public Headers()