Package org.eclipse.jgit.hooks
Class GitHook<T>
java.lang.Object
org.eclipse.jgit.hooks.GitHook<T>
- Type Parameters:
T
- the return type which is expected fromcall()
- All Implemented Interfaces:
Callable<T>
- Direct Known Subclasses:
CommitMsgHook
,PostCommitHook
,PreCommitHook
,PrePushHook
Git can fire off custom scripts when certain important actions occur. These
custom scripts are called "hooks". There are two groups of hooks: client-side
(that run on local operations such as committing and merging), and
server-side (that run on network operations such as receiving pushed
commits). This is the abstract super-class of the different hook
implementations in JGit.
- Since:
- 5.11
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final OutputStream
The error stream to be used by the hook.private final OutputStream
The output stream to be used by the hook.private final Repository
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
GitHook
(Repository repo, OutputStream outputStream) Constructor for GitHook.protected
GitHook
(Repository repo, OutputStream outputStream, OutputStream errorStream) Constructor for GitHook -
Method Summary
Modifier and TypeMethodDescriptionabstract T
call()
protected void
doRun()
Runs the hook, without performing any validity checks.protected OutputStream
Get error streamabstract String
Get name of the hookprotected OutputStream
Get output streamprotected String[]
Override this method when needed to provide relevant parameters to the underlying hook script.protected Repository
Get the repositoryprotected String
Override to provide relevant arguments via stdin to the underlying hook script.protected void
handleError
(String message, ProcessResult result) Process that the hook exited with an error.boolean
Check whether a 'native' (i.e.
-
Field Details
-
repo
-
outputStream
The output stream to be used by the hook. -
errorStream
The error stream to be used by the hook.
-
-
Constructor Details
-
GitHook
Constructor for GitHook.This constructor will use stderr for the error stream.
- Parameters:
repo
- aRepository
object.outputStream
- The output stream the hook must use.null
is allowed, in which case the hook will useSystem.out
.
-
GitHook
Constructor for GitHook- Parameters:
repo
- aRepository
object.outputStream
- The output stream the hook must use.null
is allowed, in which case the hook will useSystem.out
.errorStream
- The error stream the hook must use.null
is allowed, in which case the hook will useSystem.err
.
-
-
Method Details
-
call
Run the hook.
- Specified by:
call
in interfaceCallable<T>
- Throws:
IOException
AbortedByHookException
-
getHookName
Get name of the hook- Returns:
- The name of the hook, which must not be
null
.
-
getRepository
Get the repository- Returns:
- The repository.
-
getParameters
Override this method when needed to provide relevant parameters to the underlying hook script. The default implementation returns an empty array.- Returns:
- The parameters the hook receives.
-
getStdinArgs
Override to provide relevant arguments via stdin to the underlying hook script. The default implementation returnsnull
.- Returns:
- The parameters the hook receives.
-
getOutputStream
Get output stream- Returns:
- The output stream the hook must use. Never
null
,System.out
is returned by default.
-
getErrorStream
Get error stream- Returns:
- The error stream the hook must use. Never
null
,System.err
is returned by default.
-
doRun
Runs the hook, without performing any validity checks.- Throws:
AbortedByHookException
- If the underlying hook script exited with non-zero.IOException
- if an IO error occurred
-
handleError
Process that the hook exited with an error. This default implementation throws anAbortedByHookException
. Hooks which need a different behavior can overwrite this method.- Parameters:
message
- error messageresult
- The process result of the hook- Throws:
AbortedByHookException
- When the hook should be aborted- Since:
- 5.11
-
isNativeHookPresent
public boolean isNativeHookPresent()Check whether a 'native' (i.e. script) hook is installed in the repository.- Returns:
- whether a native hook script is installed in the repository.
- Since:
- 4.11
-