org.apache.maven.wagon.providers.http

Class HttpWagon

Implemented Interfaces:
Wagon

public class HttpWagon
extends AbstractWagon

Version:
$Id: HttpWagon.java 485099 2006-12-10 00:20:09Z joakime $
Author:
Michal Maczka

Field Summary

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

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

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

ROLE

Method Summary

void
closeConnection()
void
get(String resourceName, File destination)
Downloads specified resource from the repository to given file.
boolean
get(String resourceName, File destination, long timestamp)
List
getFileList(String destinationDirectory)
Returns a List of strings naming the files and directories in the directory denoted by this abstract pathname.
boolean
getIfNewer(String resourceName, File destination, long timestamp)
Downloads specified resource from the repository if it was modfified since specified date.
int
getNumberOfAttempts()
void
openConnection()
void
put(File source, String resourceName)
Copy a file from local system to remote
boolean
resourceExists(String resourceName)
Check if a remote resource exists
void
setNumberOfAttempts(int numberOfAttempts)

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

addSessionListener, addTransferListener, closeConnection, connect, connect, connect, connect, createParentDirectories, createZip, disconnect, fireGetCompleted, fireGetInitiated, fireGetStarted, firePutCompleted, firePutInitiated, firePutStarted, fireSessionConnectionRefused, fireSessionDebug, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferDebug, fireTransferError, fireTransferProgress, getAuthenticationInfo, getFileList, getPath, getProxyInfo, getRepository, getSessionEventSupport, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, postProcessListeners, putDirectory, putTransfer, removeSessionListener, removeTransferListener, resourceExists, setInteractive, setSessionEventSupport, setTransferEventSupport, supportsDirectoryCopy, transfer, transfer, transfer

Method Details

closeConnection

public void closeConnection()
Overrides:
closeConnection in interface AbstractWagon

get

public void get(String resourceName,
                File destination)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Downloads specified resource from the repository to given file.
Specified by:
get in interface Wagon
Parameters:
resourceName -
destination -

get

public boolean get(String resourceName,
                   File destination,
                   long timestamp)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Parameters:
resourceName -
destination -
timestamp - the timestamp to check against, only downloading if newer. If 0, always download
Returns:
true if newer version was downloaded, false otherwise.

getFileList

public List getFileList(String destinationDirectory)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Returns a List of strings naming the files and directories in the directory denoted by this abstract pathname.

If this abstract pathname does not denote a directory, or does not exist, then this method throws ResourceDoesNotExistException. Otherwise a List of strings is returned, one for each file or directory in the directory. Names denoting the directory itself and the directory's parent directory are not included in the result. Each string is a file name rather than a complete path.

There is no guarantee that the name strings in the resulting list will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.

Specified by:
getFileList in interface Wagon
Overrides:
getFileList in interface AbstractWagon
Parameters:
destinationDirectory - directory to list contents of
Returns:
A List of strings naming the files and directories in the directory denoted by this abstract pathname. The List will be empty if the directory is empty.
Throws:
TransferFailedException - if there's an error trying to access the remote side
ResourceDoesNotExistException - if destinationDirectory does not exist or is not a directory
AuthorizationException - if not authorized to list the contents of the directory

getIfNewer

public boolean getIfNewer(String resourceName,
                          File destination,
                          long timestamp)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Downloads specified resource from the repository if it was modfified since specified date. The date is measured in milliseconds, between the current time and midnight, January 1, 1970 UTC and aliged to GMT timezone.
Specified by:
getIfNewer in interface Wagon
Parameters:
resourceName -
destination -
timestamp -
Returns:
true if newer resource has been downloaded, false if resource in the repository is older or has the same age.

getNumberOfAttempts

public int getNumberOfAttempts()

openConnection

public void openConnection()
Specified by:
openConnection in interface Wagon

put

public void put(File source,
                String resourceName)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Copy a file from local system to remote
Specified by:
put in interface Wagon
Parameters:
source - the local file

resourceExists

public boolean resourceExists(String resourceName)
            throws TransferFailedException,
                   AuthorizationException
Check if a remote resource exists
Specified by:
resourceExists in interface Wagon
Overrides:
resourceExists in interface AbstractWagon
Parameters:
resourceName -
Returns:
whether the resource exists or not
Throws:
TransferFailedException - if there's an error trying to access the remote side
AuthorizationException - if not authorized to verify the existence of the resource

setNumberOfAttempts

public void setNumberOfAttempts(int numberOfAttempts)