org.apache.maven.artifact.manager
Interface WagonManager

All Known Implementing Classes:

DefaultWagonManager

public interface WagonManager

Manages Wagon related operations in Maven.

Version:

$Id: WagonManager.java 634142 2008-03-06 03:37:32Z brett $

Author:

Michal Maczka

Field Summary

static String

ROLE

Method Summary

void	addAuthenticationInfo(String repositoryId, String username, String password, String privateKey, String passphrase)
void	addConfiguration(String repositoryId, org.codehaus.plexus.util.xml.Xpp3Dom configuration) Set the configuration for a repository
void	addMirror(String id, String mirrorOf, String url)
void	addPermissionInfo(String repositoryId, String filePermissions, String directoryPermissions)
void	addProxy(String protocol, String host, int port, String username, String password, String nonProxyHosts)
void	getArtifact(Artifact artifact, ArtifactRepository repository)
void	getArtifact(Artifact artifact, List remoteRepositories)
void	getArtifactMetadata(ArtifactMetadata metadata, ArtifactRepository remoteRepository, File destination, String checksumPolicy)
void	getArtifactMetadataFromDeploymentRepository(ArtifactMetadata metadata, ArtifactRepository remoteRepository, File file, String checksumPolicyWarn)
org.apache.maven.wagon.authentication.AuthenticationInfo	getAuthenticationInfo(String id)
ArtifactRepository	getMirrorRepository(ArtifactRepository repository)
org.apache.maven.wagon.proxy.ProxyInfo	getProxy(String protocol)
org.apache.maven.wagon.Wagon	getWagon(org.apache.maven.wagon.repository.Repository repository) Get a Wagon provider for the provided repository.
org.apache.maven.wagon.Wagon	getWagon(String protocol) Deprecated. prone to errors. use getWagon(Repository) instead.
boolean	isOnline()
void	putArtifact(File source, Artifact artifact, ArtifactRepository deploymentRepository)
void	putArtifactMetadata(File source, ArtifactMetadata artifactMetadata, ArtifactRepository repository)
void	registerWagons(Collection wagons, org.codehaus.plexus.PlexusContainer extensionContainer)
void	setDefaultRepositoryPermissions(org.apache.maven.wagon.repository.RepositoryPermissions permissions)
void	setDownloadMonitor(org.apache.maven.wagon.events.TransferListener downloadMonitor)
void	setInteractive(boolean interactive)
void	setOnline(boolean online)

Field Detail

ROLE

public static final String ROLE

Method Detail

getWagon

public org.apache.maven.wagon.Wagon getWagon(String protocol)
                                      throws org.apache.maven.wagon.UnsupportedProtocolException

Deprecated. prone to errors. use getWagon(Repository) instead.

Get a Wagon provider that understands the protocol passed as argument. It doesn't configure the Wagon.

Parameters:

protocol - the protocol the Wagon will handle

Returns:

the Wagon instance able to handle the protocol provided

Throws:

org.apache.maven.wagon.UnsupportedProtocolException - if there is no provider able to handle the protocol

getWagon

public org.apache.maven.wagon.Wagon getWagon(org.apache.maven.wagon.repository.Repository repository)
                                      throws org.apache.maven.wagon.UnsupportedProtocolException,
                                             WagonConfigurationException

Get a Wagon provider for the provided repository. It will configure the Wagon for that repository.

Parameters:

repository - the repository

Returns:

the Wagon instance that can be used to connect to the repository

Throws:

org.apache.maven.wagon.UnsupportedProtocolException - if there is no provider able to handle the protocol

WagonConfigurationException - if the wagon can't be configured for the repository

getArtifact

public void getArtifact(Artifact artifact,
                        List remoteRepositories)
                 throws org.apache.maven.wagon.TransferFailedException,
                        org.apache.maven.wagon.ResourceDoesNotExistException

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

getArtifact

public void getArtifact(Artifact artifact,
                        ArtifactRepository repository)
                 throws org.apache.maven.wagon.TransferFailedException,
                        org.apache.maven.wagon.ResourceDoesNotExistException

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

putArtifact

public void putArtifact(File source,
                        Artifact artifact,
                        ArtifactRepository deploymentRepository)
                 throws org.apache.maven.wagon.TransferFailedException

Throws:

org.apache.maven.wagon.TransferFailedException

putArtifactMetadata

public void putArtifactMetadata(File source,
                                ArtifactMetadata artifactMetadata,
                                ArtifactRepository repository)
                         throws org.apache.maven.wagon.TransferFailedException

Throws:

org.apache.maven.wagon.TransferFailedException

getArtifactMetadata

public void getArtifactMetadata(ArtifactMetadata metadata,
                                ArtifactRepository remoteRepository,
                                File destination,
                                String checksumPolicy)
                         throws org.apache.maven.wagon.TransferFailedException,
                                org.apache.maven.wagon.ResourceDoesNotExistException

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

getArtifactMetadataFromDeploymentRepository

public void getArtifactMetadataFromDeploymentRepository(ArtifactMetadata metadata,
                                                        ArtifactRepository remoteRepository,
                                                        File file,
                                                        String checksumPolicyWarn)
                                                 throws org.apache.maven.wagon.TransferFailedException,
                                                        org.apache.maven.wagon.ResourceDoesNotExistException

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

setOnline

public void setOnline(boolean online)

isOnline

public boolean isOnline()

addProxy

public void addProxy(String protocol,
                     String host,
                     int port,
                     String username,
                     String password,
                     String nonProxyHosts)

addAuthenticationInfo

public void addAuthenticationInfo(String repositoryId,
                                  String username,
                                  String password,
                                  String privateKey,
                                  String passphrase)

addMirror

public void addMirror(String id,
                      String mirrorOf,
                      String url)

setDownloadMonitor

public void setDownloadMonitor(org.apache.maven.wagon.events.TransferListener downloadMonitor)

addPermissionInfo

public void addPermissionInfo(String repositoryId,
                              String filePermissions,
                              String directoryPermissions)

getProxy

public org.apache.maven.wagon.proxy.ProxyInfo getProxy(String protocol)

getAuthenticationInfo

public org.apache.maven.wagon.authentication.AuthenticationInfo getAuthenticationInfo(String id)

addConfiguration

public void addConfiguration(String repositoryId,
                             org.codehaus.plexus.util.xml.Xpp3Dom configuration)

Set the configuration for a repository

Parameters:

repositoryId - id of the repository to set the configuration to

configuration - dom tree of the xml with the configuration for the Wagon

setInteractive

public void setInteractive(boolean interactive)

registerWagons

public void registerWagons(Collection wagons,
                           org.codehaus.plexus.PlexusContainer extensionContainer)

setDefaultRepositoryPermissions

public void setDefaultRepositoryPermissions(org.apache.maven.wagon.repository.RepositoryPermissions permissions)

getMirrorRepository

public ArtifactRepository getMirrorRepository(ArtifactRepository repository)