org.apache.archiva.proxy.model

Class ProxyConnector

java.lang.Object

org.apache.archiva.proxy.model.ProxyConnector

All Implemented Interfaces:

RepositoryConnector

public class ProxyConnector
extends Object
implements RepositoryConnector

This represents a connector for a repository to a remote repository that is proxied.

Constructor Summary

Constructors

Constructor and Description
ProxyConnector()

Method Summary

Modifier and Type	Method and Description
void	addPolicy(Policy policy, PolicyOption option) Adds a new policy.
void	disable() Disables this connector, if it was enabled before, otherwise does nothing.
void	enable() Enables this connector, if it was disabled before, otherwise does nothing.
List<String>	getBlacklist() Returns a list of paths that are not fetched from the remote repository.
int	getOrder() Returns a number that orders the proxy connectors numerically.
Map<Policy,PolicyOption>	getPolicies() Returns the policies that are defined
Map<String,String>	getProperties() Returns additional properties defined for this connector.
String	getProxyId() Returns the id of this proxy connector.
ManagedRepository	getSourceRepository() Returns the local repository that is connected to the remote.
RemoteRepository	getTargetRepository() Returns the remote repository that is connected to the local.
List<String>	getWhitelist() Returns a list of paths that are fetched from the remote repository, even if a parent path is in the blacklist.
boolean	isEnabled() Returns true, if this connector is enabled, otherwise false.
void	setBlacklist(List<String> blacklist) Sets the blacklist.
void	setOrder(int order) Set the order number of this proxy connector.
void	setPolicies(Map<Policy,PolicyOption> policies) Sets policies that set the behaviour of this proxy connector.
void	setProperties(Map<String,String> properties) Sets additional properties for this connector.
void	setProxyId(String proxyId) Sets the id of this proxy connector.
void	setSourceRepository(ManagedRepository sourceRepository) Sets the source repository.
void	setTargetRepository(RemoteRepository targetRepository) Sets the target repository.
void	setWhitelist(List<String> whitelist) Sets the list of paths that are proxied.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyConnector

public ProxyConnector()

Method Detail

isEnabled

public boolean isEnabled()

Description copied from interface: RepositoryConnector

Returns true, if this connector is enabled, otherwise false.

Specified by:

isEnabled in interface RepositoryConnector

Returns:

True, if enabled.

See Also:

RepositoryConnector.isEnabled()

enable

public void enable()

Description copied from interface: RepositoryConnector

Enables this connector, if it was disabled before, otherwise does nothing.

Specified by:

enable in interface RepositoryConnector

See Also:

RepositoryConnector.enable()

disable

public void disable()

Description copied from interface: RepositoryConnector

Disables this connector, if it was enabled before, otherwise does nothing.

Specified by:

disable in interface RepositoryConnector

See Also:

RepositoryConnector.disable()

getBlacklist

public List<String> getBlacklist()

Description copied from interface: RepositoryConnector

Returns a list of paths that are not fetched from the remote repository.

Specified by:

getBlacklist in interface RepositoryConnector

Returns:

A list of paths.

See Also:

RepositoryConnector.getBlacklist()

setBlacklist

public void setBlacklist(List<String> blacklist)

Sets the blacklist. The list is a string of paths.

Parameters:

blacklist - List of paths.

getSourceRepository

public ManagedRepository getSourceRepository()

Description copied from interface: RepositoryConnector

Returns the local repository that is connected to the remote.

Specified by:

getSourceRepository in interface RepositoryConnector

Returns:

The local managed repository.

See Also:

RepositoryConnector.getSourceRepository()

setSourceRepository

public void setSourceRepository(ManagedRepository sourceRepository)

Sets the source repository.

Parameters:

sourceRepository - The managed repository which is the local representation of the proxy.

getTargetRepository

public RemoteRepository getTargetRepository()

Description copied from interface: RepositoryConnector

Returns the remote repository that is connected to the local.

Specified by:

getTargetRepository in interface RepositoryConnector

Returns:

The remote repository.

See Also:

getTargetRepository()

setTargetRepository

public void setTargetRepository(RemoteRepository targetRepository)

Sets the target repository.

Parameters:

targetRepository - The remote repository, where the artifacts are downloaded from.

getWhitelist

public List<String> getWhitelist()

Description copied from interface: RepositoryConnector

Returns a list of paths that are fetched from the remote repository, even if a parent path is in the blacklist.

Specified by:

getWhitelist in interface RepositoryConnector

Returns:

The list of paths.

See Also:

getWhitelist()

setWhitelist

public void setWhitelist(List<String> whitelist)

Sets the list of paths that are proxied.

Parameters:

whitelist - List of paths.

getPolicies

public Map<Policy,PolicyOption> getPolicies()

Returns the policies that are defined

Returns:

setPolicies

public void setPolicies(Map<Policy,PolicyOption> policies)

Sets policies that set the behaviour of this proxy connector.

Parameters:

policies - A map of policies with each option.

addPolicy

public void addPolicy(Policy policy,
                      PolicyOption option)

Adds a new policy.

Parameters:

policy - The policy to add.

option - The option for the policy.

getProxyId

public String getProxyId()

Returns the id of this proxy connector.

Returns:

The id string.

setProxyId

public void setProxyId(String proxyId)

Sets the id of this proxy connector.

Parameters:

proxyId - A id string.

toString

public String toString()

Overrides:

toString in class Object

getOrder

public int getOrder()

Returns a number that orders the proxy connectors numerically.

Returns:

The order number of this connector.

setOrder

public void setOrder(int order)

Set the order number of this proxy connector.

Parameters:

order - The order number.

getProperties

public Map<String,String> getProperties()

Returns additional properties defined for this connector.

Returns:

Map of key, value pairs.

setProperties

public void setProperties(Map<String,String> properties)

Sets additional properties for this connector.

Parameters:

properties - Map of key, value pairs.