Interface Protocol

public interface Protocol

This interface describes the network protocol used between lfs client and lfs server

Since:

4.11

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Protocol.Action	Describes in a Response a single action the client can execute on a single object
static class	Protocol.Error	Describes an error to be returned by the LFS batch API
static class	Protocol.ExpiringAction	An action with an additional expiration timestamp
static class	Protocol.ObjectInfo	Describes in a response all actions the LFS server offers for a single object
static class	Protocol.ObjectSpec	MetaData of an LFS object.
static class	Protocol.Request	A request sent to an LFS server
static class	Protocol.Response	A response received from an LFS server

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENTTYPE_VND_GIT_LFS_JSON	The contenttype used in LFS requests
static final String	HDR_AUTH	Authorization header when auto-discovering via SSH.
static final String	HDR_AUTH_SSH_PREFIX	Prefix of authentication token obtained through SSH.
static final String	INFO_LFS_ENDPOINT	Path to the LFS info servlet.
static final String	OBJECTS_LFS_ENDPOINT	Path to the LFS objects servlet.
static final String	OPERATION_DOWNLOAD	The "download" operation
static final String	OPERATION_UPLOAD	The "upload" operation

Method Summary

Static Methods

Modifier and Type	Method	Description
static com.google.gson.Gson	gson()

Field Details

OPERATION_DOWNLOAD

static final String OPERATION_DOWNLOAD

The "download" operation

See Also:

• Constant Field Values

OPERATION_UPLOAD

static final String OPERATION_UPLOAD

The "upload" operation

See Also:

• Constant Field Values

CONTENTTYPE_VND_GIT_LFS_JSON

static final String CONTENTTYPE_VND_GIT_LFS_JSON

The contenttype used in LFS requests

See Also:

• Constant Field Values

HDR_AUTH

static final String HDR_AUTH

Authorization header when auto-discovering via SSH.

See Also:

• Constant Field Values

HDR_AUTH_SSH_PREFIX

static final String HDR_AUTH_SSH_PREFIX

Prefix of authentication token obtained through SSH.

See Also:

• Constant Field Values

INFO_LFS_ENDPOINT

static final String INFO_LFS_ENDPOINT

Path to the LFS info servlet.

See Also:

• Constant Field Values

OBJECTS_LFS_ENDPOINT

static final String OBJECTS_LFS_ENDPOINT

Path to the LFS objects servlet.

See Also:

• Constant Field Values

Method Details

gson

static com.google.gson.Gson gson()

Returns:

a Gson instance suitable for handling this Protocol

Since:

4.11