org.eclipse.jgit.transport

Class ReceivePack

java.lang.Object

org.eclipse.jgit.transport.BaseReceivePack

org.eclipse.jgit.transport.ReceivePack

public class ReceivePack
extends BaseReceivePack

Implements the server side of a push connection, receiving objects.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jgit.transport.BaseReceivePack

BaseReceivePack.FirstLine, BaseReceivePack.ReceiveConfig

Field Summary

Fields inherited from class org.eclipse.jgit.transport.BaseReceivePack

msgOut, pckIn, pckOut, rawIn, rawOut

Constructor Summary

Constructors

Constructor and Description
ReceivePack(Repository into) Create a new pack receive for an open repository.

Method Summary

Modifier and Type	Method and Description
protected void	enableCapabilities() Enable capabilities based on a previously read capabilities line.
protected String	getLockMessageProcessName() Get the process name used for pack lock messages.
PostReceiveHook	getPostReceiveHook() Get the hook invoked after updates occur.
PreReceiveHook	getPreReceiveHook() Get the hook invoked before updates occur.
List<String>	getPushOptions() Gets an unmodifiable view of the option strings associated with the push.
void	receive(InputStream input, OutputStream output, OutputStream messages) Execute the receive task on the socket.
void	setEchoCommandFailures(boolean echo) Set whether this class will report command failures as warning messages before sending the command results.
void	setPostReceiveHook(PostReceiveHook h) Set the hook which is invoked after commands are executed.
void	setPreReceiveHook(PreReceiveHook h) Set the hook which is invoked prior to commands being executed.
void	setPushOptions(List<String> options) Set the push options supplied by the client.

Methods inherited from class org.eclipse.jgit.transport.BaseReceivePack

anyRejects, close, executeCommands, failPendingCommands, filterCommands, getAdvertisedObjects, getAdvertisedOrDefaultRefs, getAdvertisedRefs, getAdvertiseRefsHook, getAllCommands, getClientShallowCommits, getMessageOutputStream, getPackSize, getPeerUserAgent, getPushCertificate, getReceivedPackStatistics, getRefFilter, getRefLogIdent, getRepository, getRevWalk, getTimeout, hasCommands, hasError, init, isAllowBranchDeletes, isAllowCreates, isAllowDeletes, isAllowNonFastForwards, isAllowPushOptions, isAllowQuiet, isAtomic, isBiDirectionalPipe, isCapabilityEnabled, isCheckReceivedObjects, isCheckReferencedObjectsAreReachable, isExpectDataAfterPackFooter, isQuiet, isSideBand, needPack, receivePackAndCheckConnectivity, recvCommands, release, sendAdvertisedRefs, sendError, sendMessage, sendStatusReport, setAdvertisedRefs, setAdvertiseRefsHook, setAllowBranchDeletes, setAllowCreates, setAllowDeletes, setAllowNonFastForwards, setAllowPushOptions, setAllowQuiet, setAtomic, setBiDirectionalPipe, setCheckReceivedObjects, setCheckReferencedObjectsAreReachable, setExpectDataAfterPackFooter, setMaxCommandBytes, setMaxCommandDiscardBytes, setMaxObjectSizeLimit, setMaxPackSizeLimit, setObjectChecker, setPushCertificate, setRefFilter, setRefLogIdent, setSignedPushConfig, setTimeout, unlockPack, validateCommands

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceivePack

public ReceivePack(Repository into)

Create a new pack receive for an open repository.

Parameters:

into - the destination repository.

Method Detail

getPushOptions

@Nullable
public List<String> getPushOptions()

Gets an unmodifiable view of the option strings associated with the push.

Returns:

an unmodifiable view of pushOptions, or null (if pushOptions is).

Since:

4.5

setPushOptions

public void setPushOptions(@Nullable
                           List<String> options)

Set the push options supplied by the client.

Should only be called if reconstructing an instance without going through the normal BaseReceivePack.recvCommands() flow.

Parameters:

options - the list of options supplied by the client. The ReceivePack instance takes ownership of this list. Callers are encouraged to first create a copy if the list may be modified later.

Since:

4.5

getPreReceiveHook

public PreReceiveHook getPreReceiveHook()

Get the hook invoked before updates occur.

Returns:

the hook invoked before updates occur.

setPreReceiveHook

public void setPreReceiveHook(PreReceiveHook h)

Set the hook which is invoked prior to commands being executed.

Only valid commands (those which have no obvious errors according to the received input and this instance's configuration) are passed into the hook. The hook may mark a command with a result of any value other than ReceiveCommand.Result.NOT_ATTEMPTED to block its execution.

The hook may be called with an empty command collection if the current set is completely invalid.

Parameters:

h - the hook instance; may be null to disable the hook.

getPostReceiveHook

public PostReceiveHook getPostReceiveHook()

Get the hook invoked after updates occur.

Returns:

the hook invoked after updates occur.

setPostReceiveHook

public void setPostReceiveHook(PostReceiveHook h)

Set the hook which is invoked after commands are executed.

Only successful commands (type is ReceiveCommand.Result.OK) are passed into the hook. The hook may be called with an empty command collection if the current set all resulted in an error.

Parameters:

h - the hook instance; may be null to disable the hook.

setEchoCommandFailures

public void setEchoCommandFailures(boolean echo)

Set whether this class will report command failures as warning messages before sending the command results.

Parameters:

echo - if true this class will report command failures as warning messages before sending the command results. This is usually not necessary, but may help buggy Git clients that discard the errors when all branches fail.

receive

public void receive(InputStream input,
                    OutputStream output,
                    OutputStream messages)
             throws IOException

Execute the receive task on the socket.

Parameters:

input - raw input to read client commands and pack data from. Caller must ensure the input is buffered, otherwise read performance may suffer.

output - response back to the Git network client. Caller must ensure the output is buffered, otherwise write performance may suffer.

messages - secondary "notice" channel to send additional messages out through. When run over SSH this should be tied back to the standard error channel of the command execution. For most other network connections this should be null.

Throws:

IOException

enableCapabilities

protected void enableCapabilities()

Enable capabilities based on a previously read capabilities line.

Overrides:

enableCapabilities in class BaseReceivePack

getLockMessageProcessName

protected String getLockMessageProcessName()

Get the process name used for pack lock messages.

Specified by:

getLockMessageProcessName in class BaseReceivePack

Returns:

the process name used for pack lock messages.