org.apache.archiva.proxy

Class DefaultRepositoryProxyHandler

java.lang.Object

org.apache.archiva.proxy.DefaultRepositoryProxyHandler

All Implemented Interfaces:

RepositoryProxyHandler

Direct Known Subclasses:

MavenRepositoryProxyHandler

public abstract class DefaultRepositoryProxyHandler
extends Object
implements RepositoryProxyHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log
protected UrlFailureCache	urlFailureCache

Constructor Summary

Constructors

Constructor and Description
DefaultRepositoryProxyHandler()

Method Summary

Modifier and Type	Method and Description
protected String	addParameters(String path, RemoteRepository remoteRepository)
void	addPolicy(Policy policy) Adds a policy
void	addProxyConnector(ProxyConnector connector)
StorageAsset	fetchFromProxies(ManagedRepository repository, ArtifactReference artifact) Performs the artifact fetch operation against the target repositories of the provided source repository.
StorageAsset	fetchFromProxies(ManagedRepository repository, String path) Performs the fetch operation against the target repositories of the provided source repository by a specific path.
ProxyFetchResult	fetchMetadataFromProxies(ManagedRepository repository, String logicalPath) Performs the metadata fetch operation against the target repositories of the provided source repository.
Map<String,DownloadErrorPolicy>	getDownloadErrorPolicies()
MetadataTools	getMetadataTools()
Map<String,NetworkProxy>	getNetworkProxies() Returns a map of the defined network proxies, or a empty map, if no proxy is defined.
NetworkProxy	getNetworkProxy(String id) Returns the network proxy that is defined for the given repository id.
Map<String,PostDownloadPolicy>	getPostDownloadPolicies()
Map<String,PreDownloadPolicy>	getPreDownloadPolicies()
List<ProxyConnector>	getProxyConnectors(ManagedRepository repository) TODO: Ensure that list is correctly ordered based on configuration.
UrlFailureCache	getUrlFailureCache()
boolean	hasProxies(ManagedRepository repository) Test if the provided ManagedRepositoryContent has any proxies configured for it.
void	initialize()
void	removePolicy(Policy policy) Removes a policy
void	setArchivaConfiguration(ArchivaConfiguration archivaConfiguration)
void	setDownloadErrorPolicies(Map<String,DownloadErrorPolicy> downloadErrorPolicies)
void	setMetadataTools(MetadataTools metadataTools)
void	setNetworkProxies(Map<String,NetworkProxy> networkProxies) Sets network proxies (normally HTTP proxies) to access the remote repositories.
void	setPolicies(List<Policy> policyList) Sets the policies that this handler should validate.
void	setPostDownloadPolicies(Map<String,PostDownloadPolicy> postDownloadPolicies)
void	setPreDownloadPolicies(Map<String,PreDownloadPolicy> preDownloadPolicies)
void	setProxyConnectors(List<ProxyConnector> proxyConnectors)
void	setUrlFailureCache(UrlFailureCache urlFailureCache)
abstract List<RepositoryType>	supports()
protected StorageAsset	transferFile(ProxyConnector connector, RemoteRepository remoteRepository, String remotePath, ManagedRepository repository, StorageAsset resource, Properties requestProperties, boolean executeConsumers) Perform the transfer of the file.
protected abstract void	transferResources(ProxyConnector connector, RemoteRepository remoteRepository, StorageAsset tmpResource, StorageAsset[] checksumFiles, String url, String remotePath, StorageAsset resource, Path workingDirectory, ManagedRepository repository)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.archiva.proxy.model.RepositoryProxyHandler

addNetworkproxy, getHandler

Field Detail

log

protected org.slf4j.Logger log

urlFailureCache

@Inject
protected UrlFailureCache urlFailureCache

Constructor Detail

DefaultRepositoryProxyHandler

public DefaultRepositoryProxyHandler()

Method Detail

initialize

@PostConstruct
public void initialize()

fetchFromProxies

public StorageAsset fetchFromProxies(ManagedRepository repository,
                                     ArtifactReference artifact)
                              throws ProxyDownloadException

Description copied from interface: RepositoryProxyHandler

Performs the artifact fetch operation against the target repositories of the provided source repository.

If the artifact is found, it is downloaded and placed into the source repository filesystem.

Specified by:

fetchFromProxies in interface RepositoryProxyHandler

Parameters:

repository - the source repository to use. (must be a managed repository)

artifact - the artifact to fetch.

Returns:

the file that was obtained, or null if no content was obtained

Throws:

ProxyDownloadException - if there was a problem fetching the content from the target repositories.

fetchFromProxies

public StorageAsset fetchFromProxies(ManagedRepository repository,
                                     String path)

Description copied from interface: RepositoryProxyHandler

Performs the fetch operation against the target repositories of the provided source repository by a specific path.

Specified by:

fetchFromProxies in interface RepositoryProxyHandler

Parameters:

repository - the source repository to use. (must be a managed repository)

path - the path of the resource to fetch

Returns:

the file that was obtained, or null if no content was obtained

fetchMetadataFromProxies

public ProxyFetchResult fetchMetadataFromProxies(ManagedRepository repository,
                                                 String logicalPath)

Description copied from interface: RepositoryProxyHandler

Performs the metadata fetch operation against the target repositories of the provided source repository.

If the metadata is found, it is downloaded and placed into the source repository filesystem.

Specified by:

fetchMetadataFromProxies in interface RepositoryProxyHandler

Parameters:

repository - the source repository to use. (must be a managed repository)

logicalPath - the metadata to fetch.

Returns:

the file that was obtained, or null if no content was obtained

hasProxies

public boolean hasProxies(ManagedRepository repository)

Test if the provided ManagedRepositoryContent has any proxies configured for it.

Specified by:

hasProxies in interface RepositoryProxyHandler

Parameters:

repository -

Returns:

true if there are proxy connectors that use the provided repository as a source repository.

transferFile

protected StorageAsset transferFile(ProxyConnector connector,
                                    RemoteRepository remoteRepository,
                                    String remotePath,
                                    ManagedRepository repository,
                                    StorageAsset resource,
                                    Properties requestProperties,
                                    boolean executeConsumers)
                             throws ProxyException,
                                    NotModifiedException

Perform the transfer of the file.

Parameters:

connector - the connector configuration to use.

remoteRepository - the remote repository get the resource from.

remotePath - the path in the remote repository to the resource to get.

repository - the managed repository that will hold the file

resource - the path relative to the repository storage where the file should be downloaded to

requestProperties - the request properties to utilize for policy handling.

executeConsumers - whether to execute the consumers after proxying

Returns:

the local file that was downloaded, or null if not downloaded.

Throws:

NotFoundException - if the file was not found on the remote repository.

NotModifiedException - if the localFile was present, and the resource was present on remote repository, but the remote resource is not newer than the local File.

ProxyException - if transfer was unsuccessful.

transferResources

protected abstract void transferResources(ProxyConnector connector,
                                          RemoteRepository remoteRepository,
                                          StorageAsset tmpResource,
                                          StorageAsset[] checksumFiles,
                                          String url,
                                          String remotePath,
                                          StorageAsset resource,
                                          Path workingDirectory,
                                          ManagedRepository repository)
                                   throws ProxyException

Throws:

ProxyException

getProxyConnectors

public List<ProxyConnector> getProxyConnectors(ManagedRepository repository)

TODO: Ensure that list is correctly ordered based on configuration. See MRM-477

Specified by:

getProxyConnectors in interface RepositoryProxyHandler

Parameters:

repository -

Returns:

the List of ProxyConnector objects.

addParameters

protected String addParameters(String path,
                               RemoteRepository remoteRepository)

setArchivaConfiguration

public void setArchivaConfiguration(ArchivaConfiguration archivaConfiguration)

getMetadataTools

public MetadataTools getMetadataTools()

setMetadataTools

public void setMetadataTools(MetadataTools metadataTools)

getUrlFailureCache

public UrlFailureCache getUrlFailureCache()

setUrlFailureCache

public void setUrlFailureCache(UrlFailureCache urlFailureCache)

getPreDownloadPolicies

public Map<String,PreDownloadPolicy> getPreDownloadPolicies()

setPreDownloadPolicies

public void setPreDownloadPolicies(Map<String,PreDownloadPolicy> preDownloadPolicies)

getPostDownloadPolicies

public Map<String,PostDownloadPolicy> getPostDownloadPolicies()

setPostDownloadPolicies

public void setPostDownloadPolicies(Map<String,PostDownloadPolicy> postDownloadPolicies)

getDownloadErrorPolicies

public Map<String,DownloadErrorPolicy> getDownloadErrorPolicies()

setDownloadErrorPolicies

public void setDownloadErrorPolicies(Map<String,DownloadErrorPolicy> downloadErrorPolicies)

setNetworkProxies

public void setNetworkProxies(Map<String,NetworkProxy> networkProxies)

Description copied from interface: RepositoryProxyHandler

Sets network proxies (normally HTTP proxies) to access the remote repositories.

Specified by:

setNetworkProxies in interface RepositoryProxyHandler

Parameters:

networkProxies - A map of (repository id, network proxy) where the repository id must be the id of an existing remote repository.

getNetworkProxy

public NetworkProxy getNetworkProxy(String id)

Description copied from interface: RepositoryProxyHandler

Returns the network proxy that is defined for the given repository id.

Specified by:

getNetworkProxy in interface RepositoryProxyHandler

Parameters:

id - The remote repository id

Returns:

A network proxy or null if no one is defined for this id.

getNetworkProxies

public Map<String,NetworkProxy> getNetworkProxies()

Description copied from interface: RepositoryProxyHandler

Returns a map of the defined network proxies, or a empty map, if no proxy is defined.

Specified by:

getNetworkProxies in interface RepositoryProxyHandler

Returns:

A map (repository id, network proxy). If none is defined, a empty map is returned.

supports

public abstract List<RepositoryType> supports()

Specified by:

supports in interface RepositoryProxyHandler

setPolicies

public void setPolicies(List<Policy> policyList)

Description copied from interface: RepositoryProxyHandler

Sets the policies that this handler should validate.

Specified by:

setPolicies in interface RepositoryProxyHandler

addPolicy

public void addPolicy(Policy policy)

Description copied from interface: RepositoryProxyHandler

Adds a policy

Specified by:

addPolicy in interface RepositoryProxyHandler

removePolicy

public void removePolicy(Policy policy)

Description copied from interface: RepositoryProxyHandler

Removes a policy

Specified by:

removePolicy in interface RepositoryProxyHandler

addProxyConnector

public void addProxyConnector(ProxyConnector connector)

Specified by:

addProxyConnector in interface RepositoryProxyHandler

setProxyConnectors

public void setProxyConnectors(List<ProxyConnector> proxyConnectors)

Specified by:

setProxyConnectors in interface RepositoryProxyHandler