org.apache.maven.wagon.shared.http

Class AbstractHttpClientWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.StreamWagon

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

All Implemented Interfaces:

StreamingWagon, Wagon

Direct Known Subclasses:

HttpWagon, WebDavWagon

public abstract class AbstractHttpClientWagon
extends StreamWagon

Author:

Michal Maczka, James William Dumay

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	SC_TOO_MANY_REQUESTS See RFC6585

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
AbstractHttpClientWagon()

Method Summary

Modifier and Type	Method and Description
protected int	backoff(int wait, String url)
protected void	cleanupGetTransfer(Resource resource)
void	closeConnection()
protected org.apache.http.client.methods.CloseableHttpResponse	execute(org.apache.http.client.methods.HttpUriRequest httpMethod)
void	fillInputData(InputData inputData)
void	fillOutputData(OutputData outputData)
protected org.apache.http.client.AuthCache	getAuthCache()
BasicAuthScope	getBasicAuthScope() Get the override values for standard HttpClient AuthScope
protected org.apache.http.client.CredentialsProvider	getCredentialsProvider()
static org.apache.http.impl.client.CloseableHttpClient	getHttpClient()
HttpConfiguration	getHttpConfiguration()
Properties	getHttpHeaders()
int	getInitialBackoffSeconds()
static int	getMaxBackoffWaitSeconds()
BasicAuthScope	getProxyBasicAuthScope() Get the override values for proxy HttpClient AuthScope
protected String	getURL(Repository repository) getUrl Implementors can override this to remove unwanted parts of the url such as role-hints
protected String	getUserAgent(org.apache.http.client.methods.HttpUriRequest method)
protected void	mkdirs(String dirname)
void	openConnectionInternal()
void	put(File source, String resourceName) Copy a file from local system to remote
protected void	putFromStream(InputStream stream, Resource resource)
void	putFromStream(InputStream stream, String destination)
void	putFromStream(InputStream stream, String destination, long contentLength, long lastModified) Copy from a local input stream to remote.
boolean	resourceExists(String resourceName) Check if a remote resource exists
void	setBasicAuthScope(BasicAuthScope basicAuth) Set the override values for standard HttpClient AuthScope
void	setHeaders(org.apache.http.client.methods.HttpUriRequest method)
void	setHttpConfiguration(HttpConfiguration httpConfiguration)
void	setHttpHeaders(Properties httpHeaders)
void	setInitialBackoffSeconds(int initialBackoffSeconds)
static void	setPersistentPool(boolean persistent)
static void	setPoolingHttpClientConnectionManager(org.apache.http.impl.conn.PoolingHttpClientConnectionManager poolingHttpClientConnectionManager)
void	setProxyBasicAuthScope(BasicAuthScope proxyAuth) Set the override values for proxy HttpClient AuthScope

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, getFileList, getPath, getPermissionsOverride, getProxyInfo, getProxyInfo, getReadTimeout, getRepository, getSessionEventSupport, getTimeout, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, openConnection, postProcessListeners, putDirectory, putTransfer, putTransfer, removeSessionListener, removeTransferListener, setInteractive, setPermissionsOverride, setReadTimeout, setSessionEventSupport, setTimeout, setTransferEventSupport, supportsDirectoryCopy, 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, getFileList, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, isInteractive, openConnection, putDirectory, removeSessionListener, removeTransferListener, setInteractive, setReadTimeout, setTimeout, supportsDirectoryCopy

Field Detail

SC_TOO_MANY_REQUESTS

protected static final int SC_TOO_MANY_REQUESTS

See RFC6585

See Also:

Constant Field Values

Constructor Detail

AbstractHttpClientWagon

public AbstractHttpClientWagon()

Method Detail

backoff

protected int backoff(int wait,
                      String url)
               throws InterruptedException,
                      TransferFailedException

Throws:

InterruptedException

TransferFailedException

openConnectionInternal

public void openConnectionInternal()

Specified by:

openConnectionInternal in class AbstractWagon

closeConnection

public void closeConnection()

Specified by:

closeConnection in class StreamWagon

getHttpClient

public static org.apache.http.impl.client.CloseableHttpClient getHttpClient()

setPersistentPool

public static void setPersistentPool(boolean persistent)

setPoolingHttpClientConnectionManager

public static void setPoolingHttpClientConnectionManager(org.apache.http.impl.conn.PoolingHttpClientConnectionManager poolingHttpClientConnectionManager)

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 StreamWagon

Parameters:

source - the local file

resourceName - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

putFromStream

public void putFromStream(InputStream stream,
                          String destination,
                          long contentLength,
                          long lastModified)
                   throws TransferFailedException,
                          ResourceDoesNotExistException,
                          AuthorizationException

Description copied from interface: StreamingWagon

Copy from a local input stream to remote.

Specified by:

putFromStream in interface StreamingWagon

Overrides:

putFromStream in class StreamWagon

Parameters:

stream - the local stream

destination - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

mkdirs

protected void mkdirs(String dirname)
               throws org.apache.http.HttpException,
                      IOException

Throws:

org.apache.http.HttpException

IOException

resourceExists

public boolean resourceExists(String resourceName)
                       throws TransferFailedException,
                              AuthorizationException

Description copied from interface: Wagon

Check if a remote resource exists

Specified by:

resourceExists in interface Wagon

Overrides:

resourceExists in class AbstractWagon

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

execute

protected org.apache.http.client.methods.CloseableHttpResponse execute(org.apache.http.client.methods.HttpUriRequest httpMethod)
                                                                throws org.apache.http.HttpException,
                                                                       IOException

Throws:

org.apache.http.HttpException

IOException

setHeaders

public void setHeaders(org.apache.http.client.methods.HttpUriRequest method)

getUserAgent

protected String getUserAgent(org.apache.http.client.methods.HttpUriRequest method)

getURL

protected String getURL(Repository repository)

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

Parameters:

repository -

Returns:

getHttpConfiguration

public HttpConfiguration getHttpConfiguration()

setHttpConfiguration

public void setHttpConfiguration(HttpConfiguration httpConfiguration)

getBasicAuthScope

public BasicAuthScope getBasicAuthScope()

Get the override values for standard HttpClient AuthScope

Returns:

the basicAuth

setBasicAuthScope

public void setBasicAuthScope(BasicAuthScope basicAuth)

Set the override values for standard HttpClient AuthScope

Parameters:

basicAuth - the AuthScope to set

getProxyBasicAuthScope

public BasicAuthScope getProxyBasicAuthScope()

Get the override values for proxy HttpClient AuthScope

Returns:

the proxyAuth

setProxyBasicAuthScope

public void setProxyBasicAuthScope(BasicAuthScope proxyAuth)

Set the override values for proxy HttpClient AuthScope

Parameters:

proxyAuth - the AuthScope to set

fillInputData

public void fillInputData(InputData inputData)
                   throws TransferFailedException,
                          ResourceDoesNotExistException,
                          AuthorizationException

Specified by:

fillInputData in class StreamWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

cleanupGetTransfer

protected void cleanupGetTransfer(Resource resource)

Overrides:

cleanupGetTransfer in class AbstractWagon

putFromStream

public void putFromStream(InputStream stream,
                          String destination)
                   throws TransferFailedException,
                          ResourceDoesNotExistException,
                          AuthorizationException

Specified by:

putFromStream in interface StreamingWagon

Overrides:

putFromStream in class StreamWagon

Parameters:

stream - the local stream

destination - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

putFromStream

protected void putFromStream(InputStream stream,
                             Resource resource)
                      throws TransferFailedException,
                             AuthorizationException,
                             ResourceDoesNotExistException

Overrides:

putFromStream in class StreamWagon

Throws:

TransferFailedException

AuthorizationException

ResourceDoesNotExistException

getHttpHeaders

public Properties getHttpHeaders()

setHttpHeaders

public void setHttpHeaders(Properties httpHeaders)

fillOutputData

public void fillOutputData(OutputData outputData)
                    throws TransferFailedException

Specified by:

fillOutputData in class StreamWagon

Throws:

TransferFailedException

getCredentialsProvider

protected org.apache.http.client.CredentialsProvider getCredentialsProvider()

getAuthCache

protected org.apache.http.client.AuthCache getAuthCache()

getInitialBackoffSeconds

public int getInitialBackoffSeconds()

setInitialBackoffSeconds

public void setInitialBackoffSeconds(int initialBackoffSeconds)

getMaxBackoffWaitSeconds

public static int getMaxBackoffWaitSeconds()