me.desair.tus.server

Class HttpHeader

java.lang.Object

me.desair.tus.server.HttpHeader

public class HttpHeader
extends Object

Class that will hold constants for all HTTP headers relevant to the tus v1.0.0 protocol

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_CONTROL
static String	CONTENT_DISPOSITION
static String	CONTENT_LENGTH
static String	CONTENT_TYPE
static String	LOCATION
static String	METHOD_OVERRIDE The X-HTTP-Method-Override request header MUST be a string which MUST be interpreted as the request’s method by the Server, if the header is presented.
static String	TRANSFER_ENCODING The Transfer-Encoding header specifies the form of encoding used to safely transfer the entity to the user.
static String	TUS_CHECKSUM_ALGORITHM The Tus-Checksum-Algorithm response header MUST be a comma-separated list of the checksum algorithms supported by the server.
static String	TUS_EXTENSION The Tus-Extension response header MUST be a comma-separated list of the extensions supported by the Server.
static String	TUS_MAX_SIZE The Tus-Max-Size response header MUST be a non-negative integer indicating the maximum allowed size of an entire upload in bytes.
static String	TUS_RESUMABLE The Tus-Resumable header MUST be included in every request and response except for OPTIONS requests.
static String	TUS_VERSION The Tus-Version response header MUST be a comma-separated list of protocol versions supported by the Server.
static String	UPLOAD_CHECKSUM The Upload-Checksum request header contains information about the checksum of the current body payload.
static String	UPLOAD_CONCAT The Upload-Concat request and response header MUST be set in both partial and upload creation requests.
static String	UPLOAD_DEFER_LENGTH The Upload-Defer-Length request and response header indicates that the size of the upload is not known currently and will be transferred later.
static String	UPLOAD_EXPIRES The Upload-Expires response header indicates the time after which the unfinished upload expires.
static String	UPLOAD_LENGTH The Upload-Length request and response header indicates the size of the entire upload in bytes.
static String	UPLOAD_METADATA
static String	UPLOAD_OFFSET The Upload-Offset request and response header indicates a byte offset within a resource.
static String	X_FORWARDED_FOR The X-Forwarded-For (XFF) HTTP header field is a common method for identifying the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_OVERRIDE

public static final String METHOD_OVERRIDE

The X-HTTP-Method-Override request header MUST be a string which MUST be interpreted as the request’s method by the Server, if the header is presented. The actual method of the request MUST be ignored. The Client SHOULD use this header if its environment does not support the PATCH or DELETE methods.

See Also:

Constant Field Values

CACHE_CONTROL

public static final String CACHE_CONTROL

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

Constant Field Values

CONTENT_DISPOSITION

public static final String CONTENT_DISPOSITION

See Also:

Constant Field Values

LOCATION

public static final String LOCATION

See Also:

Constant Field Values

TRANSFER_ENCODING

public static final String TRANSFER_ENCODING

The Transfer-Encoding header specifies the form of encoding used to safely transfer the entity to the user.

See Also:

Constant Field Values

UPLOAD_OFFSET

public static final String UPLOAD_OFFSET

The Upload-Offset request and response header indicates a byte offset within a resource. The value MUST be a non-negative integer.

See Also:

Constant Field Values

UPLOAD_METADATA

public static final String UPLOAD_METADATA

See Also:

Constant Field Values

UPLOAD_CHECKSUM

public static final String UPLOAD_CHECKSUM

The Upload-Checksum request header contains information about the checksum of the current body payload. The header MUST consist of the name of the used checksum algorithm and the Base64 encoded checksum separated by a space.

See Also:

Constant Field Values

UPLOAD_LENGTH

public static final String UPLOAD_LENGTH

The Upload-Length request and response header indicates the size of the entire upload in bytes. The value MUST be a non-negative integer.

See Also:

Constant Field Values

UPLOAD_EXPIRES

public static final String UPLOAD_EXPIRES

The Upload-Expires response header indicates the time after which the unfinished upload expires. The value of the Upload-Expires header MUST be in RFC 7231 (https://tools.ietf.org/html/rfc7231#section-7.1.1.1) datetime format.

See Also:

Constant Field Values

UPLOAD_DEFER_LENGTH

public static final String UPLOAD_DEFER_LENGTH

The Upload-Defer-Length request and response header indicates that the size of the upload is not known currently and will be transferred later. Its value MUST be 1. If the length of an upload is not deferred, this header MUST be omitted.

See Also:

Constant Field Values

UPLOAD_CONCAT

public static final String UPLOAD_CONCAT

The Upload-Concat request and response header MUST be set in both partial and upload creation requests. It indicates whether the upload is either a partial or upload.

See Also:

Constant Field Values

TUS_VERSION

public static final String TUS_VERSION

The Tus-Version response header MUST be a comma-separated list of protocol versions supported by the Server. The list MUST be sorted by Server’s preference where the first one is the most preferred one.

See Also:

Constant Field Values

TUS_RESUMABLE

public static final String TUS_RESUMABLE

The Tus-Resumable header MUST be included in every request and response except for OPTIONS requests. The value MUST be the version of the protocol used by the Client or the Server.

See Also:

Constant Field Values

TUS_EXTENSION

public static final String TUS_EXTENSION

The Tus-Extension response header MUST be a comma-separated list of the extensions supported by the Server. If no extensions are supported, the Tus-Extension header MUST be omitted.

See Also:

Constant Field Values

TUS_MAX_SIZE

public static final String TUS_MAX_SIZE

The Tus-Max-Size response header MUST be a non-negative integer indicating the maximum allowed size of an entire upload in bytes. The Server SHOULD set this header if there is a known hard limit.

See Also:

Constant Field Values

TUS_CHECKSUM_ALGORITHM

public static final String TUS_CHECKSUM_ALGORITHM

The Tus-Checksum-Algorithm response header MUST be a comma-separated list of the checksum algorithms supported by the server.

See Also:

Constant Field Values

X_FORWARDED_FOR

public static final String X_FORWARDED_FOR

The X-Forwarded-For (XFF) HTTP header field is a common method for identifying the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer.

See Also:

Constant Field Values