org.eclipse.jgit.transport

Class TransportSftp.SftpObjectDB

java.lang.Object

org.eclipse.jgit.transport.WalkRemoteObjectDatabase

org.eclipse.jgit.transport.TransportSftp.SftpObjectDB

Enclosing class:

TransportSftp

class TransportSftp.SftpObjectDB
extends WalkRemoteObjectDatabase

Nested Class Summary

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

WalkRemoteObjectDatabase.FileStream

Field Summary

Fields

Modifier and Type	Field and Description
private com.jcraft.jsch.ChannelSftp	ftp
private java.lang.String	objectsPath

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

INFO_ALTERNATES, INFO_HTTP_ALTERNATES, INFO_PACKS, INFO_REFS, ROOT_DIR

Constructor Summary

Constructors

Constructor and Description
SftpObjectDB(java.lang.String path)
SftpObjectDB(TransportSftp.SftpObjectDB parent, java.lang.String p)

Method Summary

Modifier and Type	Method and Description
(package private) void	close() Close any resources used by this connection.
(package private) void	deleteFile(java.lang.String path) Delete a file from the object database.
(package private) java.util.Collection<WalkRemoteObjectDatabase>	getAlternates() Obtain alternate connections to alternate object databases (if any).
(package private) java.util.Collection<java.lang.String>	getPackNames() Obtain the list of available packs (if any).
(package private) URIish	getURI()
private Ref.Storage	loose(Ref r)
private void	mkdir_p(java.lang.String path)
(package private) WalkRemoteObjectDatabase.FileStream	open(java.lang.String path) Open a single file for reading.
(package private) WalkRemoteObjectDatabase	openAlternate(java.lang.String location) Create a new connection for a discovered alternate object database
(package private) java.util.Map<java.lang.String,Ref>	readAdvertisedRefs()
private void	readLooseRefs(java.util.TreeMap<java.lang.String,Ref> avail, java.lang.String dir, java.lang.String prefix)
private Ref	readRef(java.util.TreeMap<java.lang.String,Ref> avail, java.lang.String path, java.lang.String name)
(package private) void	writeFile(java.lang.String path, byte[] data) Atomically write a remote file.
(package private) java.io.OutputStream	writeFile(java.lang.String path, ProgressMonitor monitor, java.lang.String monitorTask) Open a remote file for writing.

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

deleteRef, deleteRefLog, openReader, readAlternates, readPackedRefs, writeInfoPacks, writeRef

Methods inherited from class java.lang.Object

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

Field Detail

objectsPath

private final java.lang.String objectsPath

ftp

private com.jcraft.jsch.ChannelSftp ftp

Constructor Detail

SftpObjectDB

SftpObjectDB(java.lang.String path)
      throws TransportException

Throws:

TransportException

SftpObjectDB

SftpObjectDB(TransportSftp.SftpObjectDB parent,
             java.lang.String p)
      throws TransportException

Throws:

TransportException

Method Detail

getURI

URIish getURI()

Specified by:

getURI in class WalkRemoteObjectDatabase

getAlternates

java.util.Collection<WalkRemoteObjectDatabase> getAlternates()
                                                      throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Obtain alternate connections to alternate object databases (if any).

Alternates are typically read from the file WalkRemoteObjectDatabase.INFO_ALTERNATES or WalkRemoteObjectDatabase.INFO_HTTP_ALTERNATES. The content of each line must be resolved by the implementation and a new database reference should be returned to represent the additional location.

Alternates may reuse the same network connection handle, however the fetch connection will WalkRemoteObjectDatabase.close() each created alternate.

Specified by:

getAlternates in class WalkRemoteObjectDatabase

Returns:

list of additional object databases the caller could fetch from; null or empty list if none are configured.

Throws:

java.io.IOException - The connection is unable to read the remote repository's list of configured alternates.

openAlternate

WalkRemoteObjectDatabase openAlternate(java.lang.String location)
                                throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Create a new connection for a discovered alternate object database

This method is typically called by WalkRemoteObjectDatabase.readAlternates(String) when subclasses us the generic alternate parsing logic for their implementation of WalkRemoteObjectDatabase.getAlternates().

Specified by:

openAlternate in class WalkRemoteObjectDatabase

Parameters:

location - the location of the new alternate, relative to the current object database.

Returns:

a new database connection that can read from the specified alternate.

Throws:

java.io.IOException - The database connection cannot be established with the alternate, such as if the alternate location does not actually exist and the connection's constructor attempts to verify that.

getPackNames

java.util.Collection<java.lang.String> getPackNames()
                                             throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Obtain the list of available packs (if any).

Pack names should be the file name in the packs directory, that is pack-035760ab452d6eebd123add421f253ce7682355a.pack. Index names should not be included in the returned collection.

Specified by:

getPackNames in class WalkRemoteObjectDatabase

Returns:

list of pack names; null or empty list if none are available.

Throws:

java.io.IOException - The connection is unable to read the remote repository's list of available pack files.

open

WalkRemoteObjectDatabase.FileStream open(java.lang.String path)
                                  throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Open a single file for reading.

Implementors should make every attempt possible to ensure FileNotFoundException is used when the remote object does not exist. However when fetching over HTTP some misconfigured servers may generate a 200 OK status message (rather than a 404 Not Found) with an HTML formatted message explaining the requested resource does not exist. Callers such as WalkFetchConnection are prepared to handle this by validating the content received, and assuming content that fails to match its hash is an incorrectly phrased FileNotFoundException.

This method is recommended for already compressed files like loose objects and pack files. For text files, see WalkRemoteObjectDatabase.openReader(String).

Specified by:

open in class WalkRemoteObjectDatabase

Parameters:

path - location of the file to read, relative to this objects directory (e.g. cb/95df6ab7ae9e57571511ef451cf33767c26dd2 or pack/pack-035760ab452d6eebd123add421f253ce7682355a.pack).

Returns:

a stream to read from the file. Never null.

Throws:

java.io.FileNotFoundException - the requested file does not exist at the given location.

java.io.IOException - The connection is unable to read the remote's file, and the failure occurred prior to being able to determine if the file exists, or after it was determined to exist but before the stream could be created.

deleteFile

void deleteFile(java.lang.String path)
         throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Delete a file from the object database.

Path may start with ../ to request deletion of a file that resides in the repository itself.

When possible empty directories must be removed, up to but not including the current object database directory itself.

This method does not support deletion of directories.

Overrides:

deleteFile in class WalkRemoteObjectDatabase

Parameters:

path - name of the item to be removed, relative to the current object database.

Throws:

java.io.IOException - deletion is not supported, or deletion failed.

writeFile

java.io.OutputStream writeFile(java.lang.String path,
                               ProgressMonitor monitor,
                               java.lang.String monitorTask)
                        throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Open a remote file for writing.

Path may start with ../ to request writing of a file that resides in the repository itself.

The requested path may or may not exist. If the path already exists as a file the file should be truncated and completely replaced.

This method creates any missing parent directories, if necessary.

Overrides:

writeFile in class WalkRemoteObjectDatabase

Parameters:

path - name of the file to write, relative to the current object database.

monitor - (optional) progress monitor to post write completion to during the stream's close method.

monitorTask - (optional) task name to display during the close method.

Returns:

stream to write into this file. Caller must close the stream to complete the write request. The stream is not buffered and each write may cause a network request/response so callers should buffer to smooth out small writes.

Throws:

java.io.IOException - writing is not supported, or attempting to write the file failed, possibly due to permissions or remote disk full, etc.

writeFile

void writeFile(java.lang.String path,
               byte[] data)
        throws java.io.IOException

Description copied from class: WalkRemoteObjectDatabase

Atomically write a remote file.

This method attempts to perform as atomic of an update as it can, reducing (or eliminating) the time that clients might be able to see partial file content. This method is not suitable for very large transfers as the complete content must be passed as an argument.

Path may start with ../ to request writing of a file that resides in the repository itself.

The requested path may or may not exist. If the path already exists as a file the file should be truncated and completely replaced.

This method creates any missing parent directories, if necessary.

Overrides:

writeFile in class WalkRemoteObjectDatabase

Parameters:

path - name of the file to write, relative to the current object database.

data - complete new content of the file.

Throws:

java.io.IOException - writing is not supported, or attempting to write the file failed, possibly due to permissions or remote disk full, etc.

mkdir_p

private void mkdir_p(java.lang.String path)
              throws java.io.IOException

Throws:

java.io.IOException

readAdvertisedRefs

java.util.Map<java.lang.String,Ref> readAdvertisedRefs()
                                                throws TransportException

Throws:

TransportException

readLooseRefs

private void readLooseRefs(java.util.TreeMap<java.lang.String,Ref> avail,
                           java.lang.String dir,
                           java.lang.String prefix)
                    throws TransportException

Throws:

TransportException

readRef

private Ref readRef(java.util.TreeMap<java.lang.String,Ref> avail,
                    java.lang.String path,
                    java.lang.String name)
             throws TransportException

Throws:

TransportException

loose

private Ref.Storage loose(Ref r)

close

void close()

Description copied from class: WalkRemoteObjectDatabase

Close any resources used by this connection.

If the remote repository is contacted by a network socket this method must close that network socket, disconnecting the two peers. If the remote repository is actually local (same system) this method must close any open file handles used to read the "remote" repository.

Specified by:

close in class WalkRemoteObjectDatabase