org.gradle.api.internal.artifacts.repositories

Class DefaultIvyArtifactRepository

java.lang.Object

org.gradle.api.internal.artifacts.repositories.DefaultIvyArtifactRepository

All Implemented Interfaces:

ArtifactRepository, AuthenticationSupported, IvyArtifactRepository, ArtifactRepositoryInternal

public class DefaultIvyArtifactRepository
extends Object
implements IvyArtifactRepository, ArtifactRepositoryInternal

Field Summary

Fields inherited from interface org.gradle.api.artifacts.repositories.IvyArtifactRepository

GRADLE_ARTIFACT_PATTERN, GRADLE_IVY_PATTERN, MAVEN_ARTIFACT_PATTERN, MAVEN_IVY_PATTERN

Constructor Summary

Constructors

Constructor and Description
DefaultIvyArtifactRepository(FileResolver fileResolver, PasswordCredentials credentials, RepositoryTransportFactory transportFactory, LocallyAvailableResourceFinder<org.apache.ivy.core.module.id.ArtifactRevisionId> locallyAvailableResourceFinder, CachedExternalResourceIndex<String> cachedExternalResourceIndex)

Method Summary

Methods

Modifier and Type	Method and Description
void	artifactPattern(String pattern) Adds an Ivy artifact pattern to use to locate artifacts in this repository.
org.apache.ivy.plugins.resolver.DependencyResolver	createResolver()
void	credentials(Closure closure) Configure the Credentials for this repository using the supplied Closure.
PasswordCredentials	getCredentials() Provides the Credentials used to authenticate to this repository.
String	getName() Returns the name for this repository.
URI	getUrl() The base URL of this repository.
void	ivyPattern(String pattern) Adds an Ivy pattern to use to locate ivy files in this repository.
void	layout(String layoutName) Specifies the layout to use with this repository, based on the root url.
void	layout(String layoutName, Closure config) Specifies the layout to use with this repository, based on the root url.
void	setName(String name) Sets the name for this repository.
void	setUrl(Object url) Sets the base URL of this repository.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.artifacts.repositories.AuthenticationSupported

credentials, getCredentials

Constructor Detail

DefaultIvyArtifactRepository

public DefaultIvyArtifactRepository(FileResolver fileResolver,
                            PasswordCredentials credentials,
                            RepositoryTransportFactory transportFactory,
                            LocallyAvailableResourceFinder<org.apache.ivy.core.module.id.ArtifactRevisionId> locallyAvailableResourceFinder,
                            CachedExternalResourceIndex<String> cachedExternalResourceIndex)

Method Detail

createResolver

public org.apache.ivy.plugins.resolver.DependencyResolver createResolver()

Specified by:

createResolver in interface ArtifactRepositoryInternal

getName

public String getName()

Description copied from interface: ArtifactRepository

Returns the name for this repository. A name must be unique amongst a repository set. A default name is provided for the repository if none is provided.

The name is used in logging output and error reporting to point to information related to this repository.

Specified by:

getName in interface ArtifactRepository

Returns:

The name.

setName

public void setName(String name)

Description copied from interface: ArtifactRepository

Sets the name for this repository.

Specified by:

setName in interface ArtifactRepository

Parameters:

name - The name. Must not be null.

getUrl

public URI getUrl()

Description copied from interface: IvyArtifactRepository

The base URL of this repository.

Specified by:

getUrl in interface IvyArtifactRepository

Returns:

The URL.

setUrl

public void setUrl(Object url)

Description copied from interface: IvyArtifactRepository

Sets the base URL of this repository. The provided value is evaluated as for Project.uri(Object). This means, for example, you can pass in a File object or a relative path which is evaluated relative to the project directory. File are resolved based on the supplied URL and the configured IvyArtifactRepository.layout(String, Closure) for this repository.

Specified by:

setUrl in interface IvyArtifactRepository

Parameters:

url - The base URL.

artifactPattern

public void artifactPattern(String pattern)

Description copied from interface: IvyArtifactRepository

Adds an Ivy artifact pattern to use to locate artifacts in this repository. This pattern will be in addition to any layout-based patterns added via IvyArtifactRepository.setUrl(java.lang.Object).

Specified by:

artifactPattern in interface IvyArtifactRepository

Parameters:

pattern - The artifact pattern.

ivyPattern

public void ivyPattern(String pattern)

Description copied from interface: IvyArtifactRepository

Adds an Ivy pattern to use to locate ivy files in this repository. This pattern will be in addition to any layout-based patterns added via IvyArtifactRepository.setUrl(java.lang.Object).

Specified by:

ivyPattern in interface IvyArtifactRepository

Parameters:

pattern - The ivy pattern.

layout

public void layout(String layoutName)

Description copied from interface: IvyArtifactRepository

Specifies the layout to use with this repository, based on the root url. See IvyArtifactRepository.layout(String, Closure).

Specified by:

layout in interface IvyArtifactRepository

Parameters:

layoutName - The name of the layout to use.

layout

public void layout(String layoutName,
          Closure config)

Description copied from interface: IvyArtifactRepository

Specifies the layout to use with this repository, based on the root url. The returned layout is configured with the supplied closure. Available layouts are outlined below.

'gradle'

A Repository Layout that applies the following patterns:

• Artifacts: $baseUri/"[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
• Ivy: $baseUri/"[organisation]/[module]/[revision]/ivy-[revision].xml"

'maven'

A Repository Layout that applies the following patterns:

• Artifacts: $baseUri/"[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
• Ivy: $baseUri/"[organisation]/[module]/[revision]/ivy-[revision].xml"

Following the maven convention, the 'organisation' value is further processed by replacing '.' with '/'.

'pattern'

A repository layout that allows custom patterns to be defined. eg:

 repositories {
     ivy {
         layout 'pattern' , {
             artifact '[module]/[revision]/[artifact](.[ext])'
             ivy '[module]/[revision]/ivy.xml'
         }
     }
 }
 

Specified by:

layout in interface IvyArtifactRepository

Parameters:

layoutName - The name of the layout to use.

config - The closure used to configure the layout.

getCredentials

public PasswordCredentials getCredentials()

Description copied from interface: AuthenticationSupported

Provides the Credentials used to authenticate to this repository.

Specified by:

getCredentials in interface AuthenticationSupported

Returns:

The credentials

credentials

public void credentials(Closure closure)

Description copied from interface: AuthenticationSupported

Configure the Credentials for this repository using the supplied Closure.

 repositories {
     maven {
         credentials {
             username = 'joe'
             password = 'secret'
         }
     }
 }
 

Specified by:

credentials in interface AuthenticationSupported