Nested and Inner Type Summary

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

Field Summary

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

Method Summary

Modifier and Type	Method and Description
public static Gson	Returns: a `Gson` instance suitable for handling this `Protocol` gson() Gson instance for handling this protocol

Field Detail

CONTENTTYPE_VND_GIT_LFS_JSON	back to summary
public static final String CONTENTTYPE_VND_GIT_LFS_JSON The contenttype used in LFS requests

HDR_AUTH	back to summary
public static final String HDR_AUTH Authorization header when auto-discovering via SSH.

HDR_AUTH_SSH_PREFIX	back to summary
public static final String HDR_AUTH_SSH_PREFIX Prefix of authentication token obtained through SSH.

INFO_LFS_ENDPOINT	back to summary
public static final String INFO_LFS_ENDPOINT Path to the LFS info servlet.

OBJECTS_LFS_ENDPOINT	back to summary
public static final String OBJECTS_LFS_ENDPOINT Path to the LFS objects servlet.

OPERATION_DOWNLOAD	back to summary
public static final String OPERATION_DOWNLOAD The "download" operation

OPERATION_UPLOAD	back to summary
public static final String OPERATION_UPLOAD The "upload" operation

Method Detail

gson back to summary

gson	back to summary
public static Gson gson() Gson instance for handling this protocol Returns:Gson a `Gson` instance suitable for handling this `Protocol` Since 4.11

public static Gson gson()

Gson instance for handling this protocol

Returns:Gson: a Gson instance suitable for handling this Protocol
Since: 4.11

org.eclipse.jgit.lfs back to summary

public Class Protocol.Action

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.lfs.Protocol.Action

Known Direct Subclasses

org.eclipse.jgit.lfs.Protocol.ExpiringAction

Describes in a Response a single action the client can execute on a single object

Field Summary

Modifier and Type	Field and Description
public Map<String, String>	header
public String	href

Constructor Summary

Access	Constructor and Description
public	Action()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

header	back to summary
public Map<String, String> header

href	back to summary
public String href

Constructor Detail

Action	back to summary
public Action()

org.eclipse.jgit.lfs back to summary

public Class Protocol.Error

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.lfs.Protocol.Error

Annotations

@SuppressWarnings:JavaLangClash

Describes an error to be returned by the LFS batch API

Field Summary

Modifier and Type	Field and Description
public int	code
public String	message

Constructor Summary

Access	Constructor and Description
public	Error()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

code	back to summary
public int code

message	back to summary
public String message

Constructor Detail

Error	back to summary
public Error()

org.eclipse.jgit.lfs back to summary

public Class Protocol.ExpiringAction

Class Inheritance

extends Action

java.lang.Object
org.eclipse.jgit.lfs.Protocol.Action
org.eclipse.jgit.lfs.Protocol.ExpiringAction

An action with an additional expiration timestamp

Since: 4.11

Field Summary

Modifier and Type	Field and Description
public String	expiresAt Absolute date/time in format "yyyy-MM-dd'T'HH:mm:ss.SSSX"
public String	expiresIn Validity time in milliseconds (preferred over expiresAt as specified: https://github.com/git-lfs/git-lfs/blob/master/docs/api/authentication.md)

Inherited from org.eclipse.jgit.lfs.Protocol.Action:: header href

Constructor Summary

Access	Constructor and Description
public	ExpiringAction()

Field Detail

expiresAt	back to summary
public String expiresAt Absolute date/time in format "yyyy-MM-dd'T'HH:mm:ss.SSSX"

expiresIn	back to summary
public String expiresIn Validity time in milliseconds (preferred over expiresAt as specified: https://github.com/git-lfs/git-lfs/blob/master/docs/api/authentication.md)

Constructor Detail

ExpiringAction	back to summary
public ExpiringAction()

org.eclipse.jgit.lfs back to summary

public Class Protocol.ObjectInfo

Class Inheritance

extends ObjectSpec

java.lang.Object
org.eclipse.jgit.lfs.Protocol.ObjectSpec
org.eclipse.jgit.lfs.Protocol.ObjectInfo

Describes in a response all actions the LFS server offers for a single object

Field Summary

Modifier and Type	Field and Description
public Map<String, Protocol.Action>	actions
public Protocol.Error	error

Inherited from org.eclipse.jgit.lfs.Protocol.ObjectSpec:: oid size

Constructor Summary

Access	Constructor and Description
public	ObjectInfo()

Field Detail

actions	back to summary
public Map<String, Protocol.Action> actions

error	back to summary
public Protocol.Error error

Constructor Detail

ObjectInfo	back to summary
public ObjectInfo()

org.eclipse.jgit.lfs back to summary

public Class Protocol.ObjectSpec

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.lfs.Protocol.ObjectSpec

Known Direct Subclasses

org.eclipse.jgit.lfs.Protocol.ObjectInfo

MetaData of an LFS object. Needs to be specified when requesting objects from the LFS server and is also returned in the response

Field Summary

Modifier and Type	Field and Description
public String	oid
public long	size

Constructor Summary

Access	Constructor and Description
public	ObjectSpec()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

oid	back to summary
public String oid

size	back to summary
public long size

Constructor Detail

ObjectSpec	back to summary
public ObjectSpec()

org.eclipse.jgit.lfs back to summary

public Class Protocol.Request

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.lfs.Protocol.Request

A request sent to an LFS server

Field Summary

Modifier and Type	Field and Description
public List<Protocol.ObjectSpec>	objects The objects of this request
public String	operation The operation of this request

Constructor Summary

Access	Constructor and Description
public	Request()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

objects	back to summary
public List<Protocol.ObjectSpec> objects The objects of this request

operation	back to summary
public String operation The operation of this request

Constructor Detail

Request	back to summary
public Request()

org.eclipse.jgit.lfs back to summary

public Class Protocol.Response

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.lfs.Protocol.Response

A response received from an LFS server

Field Summary

Modifier and Type	Field and Description
public List<Protocol.ObjectInfo>	objects

Constructor Summary

Access	Constructor and Description
public	Response()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

objects	back to summary
public List<Protocol.ObjectInfo> objects

Constructor Detail

Response	back to summary
public Response()

public Interface Protocol

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Protocol.Action

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class Protocol.Error

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class Protocol.ExpiringAction

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public Class Protocol.ObjectInfo

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public Class Protocol.ObjectSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class Protocol.Request

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class Protocol.Response

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail