UploadPack (JGit - Core 5.0.0.201806131550-r API)

java.lang.Object
- org.eclipse.jgit.transport.UploadPack

```
public class UploadPack
extends Object
```
Implements the server side of a fetch connection, transmitting objects.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UploadPack.AdvertisedRequestValidator` Validator corresponding to `UploadPack.RequestPolicy.ADVERTISED`.
`static class`	`UploadPack.AnyRequestValidator` Validator corresponding to `UploadPack.RequestPolicy.ANY`.
`static class`	`UploadPack.FirstLine` Data in the first line of a request, the line itself plus options.
`static class`	`UploadPack.ReachableCommitRequestValidator` Validator corresponding to `UploadPack.RequestPolicy.REACHABLE_COMMIT`.
`static class`	`UploadPack.ReachableCommitTipRequestValidator` Validator corresponding to `UploadPack.RequestPolicy.REACHABLE_COMMIT_TIP`.
`static class`	`UploadPack.RequestPolicy` Policy the server uses to validate client requests
`static interface`	`UploadPack.RequestValidator` Validator for client requests.
`static class`	`UploadPack.TipRequestValidator` Validator corresponding to `UploadPack.RequestPolicy.TIP`.

Constructor Summary

Constructors
Constructor and Description

UploadPack(Repository copyFrom)
Create a new pack upload for an open repository.

Constructors
Constructor and Description
`UploadPack(Repository copyFrom)` Create a new pack upload for an open repository.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Ref>`	`getAdvertisedRefs()` Get refs which were advertised to the client.
`AdvertiseRefsHook`	`getAdvertiseRefsHook()` Get the hook used while advertising the refs to the client.
`int`	`getDepth()` Returns the clone/fetch depth.
`OutputStream`	`getMessageOutputStream()` Get an underlying stream for sending messages to the client
`String`	`getPeerUserAgent()` Get the user agent of the client.
`PostUploadHook`	`getPostUploadHook()` Get the configured post upload hook.
`PreUploadHook`	`getPreUploadHook()` Get the configured pre upload hook.
`RefFilter`	`getRefFilter()` Get the filter used while advertising the refs to the client.
`Repository`	`getRepository()` Get the repository this upload is reading from.
`UploadPack.RequestPolicy`	`getRequestPolicy()` Get policy used by the service to validate client requests
`RevWalk`	`getRevWalk()` Get the RevWalk instance used by this connection.
`PackStatistics`	`getStatistics()` Get the PackWriter's statistics if a pack was sent to the client.
`int`	`getTimeout()` Get timeout (in seconds) before aborting an IO operation.
`boolean`	`isBiDirectionalPipe()` Whether this class expects a bi-directional pipe opened between the client and itself.
`boolean`	`isSideBand()` Check whether the client expects a side-band stream.
`void`	`sendAdvertisedRefs(RefAdvertiser adv)` Generate an advertisement of available refs and capabilities.
`void`	`sendAdvertisedRefs(RefAdvertiser adv, String serviceName)` Generate an advertisement of available refs and capabilities.
`void`	`sendMessage(String what)` Send a message to the client, if it supports receiving them.
`void`	`setAdvertisedRefs(Map<String,Ref> allRefs)` Set the refs advertised by this UploadPack.
`void`	`setAdvertiseRefsHook(AdvertiseRefsHook advertiseRefsHook)` Set the hook used while advertising the refs to the client.
`void`	`setBiDirectionalPipe(boolean twoWay)` Set whether this class will assume the socket is a fully bidirectional pipe between the two peers
`void`	`setExtraParameters(Collection<String> params)` Set the Extra Parameters provided by the client.
`void`	`setPackConfig(PackConfig pc)` Set the configuration used by the pack generator.
`void`	`setPostUploadHook(PostUploadHook hook)` Set the hook for post upload actions (logging, repacking).
`void`	`setPreUploadHook(PreUploadHook hook)` Set the hook that controls how this instance will behave.
`void`	`setRefFilter(RefFilter refFilter)` Set the filter used while advertising the refs to the client.
`void`	`setRequestPolicy(UploadPack.RequestPolicy policy)` Set the policy used to enforce validation of a client's want list.
`void`	`setRequestValidator(UploadPack.RequestValidator validator)` Set custom validator for client want list.
`void`	`setTimeout(int seconds)` Set the timeout before willing to abort an IO call.
`void`	`setTransferConfig(TransferConfig tc)` Set configuration controlling transfer options.
`void`	`upload(InputStream input, OutputStream output, OutputStream messages)` Execute the upload task on the socket.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UploadPack
```
public UploadPack(Repository copyFrom)
```
    Create a new pack upload for an open repository.
    
    Parameters:
    
    copyFrom - the source repository.
- Method Detail
  - getRepository
```
public final Repository getRepository()
```
    Get the repository this upload is reading from.
    
    Returns:
    
    the repository this upload is reading from.
  - getRevWalk
```
public final RevWalk getRevWalk()
```
    Get the RevWalk instance used by this connection.
    
    Returns:
    
    the RevWalk instance used by this connection.
  - getAdvertisedRefs
```
public final Map<String,Ref> getAdvertisedRefs()
```
    Get refs which were advertised to the client.
    
    Returns:
    
    all refs which were advertised to the client, or null if setAdvertisedRefs(Map) has not been called yet.
  - setAdvertisedRefs
```
public void setAdvertisedRefs(Map<String,Ref> allRefs)
```
    Set the refs advertised by this UploadPack.
    Intended to be called from a PreUploadHook.
    
    Parameters:
    
    allRefs - explicit set of references to claim as advertised by this UploadPack instance. This overrides any references that may exist in the source repository. The map is passed to the configured getRefFilter(). If null, assumes all refs were advertised.
  - getTimeout
```
public int getTimeout()
```
    Get timeout (in seconds) before aborting an IO operation.
    
    Returns:
    
    timeout (in seconds) before aborting an IO operation.
  - setTimeout
```
public void setTimeout(int seconds)
```
    Set the timeout before willing to abort an IO call.
    
    Parameters:
    
    seconds - number of seconds to wait (with no data transfer occurring) before aborting an IO read or write operation with the connected client.
  - isBiDirectionalPipe
```
public boolean isBiDirectionalPipe()
```
    Whether this class expects a bi-directional pipe opened between the client and itself.
    
    Returns:
    
    true if this class expects a bi-directional pipe opened between the client and itself. The default is true.
  - setBiDirectionalPipe
```
public void setBiDirectionalPipe(boolean twoWay)
```
    Set whether this class will assume the socket is a fully bidirectional pipe between the two peers
    
    Parameters:
    
    twoWay - if true, this class will assume the socket is a fully bidirectional pipe between the two peers and takes advantage of that by first transmitting the known refs, then waiting to read commands. If false, this class assumes it must read the commands before writing output and does not perform the initial advertising.
  - getRequestPolicy
```
public UploadPack.RequestPolicy getRequestPolicy()
```
    Get policy used by the service to validate client requests
    
    Returns:
    
    policy used by the service to validate client requests, or null for a custom request validator.
  - setRequestPolicy
```
public void setRequestPolicy(UploadPack.RequestPolicy policy)
```
    Set the policy used to enforce validation of a client's want list.
    
    Parameters:
    
    policy - the policy used to enforce validation of a client's want list. By default the policy is UploadPack.RequestPolicy.ADVERTISED, which is the Git default requiring clients to only ask for an object that a reference directly points to. This may be relaxed to UploadPack.RequestPolicy.REACHABLE_COMMIT or UploadPack.RequestPolicy.REACHABLE_COMMIT_TIP when callers have setBiDirectionalPipe(boolean) set to false. Overrides any policy specified in a TransferConfig.
  - setRequestValidator
```
public void setRequestValidator(UploadPack.RequestValidator validator)
```
    Set custom validator for client want list.
    
    Parameters:
    
    validator - custom validator for client want list.
    
    Since:
    
    3.1
  - getAdvertiseRefsHook
```
public AdvertiseRefsHook getAdvertiseRefsHook()
```
    Get the hook used while advertising the refs to the client.
    
    Returns:
    
    the hook used while advertising the refs to the client.
  - getRefFilter
```
public RefFilter getRefFilter()
```
    Get the filter used while advertising the refs to the client.
    
    Returns:
    
    the filter used while advertising the refs to the client.
  - setAdvertiseRefsHook
```
public void setAdvertiseRefsHook(AdvertiseRefsHook advertiseRefsHook)
```
    Set the hook used while advertising the refs to the client.
    If the AdvertiseRefsHook chooses to call setAdvertisedRefs(Map), only refs set by this hook and selected by the RefFilter will be shown to the client.
    
    Parameters:
    
    advertiseRefsHook - the hook; may be null to show all refs.
  - setRefFilter
```
public void setRefFilter(RefFilter refFilter)
```
    Set the filter used while advertising the refs to the client.
    Only refs allowed by this filter will be sent to the client. The filter is run against the refs specified by the AdvertiseRefsHook (if applicable). If null or not set, uses the filter implied by the TransferConfig.
    
    Parameters:
    
    refFilter - the filter; may be null to show all refs.
  - getPreUploadHook
```
public PreUploadHook getPreUploadHook()
```
    Get the configured pre upload hook.
    
    Returns:
    
    the configured pre upload hook.
  - setPreUploadHook
```
public void setPreUploadHook(PreUploadHook hook)
```
    Set the hook that controls how this instance will behave.
    
    Parameters:
    
    hook - the hook; if null no special actions are taken.
  - getPostUploadHook
```
public PostUploadHook getPostUploadHook()
```
    Get the configured post upload hook.
    
    Returns:
    
    the configured post upload hook.
    
    Since:
    
    4.1
  - setPostUploadHook
```
public void setPostUploadHook(PostUploadHook hook)
```
    Set the hook for post upload actions (logging, repacking).
    
    Parameters:
    
    hook - the hook; if null no special actions are taken.
    
    Since:
    
    4.1
  - setPackConfig
```
public void setPackConfig(PackConfig pc)
```
    Set the configuration used by the pack generator.
    
    Parameters:
    
    pc - configuration controlling packing parameters. If null the source repository's settings will be used.
  - setTransferConfig
```
public void setTransferConfig(TransferConfig tc)
```
    Set configuration controlling transfer options.
    
    Parameters:
    
    tc - configuration controlling transfer options. If null the source repository's settings will be used.
    
    Since:
    
    3.1
  - isSideBand
```
public boolean isSideBand()
                   throws RequestNotYetReadException
```
    Check whether the client expects a side-band stream.
    
    Returns:
    
    true if the client has advertised a side-band capability, false otherwise.
    
    Throws:
    
    RequestNotYetReadException - if the client's request has not yet been read from the wire, so we do not know if they expect side-band. Note that the client may have already written the request, it just has not been read.
  - setExtraParameters
```
public void setExtraParameters(Collection<String> params)
```
    Set the Extra Parameters provided by the client.
    These are parameters passed by the client through a side channel such as the Git-Protocol HTTP header, to allow a client to request a newer response format while remaining compatible with older servers that do not understand different request formats.
    
    Parameters:
    
    params - parameters supplied by the client, split at colons or NUL bytes.
    
    Since:
    
    5.0
  - upload
```
public void upload(InputStream input,
                   OutputStream output,
                   OutputStream messages)
            throws IOException
```
    Execute the upload task on the socket.
    If the client passed extra parameters (e.g., "version=2") through a side channel, the caller must call setExtraParameters first to supply them.
    
    Parameters:
    
    input - raw input to read client commands from. Caller must ensure the input is buffered, otherwise read performance may suffer.
    
    output - response back to the Git network client, to write the pack data onto. 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
  - getStatistics
```
public PackStatistics getStatistics()
```
    Get the PackWriter's statistics if a pack was sent to the client.
    
    Returns:
    
    statistics about pack output, if a pack was sent. Null if no pack was sent, such as during the negotiation phase of a smart HTTP connection, or if the client was already up-to-date.
    
    Since:
    
    4.1
  - sendAdvertisedRefs
```
public void sendAdvertisedRefs(RefAdvertiser adv)
                        throws IOException,
                               ServiceMayNotContinueException
```
    Generate an advertisement of available refs and capabilities.
    
    Parameters:
    
    adv - the advertisement formatter.
    
    Throws:
    
    IOException - the formatter failed to write an advertisement.
    
    ServiceMayNotContinueException - the hook denied advertisement.
  - sendAdvertisedRefs
```
public void sendAdvertisedRefs(RefAdvertiser adv,
                               @Nullable
                               String serviceName)
                        throws IOException,
                               ServiceMayNotContinueException
```
    Generate an advertisement of available refs and capabilities.
    
    Parameters:
    
    adv - the advertisement formatter.
    
    serviceName - if not null, also output "# service=serviceName" followed by a flush packet before the advertisement. This is required in v0 of the HTTP protocol, described in Git's Documentation/technical/http-protocol.txt.
    
    Throws:
    
    IOException - the formatter failed to write an advertisement.
    
    ServiceMayNotContinueException - the hook denied advertisement.
    
    Since:
    
    5.0
  - sendMessage
```
public void sendMessage(String what)
```
    Send a message to the client, if it supports receiving them.
    If the client doesn't support receiving messages, the message will be discarded, with no other indication to the caller or to the client.
    
    Parameters:
    
    what - string describing the problem identified by the hook. The string must not end with an LF, and must not contain an LF.
    
    Since:
    
    3.1
  - getMessageOutputStream
```
public OutputStream getMessageOutputStream()
```
    Get an underlying stream for sending messages to the client
    
    Returns:
    
    an underlying stream for sending messages to the client, or null.
    
    Since:
    
    3.1
  - getDepth
```
public int getDepth()
```
    Returns the clone/fetch depth. Valid only after calling recvWants(). A depth of 1 means return only the wants.
    
    Returns:
    
    the depth requested by the client, or 0 if unbounded.
    
    Since:
    
    4.0
  - getPeerUserAgent
```
public String getPeerUserAgent()
```
    Get the user agent of the client.
    If the client is new enough to use agent= capability that value will be returned. Older HTTP clients may also supply their version using the HTTP User-Agent header. The capability overrides the HTTP header if both are available.
    When an HTTP request has been received this method returns the HTTP User-Agent header value until capabilities have been parsed.
    
    Returns:
    
    user agent supplied by the client. Available only if the client is new enough to advertise its user agent.
    
    Since:
    
    4.0

Class UploadPack

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UploadPack

Method Detail

getRepository

getRevWalk

getAdvertisedRefs

setAdvertisedRefs

getTimeout

setTimeout

isBiDirectionalPipe

setBiDirectionalPipe

getRequestPolicy

setRequestPolicy

setRequestValidator

getAdvertiseRefsHook

getRefFilter

setAdvertiseRefsHook

setRefFilter

getPreUploadHook

setPreUploadHook

getPostUploadHook

setPostUploadHook

setPackConfig

setTransferConfig

isSideBand

setExtraParameters

upload

getStatistics

sendAdvertisedRefs

sendAdvertisedRefs

sendMessage

getMessageOutputStream

getDepth

getPeerUserAgent