org.apache.archiva.proxy.model

Interface RepositoryProxyHandler

All Known Implementing Classes:

DefaultRepositoryProxyHandler, MavenRepositoryProxyHandler

public interface RepositoryProxyHandler

A repository proxy handler is used to fetch remote artifacts from different remote repositories. A proxy handler is connected to one managed repository and a list of remote repositories. Repository proxies should not be confused with network proxies. Network are proxies for specific network protocols, like HTTP. A repository proxy delegates the repository requests to remote repositories and caches artifacts. If a artifact is requested for the managed repository and the artifact is not cached locally, the handler goes through the list of remotes and tries to download the artifact. If a download was successful the artifact is cached locally. The connection between managed and remote repositories is defined by list of ProxyConnector each defines a one-to-one relationship. A proxy connector defines specifics about the download behaviour:

• Policies Policy define the behaviour for different cases (errors, not available, caching lifetime).
• Black- and Whitelists are used to ban or allow certain paths on the remote repositories.

The policies and black- and whitelist are set on the ProxyConnector There may be network proxies needed to connect the remote repositories.

Method Summary

Modifier and Type	Method and Description
void	addNetworkproxy(String id, NetworkProxy networkProxy) Adds a network proxy that is used to access the remote repository.
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 managedRepository, 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.
<T extends RepositoryProxyHandler> T	getHandler(Class<T> clazz) Returns the proxy handler implementation.
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.
List<ProxyConnector>	getProxyConnectors(ManagedRepository repository) Get the List of ProxyConnector objects of the source repository.
boolean	hasProxies(ManagedRepository repository) Tests to see if the provided repository is a source repository for any ProxyConnector objects.
void	removePolicy(Policy policy) Removes a policy
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	setProxyConnectors(List<ProxyConnector> proxyConnectors)
List<RepositoryType>	supports()

Method Detail

supports

List<RepositoryType> supports()

fetchFromProxies

StorageAsset fetchFromProxies(ManagedRepository repository,
                              ArtifactReference artifact)
                       throws ProxyDownloadException

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.

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.

fetchMetadataFromProxies

ProxyFetchResult fetchMetadataFromProxies(ManagedRepository repository,
                                          String logicalPath)

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.

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

fetchFromProxies

StorageAsset fetchFromProxies(ManagedRepository managedRepository,
                              String path)

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

Parameters:

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

getProxyConnectors

List<ProxyConnector> getProxyConnectors(ManagedRepository repository)

Get the List of ProxyConnector objects of the source repository.

Parameters:

repository - the source repository to look for.

Returns:

the List of ProxyConnector objects.

hasProxies

boolean hasProxies(ManagedRepository repository)

Tests to see if the provided repository is a source repository for any ProxyConnector objects.

Parameters:

repository - the source repository to look for.

Returns:

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

setNetworkProxies

void setNetworkProxies(Map<String,NetworkProxy> networkProxies)

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

Parameters:

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

addNetworkproxy

void addNetworkproxy(String id,
                     NetworkProxy networkProxy)

Adds a network proxy that is used to access the remote repository.

Parameters:

id - The repository id

networkProxy - The network proxy to use

getNetworkProxies

Map<String,NetworkProxy> getNetworkProxies()

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

Returns:

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

getNetworkProxy

NetworkProxy getNetworkProxy(String id)

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

Parameters:

id - The remote repository id

Returns:

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

getHandler

<T extends RepositoryProxyHandler> T getHandler(Class<T> clazz)
                                         throws IllegalArgumentException

Returns the proxy handler implementation. This can be used, if the underlying implementation for a specific repository type is needed.

Type Parameters:

T - The type

Parameters:

clazz - The class to convert to

Returns:

The handler

Throws:

IllegalArgumentException

setPolicies

void setPolicies(List<Policy> policyList)

Sets the policies that this handler should validate.

Parameters:

policyList -

addPolicy

void addPolicy(Policy policy)

Adds a policy

Parameters:

policy -

removePolicy

void removePolicy(Policy policy)

Removes a policy

Parameters:

policy -

addProxyConnector

void addProxyConnector(ProxyConnector connector)

setProxyConnectors

void setProxyConnectors(List<ProxyConnector> proxyConnectors)