net.trajano.wagon.git.internal

Class AbstractGitWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.StreamWagon

net.trajano.wagon.git.internal.AbstractGitWagon

All Implemented Interfaces:

org.apache.maven.wagon.StreamingWagon, org.apache.maven.wagon.Wagon

Direct Known Subclasses:

GitHubPagesWagon, GitWagon

public abstract class AbstractGitWagon
extends org.apache.maven.wagon.StreamWagon

Common parts of handling Git based repositories.

Field Summary

Fields inherited from class org.apache.maven.wagon.AbstractWagon

authenticationInfo, DEFAULT_BUFFER_SIZE, interactive, proxyInfo, repository, sessionEventSupport, transferEventSupport

Fields inherited from interface org.apache.maven.wagon.Wagon

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGitWagon()

Method Summary

Methods

Modifier and Type	Method and Description
abstract GitUri	buildGitUri(URI repositoryUrl) Builds the wagon specific Git URI based on the repository URL.
void	closeConnection() This will commit the local changes and push them to the repository.
void	fillInputData(org.apache.maven.wagon.InputData inputData) This will read from the working copy.
void	fillOutputData(org.apache.maven.wagon.OutputData outputData) This will write to the working copy.
protected abstract File	getFileForResource(String resourceName) This will get the file object for the given resource relative to the Git specified for the connection.
List<String>	getFileList(String directory)
protected org.eclipse.jgit.api.Git	getGit(String gitRepositoryUri) This will create or refresh the working copy.
protected GitUri	getGitUri()
protected void	openConnectionInternal() Sets the initial git URI.
void	putDirectory(File sourceDirectory, String destinationDirectory) If the destination directory is not inside the source directory (denoted by starting with "../"), then another git repository is registered.
boolean	resourceExists(String resourceName)
boolean	supportsDirectoryCopy() Directory copy is supported.

Methods inherited from class org.apache.maven.wagon.StreamWagon

checkInputStream, checkOutputStream, get, getIfNewer, getIfNewerToStream, getInputStream, getOutputStream, getToStream, put, putFromStream, putFromStream, putFromStream

Methods inherited from class org.apache.maven.wagon.AbstractWagon

addSessionListener, addTransferListener, cleanupGetTransfer, cleanupPutTransfer, connect, connect, connect, connect, connect, connect, createParentDirectories, disconnect, finishGetTransfer, finishPutTransfer, fireGetCompleted, fireGetInitiated, fireGetStarted, firePutCompleted, firePutInitiated, firePutStarted, fireSessionConnectionRefused, fireSessionDebug, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferDebug, fireTransferError, fireTransferProgress, getAuthenticationInfo, getPath, getPermissionsOverride, getProxyInfo, getProxyInfo, getReadTimeout, getRepository, getSessionEventSupport, getTimeout, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, openConnection, postProcessListeners, putTransfer, putTransfer, removeSessionListener, removeTransferListener, setInteractive, setPermissionsOverride, setReadTimeout, setSessionEventSupport, setTimeout, setTransferEventSupport, transfer, transfer, transfer, transfer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.wagon.Wagon

addSessionListener, addTransferListener, connect, connect, connect, connect, connect, connect, disconnect, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, isInteractive, openConnection, removeSessionListener, removeTransferListener, setInteractive, setReadTimeout, setTimeout

Constructor Detail

AbstractGitWagon

public AbstractGitWagon()

Method Detail

buildGitUri

public abstract GitUri buildGitUri(URI repositoryUrl)
                            throws IOException,
                                   URISyntaxException

Builds the wagon specific Git URI based on the repository URL. This is made public rather than protected to allow testing of the method.

Parameters:

repositoryUrl - repository URL

Returns:

Git URI

Throws:

IOException

URISyntaxException

closeConnection

public void closeConnection()
                     throws org.apache.maven.wagon.ConnectionException

This will commit the local changes and push them to the repository. If the method is unable to push to the repository without force, it will throw an exception.

Specified by:

closeConnection in class org.apache.maven.wagon.StreamWagon

Throws:

org.apache.maven.wagon.ConnectionException

fillInputData

public void fillInputData(org.apache.maven.wagon.InputData inputData)
                   throws org.apache.maven.wagon.TransferFailedException,
                          org.apache.maven.wagon.ResourceDoesNotExistException,
                          org.apache.maven.wagon.authorization.AuthorizationException

This will read from the working copy. File modification date would not be available as it does not really have any meaningful value.

Specified by:

fillInputData in class org.apache.maven.wagon.StreamWagon

Throws:

org.apache.maven.wagon.ResourceDoesNotExistException - when the file does not exist

org.apache.maven.wagon.authorization.AuthorizationException - when the file cannot be read

org.apache.maven.wagon.TransferFailedException

fillOutputData

public void fillOutputData(org.apache.maven.wagon.OutputData outputData)
                    throws org.apache.maven.wagon.TransferFailedException

This will write to the working copy.

Specified by:

fillOutputData in class org.apache.maven.wagon.StreamWagon

Throws:

org.apache.maven.wagon.TransferFailedException

getFileForResource

protected abstract File getFileForResource(String resourceName)
                                    throws org.eclipse.jgit.api.errors.GitAPIException,
                                           IOException,
                                           URISyntaxException

This will get the file object for the given resource relative to the Git specified for the connection. It will handle resources where it jumps up past the parent folder.

Parameters:

resourceName - resource name.

Returns:

file used for the resource.

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException - problem with the GIT API.

URISyntaxException

org.apache.maven.wagon.ResourceDoesNotExistException

getFileList

public List<String> getFileList(String directory)
                         throws org.apache.maven.wagon.TransferFailedException,
                                org.apache.maven.wagon.ResourceDoesNotExistException,
                                org.apache.maven.wagon.authorization.AuthorizationException

Warnings are suppressed for false positive with Sonar and multiple exceptions on public API.

Specified by:

getFileList in interface org.apache.maven.wagon.Wagon

Overrides:

getFileList in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

org.apache.maven.wagon.authorization.AuthorizationException

getGit

protected org.eclipse.jgit.api.Git getGit(String gitRepositoryUri)
                                   throws org.eclipse.jgit.api.errors.GitAPIException,
                                          IOException,
                                          URISyntaxException,
                                          org.apache.maven.wagon.ResourceDoesNotExistException

This will create or refresh the working copy. If the working copy cannot be pulled cleanly this method will fail.

Parameters:

gitRepositoryUri - remote git repository URI string

Returns:

git

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

URISyntaxException

org.apache.maven.wagon.ResourceDoesNotExistException

getGitUri

protected GitUri getGitUri()

openConnectionInternal

protected void openConnectionInternal()
                               throws org.apache.maven.wagon.ConnectionException,
                                      org.apache.maven.wagon.authentication.AuthenticationException

Sets the initial git URI.

Specified by:

openConnectionInternal in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.ConnectionException

org.apache.maven.wagon.authentication.AuthenticationException

putDirectory

public void putDirectory(File sourceDirectory,
                String destinationDirectory)
                  throws org.apache.maven.wagon.TransferFailedException,
                         org.apache.maven.wagon.ResourceDoesNotExistException,
                         org.apache.maven.wagon.authorization.AuthorizationException

If the destination directory is not inside the source directory (denoted by starting with "../"), then another git repository is registered. Warnings are suppressed for false positive with Sonar and multiple exceptions on public API.

Specified by:

putDirectory in interface org.apache.maven.wagon.Wagon

Overrides:

putDirectory in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

org.apache.maven.wagon.authorization.AuthorizationException

resourceExists

public boolean resourceExists(String resourceName)
                       throws org.apache.maven.wagon.TransferFailedException

Specified by:

resourceExists in interface org.apache.maven.wagon.Wagon

Overrides:

resourceExists in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

supportsDirectoryCopy

public boolean supportsDirectoryCopy()

Directory copy is supported.

Specified by:

supportsDirectoryCopy in interface org.apache.maven.wagon.Wagon

Overrides:

supportsDirectoryCopy in class org.apache.maven.wagon.AbstractWagon

Returns:

true