org.apache.maven.wagon.providers.webdav

Class WebDavWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.StreamWagon

org.apache.maven.wagon.shared.http.AbstractHttpClientWagon

org.apache.maven.wagon.providers.webdav.WebDavWagon

All Implemented Interfaces:

StreamingWagon, Wagon

public class WebDavWagon
extends AbstractHttpClientWagon

WebDavWagon

Allows using a WebDAV remote repository for downloads and deployments

Author:

Henry Isidro, Joakim Erdfelt, Carlos Sanchez, James William Dumay

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONTINUE_ON_FAILURE_PROPERTY

Fields inherited from class org.apache.maven.wagon.shared.http.AbstractHttpClientWagon

SC_TOO_MANY_REQUESTS

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

authenticationInfo, BUFFER_SEGMENT_SIZE, DEFAULT_BUFFER_SIZE, interactive, MAXIMUM_BUFFER_SIZE, MINIMUM_AMOUNT_OF_TRANSFER_CHUNKS, 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
WebDavWagon()

Method Summary

Modifier and Type	Method and Description
List<String>	getFileList(String destinationDirectory) Returns a List of strings naming the files and directories in the directory denoted by this abstract pathname.
String	getURL(Repository repository) getUrl Implementors can override this to remove unwanted parts of the url such as role-hints
protected void	mkdirs(String dir) Create directories in server as needed.
void	put(File source, String resourceName) Copy a file from local system to remote
void	putDirectory(File sourceDirectory, String destinationDirectory) Copy a directory from local system to remote WebDAV server
boolean	supportsDirectoryCopy() This wagon supports directory copying

Methods inherited from class org.apache.maven.wagon.shared.http.AbstractHttpClientWagon

backoff, cleanupGetTransfer, closeConnection, execute, fillInputData, fillOutputData, getAuthCache, getBasicAuthScope, getCredentialsProvider, getHttpClient, getHttpConfiguration, getHttpHeaders, getInitialBackoffSeconds, getMaxBackoffWaitSeconds, getProxyBasicAuthScope, getUserAgent, openConnectionInternal, putFromStream, putFromStream, putFromStream, resourceExists, setBasicAuthScope, setHeaders, setHttpConfiguration, setHttpHeaders, setInitialBackoffSeconds, setPersistentPool, setPoolingHttpClientConnectionManager, setProxyBasicAuthScope

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

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

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

addSessionListener, addTransferListener, 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, getBufferCapacityForTransfer, 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

Field Detail

CONTINUE_ON_FAILURE_PROPERTY

protected static final String CONTINUE_ON_FAILURE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

WebDavWagon

public WebDavWagon()

Method Detail

supportsDirectoryCopy

public boolean supportsDirectoryCopy()

This wagon supports directory copying

Specified by:

supportsDirectoryCopy in interface Wagon

Overrides:

supportsDirectoryCopy in class AbstractWagon

Returns:

true always

mkdirs

protected void mkdirs(String dir)
               throws IOException

Create directories in server as needed. They are created one at a time until the whole path exists.

Overrides:

mkdirs in class AbstractHttpClientWagon

Parameters:

dir - path to be created in server from repository basedir

Throws:

IOException

TransferFailedException

putDirectory

public void putDirectory(File sourceDirectory,
                         String destinationDirectory)
                  throws TransferFailedException,
                         ResourceDoesNotExistException,
                         AuthorizationException

Copy a directory from local system to remote WebDAV server

Specified by:

putDirectory in interface Wagon

Overrides:

putDirectory in class AbstractWagon

Parameters:

sourceDirectory - the local directory

destinationDirectory - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

getFileList

public List<String> getFileList(String destinationDirectory)
                         throws TransferFailedException,
                                ResourceDoesNotExistException,
                                AuthorizationException

Description copied from interface: Wagon

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 class 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

getURL

public String getURL(Repository repository)

Description copied from class: AbstractHttpClientWagon

getUrl Implementors can override this to remove unwanted parts of the url such as role-hints

Overrides:

getURL in class AbstractHttpClientWagon

Returns:

put

public void put(File source,
                String resourceName)
         throws TransferFailedException,
                ResourceDoesNotExistException,
                AuthorizationException

Description copied from interface: Wagon

Copy a file from local system to remote

Specified by:

put in interface Wagon

Overrides:

put in class AbstractHttpClientWagon

Parameters:

source - the local file

resourceName - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException