org.eclipse.jgit.hooks

Class PrePushHook

java.lang.Object

org.eclipse.jgit.hooks.PrePushHook

All Implemented Interfaces:

Callable<String>

public class PrePushHook
extends Object

The pre-push hook implementation. The pre-push hook runs during git push, after the remote refs have been updated but before any objects have been transferred.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Constant indicating the name of the pre-push hook.
protected PrintStream	outputStream The output stream to be used by the hook.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrePushHook(Repository repo, PrintStream outputStream)

Method Summary

Methods

Modifier and Type	Method and Description
String	call() Run the hook.
protected void	doRun() Runs the hook, without performing any validity checks.
String	getHookName()
protected PrintStream	getOutputStream()
protected String[]	getParameters() This hook receives two parameters, which is the name and the location of the remote repository.
protected Repository	getRepository()
protected String	getStdinArgs() Override to provide relevant arguments via stdin to the underlying hook script.
void	setRefs(Collection<RemoteRefUpdate> toRefs)
void	setRemoteLocation(String location)
void	setRemoteName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Constant indicating the name of the pre-push hook.

See Also:

Constant Field Values

outputStream

protected final PrintStream outputStream

The output stream to be used by the hook.

Constructor Detail

PrePushHook

protected PrePushHook(Repository repo,
           PrintStream outputStream)

Parameters:

repo - The repository

outputStream - The output stream the hook must use. null is allowed, in which case the hook will use System.out.

Method Detail

getStdinArgs

protected String getStdinArgs()

Override to provide relevant arguments via stdin to the underlying hook script. The default implementation returns null.

Returns:

The parameters the hook receives.

call

public String call()
            throws IOException,
                   AbortedByHookException

Run the hook.

Specified by:

call in interface Callable<String>

Throws:

IOException - if IO goes wrong.

AbortedByHookException - If the hook has been run and a returned an exit code different from zero.

getHookName

public String getHookName()

Returns:

The name of the hook, which must not be null.

getParameters

protected String[] getParameters()

This hook receives two parameters, which is the name and the location of the remote repository.

Returns:

The parameters the hook receives.

setRemoteName

public void setRemoteName(String name)

Parameters:

name -

setRemoteLocation

public void setRemoteLocation(String location)

Parameters:

location -

setRefs

public void setRefs(Collection<RemoteRefUpdate> toRefs)

Parameters:

toRefs -

getRepository

protected Repository getRepository()

Returns:

The repository.

getOutputStream

protected PrintStream getOutputStream()

Returns:

The output stream the hook must use. Never null, System.out is returned by default.

doRun

protected void doRun()
              throws AbortedByHookException

Runs the hook, without performing any validity checks.

Throws:

AbortedByHookException - If the underlying hook script exited with non-zero.