java.lang.Object
org.eclipse.jgit.util.LfsFactory
Represents an optionally present LFS support implementation
- Since:
- 4.11
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Encapsulate a potentially exchangedInputStream
along with the expected stream content length.static interface
A command to enable LFS. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapplyCleanFilter
(Repository db, InputStream input, long length, Attribute attribute) Apply clean filtering to the given stream, writing the file content to the LFS storage if required and returning a stream to the LFS pointer instead.applySmudgeFilter
(Repository db, ObjectLoader loader, Attribute attribute) Apply smudge filtering to a given loader, potentially redirecting it to a LFS blob which is downloaded on demand.static Attributes
getAttributesForPath
(Repository db, String path) Get git attributes for given pathstatic Attributes
getAttributesForPath
(Repository db, String path, RevCommit commit) Get attributes for given path and commitRetrieve anLfsFactory.LfsInstallCommand
which can be used to enable LFS support (if available) either per repository or for the user.static LfsFactory
Get the LFS factory instancegetPrePushHook
(Repository repo, PrintStream outputStream) Retrieve a pre-push hook to be applied using the default error stream.getPrePushHook
(Repository repo, PrintStream outputStream, PrintStream errorStream) Retrieve a pre-push hook to be applied.boolean
Whether LFS support is availableboolean
isEnabled
(Repository db) Whether LFS is enabledstatic void
setInstance
(LfsFactory instance) Set the LFS factory instance
-
Constructor Details
-
LfsFactory
protected LfsFactory()Constructor
-
-
Method Details
-
getInstance
Get the LFS factory instance- Returns:
- the current LFS implementation
-
setInstance
Set the LFS factory instance- Parameters:
instance
- register aLfsFactory
instance as theLfsFactory
implementation to use.
-
isAvailable
public boolean isAvailable()Whether LFS support is available- Returns:
- whether LFS support is available
-
applyCleanFilter
public LfsFactory.LfsInputStream applyCleanFilter(Repository db, InputStream input, long length, Attribute attribute) throws IOException Apply clean filtering to the given stream, writing the file content to the LFS storage if required and returning a stream to the LFS pointer instead.- Parameters:
db
- the repositoryinput
- the original inputlength
- the expected input stream lengthattribute
- the attribute used to check for LFS enablement (i.e. "merge", "diff", "filter" from .gitattributes).- Returns:
- a stream to the content that should be written to the object store along with the expected length of the stream. the original stream is not applicable.
- Throws:
IOException
- in case of an error
-
applySmudgeFilter
public ObjectLoader applySmudgeFilter(Repository db, ObjectLoader loader, Attribute attribute) throws IOException Apply smudge filtering to a given loader, potentially redirecting it to a LFS blob which is downloaded on demand.- Parameters:
db
- the repositoryloader
- the loader for the blobattribute
- the attribute used to check for LFS enablement (i.e. "merge", "diff", "filter" from .gitattributes).- Returns:
- a loader for the actual data of a blob, or the original loader in case LFS is not applicable.
- Throws:
IOException
- if an IO error occurred
-
getPrePushHook
Retrieve a pre-push hook to be applied using the default error stream.- Parameters:
repo
- theRepository
the hook is applied to.outputStream
- output stream- Returns:
- a
PrePushHook
implementation ornull
-
getPrePushHook
@Nullable public PrePushHook getPrePushHook(Repository repo, PrintStream outputStream, PrintStream errorStream) Retrieve a pre-push hook to be applied.- Parameters:
repo
- theRepository
the hook is applied to.outputStream
- output streamerrorStream
- error stream- Returns:
- a
PrePushHook
implementation ornull
- Since:
- 5.6
-
getInstallCommand
Retrieve anLfsFactory.LfsInstallCommand
which can be used to enable LFS support (if available) either per repository or for the user.- Returns:
- a command to install LFS support.
-
isEnabled
Whether LFS is enabled- Parameters:
db
- the repository to check- Returns:
- whether LFS is enabled for the given repository locally or globally.
-
getAttributesForPath
Get git attributes for given path- Parameters:
db
- the repositorypath
- the path to find attributes for- Returns:
- the
Attributes
for the given path. - Throws:
IOException
- in case of an error
-
getAttributesForPath
public static Attributes getAttributesForPath(Repository db, String path, RevCommit commit) throws IOException Get attributes for given path and commit- Parameters:
db
- the repositorypath
- the path to find attributes forcommit
- the commit to inspect.- Returns:
- the
Attributes
for the given path. - Throws:
IOException
- in case of an error
-