AbstractHttpClientWagon (Apache Maven Wagon :: Providers

java.lang.Object
- org.apache.maven.wagon.AbstractWagon
- - org.apache.maven.wagon.StreamWagon
  - - org.apache.maven.wagon.providers.http.AbstractHttpClientWagon

All Implemented Interfaces:

StreamingWagon, Wagon

Direct Known Subclasses:

HttpWagon
```
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, DEFAULT_BUFFER_SIZE, interactive, proxyInfo, repository, sessionEventSupport, transferEventSupport
- Fields inherited from interface org.apache.maven.wagon.Wagon
  DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, ROLE

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

Constructor Summary

Constructors
Constructor and Description

AbstractHttpClientWagon()

Constructors
Constructor and Description
`AbstractHttpClientWagon()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`backoff(int wait, String url)`
`protected String`	`calculateRelocatedUrl(org.apache.http.HttpResponse response)`
`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)`
`HttpConfiguration`	`getHttpConfiguration()`
`Properties`	`getHttpHeaders()`
`int`	`getInitialBackoffSeconds()`
`static int`	`getMaxBackoffWaitSeconds()`
`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)`
`protected void`	`putFromStream(InputStream stream, Resource resource)`
`void`	`putFromStream(InputStream stream, String destination)`
`void`	`putFromStream(InputStream stream, String destination, long contentLength, long lastModified)`
`boolean`	`resourceExists(String resourceName)`
`protected void`	`setHeaders(org.apache.http.client.methods.HttpUriRequest method)`
`void`	`setHttpConfiguration(HttpConfiguration httpConfiguration)`
`void`	`setHttpHeaders(Properties httpHeaders)`
`void`	`setInitialBackoffSeconds(int initialBackoffSeconds)`

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

put

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

Specified by:: put in interface Wagon
Overrides:: put in class StreamWagon
Throws:: TransferFailedException; ResourceDoesNotExistException; AuthorizationException

putFromStream

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

Specified by:: putFromStream in interface StreamingWagon
Overrides:: putFromStream in class StreamWagon
Throws:: TransferFailedException; ResourceDoesNotExistException; AuthorizationException

calculateRelocatedUrl

protected String calculateRelocatedUrl(org.apache.http.HttpResponse response)

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

Specified by:: resourceExists in interface Wagon
Overrides:: resourceExists in class AbstractWagon
Throws:: TransferFailedException; AuthorizationException

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

protected 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)

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

getInitialBackoffSeconds
```
public int getInitialBackoffSeconds()
```

setInitialBackoffSeconds

public void setInitialBackoffSeconds(int initialBackoffSeconds)

getMaxBackoffWaitSeconds

public static int getMaxBackoffWaitSeconds()

Class AbstractHttpClientWagon

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SC_TOO_MANY_REQUESTS

Constructor Detail

AbstractHttpClientWagon

Method Detail

backoff

openConnectionInternal

closeConnection

put

putFromStream

calculateRelocatedUrl

mkdirs

resourceExists

execute

setHeaders

getUserAgent

getURL

getHttpConfiguration

setHttpConfiguration

fillInputData

cleanupGetTransfer

putFromStream

putFromStream

getHttpHeaders

setHttpHeaders

fillOutputData

getInitialBackoffSeconds

setInitialBackoffSeconds

getMaxBackoffWaitSeconds