Package org.apache.maven.artifact.repository

Class MavenArtifactRepository

java.lang.Object

org.apache.maven.artifact.repository.MavenArtifactRepository

All Implemented Interfaces:

ArtifactRepository

Direct Known Subclasses:

DelegatingLocalArtifactRepository, LocalArtifactRepository

public class MavenArtifactRepository
extends java.lang.Object
implements ArtifactRepository

Abstraction of an artifact repository. Artifact repositories can be remote, local, or even build reactor or IDE workspace.

Field Summary

Fields

Modifier and Type	Field	Description
private Authentication	authentication
private java.lang.String	basedir
private java.lang.String	id
private ArtifactRepositoryLayout	layout
private java.util.List<ArtifactRepository>	mirroredRepositories
private java.lang.String	protocol
private Proxy	proxy
private ArtifactRepositoryPolicy	releases
private ArtifactRepositoryPolicy	snapshots
private java.lang.String	url

Constructor Summary

Constructors

Constructor	Description
MavenArtifactRepository()
MavenArtifactRepository(java.lang.String id, java.lang.String url, ArtifactRepositoryLayout layout, ArtifactRepositoryPolicy snapshots, ArtifactRepositoryPolicy releases)	Create a remote download repository.

Method Summary

Modifier and Type	Method	Description
private java.lang.String	basedir(java.lang.String url)	Derive the path portion of the given URL.
private static java.lang.String	decode(java.lang.String url)	Decodes the specified (portion of a) URL.
protected static <T> boolean	eq(T s1, T s2)
boolean	equals(java.lang.Object obj)
Artifact	find(Artifact artifact)
java.util.List<java.lang.String>	findVersions(Artifact artifact)	Finds the versions of the specified artifact that are available in this repository.
Authentication	getAuthentication()
java.lang.String	getBasedir()
java.lang.String	getId()
java.lang.String	getKey()
ArtifactRepositoryLayout	getLayout()
java.util.List<ArtifactRepository>	getMirroredRepositories()
java.lang.String	getProtocol()
Proxy	getProxy()
ArtifactRepositoryPolicy	getReleases()
ArtifactRepositoryPolicy	getSnapshots()
java.lang.String	getUrl()
int	hashCode()
boolean	isBlacklisted()
boolean	isProjectAware()	Indicates whether this repository is backed by actual projects.
boolean	isUniqueVersion()
java.lang.String	pathOf(Artifact artifact)
java.lang.String	pathOfLocalRepositoryMetadata(ArtifactMetadata metadata, ArtifactRepository repository)
java.lang.String	pathOfRemoteRepositoryMetadata(ArtifactMetadata artifactMetadata)
private static java.lang.String	protocol(java.lang.String url)	Return the protocol name.
void	setAuthentication(Authentication authentication)
void	setBlacklisted(boolean blackListed)
void	setId(java.lang.String id)
void	setLayout(ArtifactRepositoryLayout layout)
void	setMirroredRepositories(java.util.List<ArtifactRepository> mirroredRepositories)
void	setProxy(Proxy proxy)
void	setReleaseUpdatePolicy(ArtifactRepositoryPolicy releases)
void	setSnapshotUpdatePolicy(ArtifactRepositoryPolicy snapshots)
void	setUrl(java.lang.String url)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

private java.lang.String id

url

private java.lang.String url

basedir

private java.lang.String basedir

protocol

private java.lang.String protocol

layout

private ArtifactRepositoryLayout layout

snapshots

private ArtifactRepositoryPolicy snapshots

releases

private ArtifactRepositoryPolicy releases

authentication

private Authentication authentication

proxy

private Proxy proxy

mirroredRepositories

private java.util.List<ArtifactRepository> mirroredRepositories

Constructor Detail

MavenArtifactRepository

public MavenArtifactRepository()

MavenArtifactRepository

public MavenArtifactRepository(java.lang.String id,
                               java.lang.String url,
                               ArtifactRepositoryLayout layout,
                               ArtifactRepositoryPolicy snapshots,
                               ArtifactRepositoryPolicy releases)

Create a remote download repository.

Parameters:

id - the unique identifier of the repository

url - the URL of the repository

layout - the layout of the repository

snapshots - the policies to use for snapshots

releases - the policies to use for releases

Method Detail

pathOf

public java.lang.String pathOf(Artifact artifact)

Specified by:

pathOf in interface ArtifactRepository

pathOfRemoteRepositoryMetadata

public java.lang.String pathOfRemoteRepositoryMetadata(ArtifactMetadata artifactMetadata)

Specified by:

pathOfRemoteRepositoryMetadata in interface ArtifactRepository

pathOfLocalRepositoryMetadata

public java.lang.String pathOfLocalRepositoryMetadata(ArtifactMetadata metadata,
                                                      ArtifactRepository repository)

Specified by:

pathOfLocalRepositoryMetadata in interface ArtifactRepository

setLayout

public void setLayout(ArtifactRepositoryLayout layout)

Specified by:

setLayout in interface ArtifactRepository

getLayout

public ArtifactRepositoryLayout getLayout()

Specified by:

getLayout in interface ArtifactRepository

setSnapshotUpdatePolicy

public void setSnapshotUpdatePolicy(ArtifactRepositoryPolicy snapshots)

Specified by:

setSnapshotUpdatePolicy in interface ArtifactRepository

getSnapshots

public ArtifactRepositoryPolicy getSnapshots()

Specified by:

getSnapshots in interface ArtifactRepository

setReleaseUpdatePolicy

public void setReleaseUpdatePolicy(ArtifactRepositoryPolicy releases)

Specified by:

setReleaseUpdatePolicy in interface ArtifactRepository

getReleases

public ArtifactRepositoryPolicy getReleases()

Specified by:

getReleases in interface ArtifactRepository

getKey

public java.lang.String getKey()

Specified by:

getKey in interface ArtifactRepository

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

find

public Artifact find(Artifact artifact)

Specified by:

find in interface ArtifactRepository

findVersions

public java.util.List<java.lang.String> findVersions(Artifact artifact)

Description copied from interface: ArtifactRepository

Finds the versions of the specified artifact that are available in this repository.

Specified by:

findVersions in interface ArtifactRepository

Parameters:

artifact - The artifact whose available versions should be determined, must not be null.

Returns:

The available versions of the artifact or an empty list if none, never null.

getId

public java.lang.String getId()

Specified by:

getId in interface ArtifactRepository

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface ArtifactRepository

getBasedir

public java.lang.String getBasedir()

Specified by:

getBasedir in interface ArtifactRepository

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface ArtifactRepository

setId

public void setId(java.lang.String id)

Specified by:

setId in interface ArtifactRepository

setUrl

public void setUrl(java.lang.String url)

Specified by:

setUrl in interface ArtifactRepository

protocol

private static java.lang.String protocol(java.lang.String url)

Return the protocol name.
E.g: for input http://www.codehaus.org this method will return http

Parameters:

url - the url

Returns:

the host name

basedir

private java.lang.String basedir(java.lang.String url)

Derive the path portion of the given URL.

Parameters:

url - the repository URL

Returns:

the basedir of the repository TODO need to URL decode for spaces?

decode

private static java.lang.String decode(java.lang.String url)

Decodes the specified (portion of a) URL. Note: This decoder assumes that ISO-8859-1 is used to convert URL-encoded bytes to characters.

Parameters:

url - The URL to decode, may be null.

Returns:

The decoded URL or null if the input was null.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

eq

protected static <T> boolean eq(T s1,
                                T s2)

getAuthentication

public Authentication getAuthentication()

Specified by:

getAuthentication in interface ArtifactRepository

setAuthentication

public void setAuthentication(Authentication authentication)

Specified by:

setAuthentication in interface ArtifactRepository

getProxy

public Proxy getProxy()

Specified by:

getProxy in interface ArtifactRepository

setProxy

public void setProxy(Proxy proxy)

Specified by:

setProxy in interface ArtifactRepository

isBlacklisted

public boolean isBlacklisted()

Specified by:

isBlacklisted in interface ArtifactRepository

setBlacklisted

public void setBlacklisted(boolean blackListed)

Specified by:

setBlacklisted in interface ArtifactRepository

isUniqueVersion

public boolean isUniqueVersion()

Specified by:

isUniqueVersion in interface ArtifactRepository

isProjectAware

public boolean isProjectAware()

Description copied from interface: ArtifactRepository

Indicates whether this repository is backed by actual projects. For instance, the build reactor or IDE workspace are examples of such repositories.

Specified by:

isProjectAware in interface ArtifactRepository

Returns:

true if the repository is backed by actual projects, false otherwise.

getMirroredRepositories

public java.util.List<ArtifactRepository> getMirroredRepositories()

Specified by:

getMirroredRepositories in interface ArtifactRepository

Returns:

the repositories mirrored by the actual one

setMirroredRepositories

public void setMirroredRepositories(java.util.List<ArtifactRepository> mirroredRepositories)

Specified by:

setMirroredRepositories in interface ArtifactRepository

Parameters:

mirroredRepositories - the repositories that the actual one mirrors