org.gradle.api.artifacts.dsl
Interface RepositoryHandler

All Superinterfaces:

DomainObjectCollection<org.apache.ivy.plugins.resolver.DependencyResolver>, Iterable<org.apache.ivy.plugins.resolver.DependencyResolver>, NamedDomainObjectCollection<org.apache.ivy.plugins.resolver.DependencyResolver>, NamedDomainObjectContainer<org.apache.ivy.plugins.resolver.DependencyResolver>, ResolverContainer, org.gradle.api.internal.artifacts.configurations.ResolverProvider

public interface RepositoryHandler
extends ResolverContainer, org.gradle.api.internal.artifacts.configurations.ResolverProvider

A RepositoryHandler manages a set of repositories, allowing repositories to be defined and queried.

DEFAULT_MAVEN_DEPLOYER_NAME

static final String DEFAULT_MAVEN_DEPLOYER_NAME

See Also:

Constant Field Values

DEFAULT_MAVEN_INSTALLER_NAME

static final String DEFAULT_MAVEN_INSTALLER_NAME

See Also:

Constant Field Values

flatDir

org.apache.ivy.plugins.resolver.FileSystemResolver flatDir(Map args)

Adds a resolver that looks into a number of directories for artifacts. The artifacts are expected to be located in the root of the specified directories. The resolver ignores any group/organization information specified in the dependency section of your build script. If you only use this kind of resolver you might specify your dependencies like ":junit:4.4" instead of "junit:junit:4.4". The following parameter are accepted as keys for the map:

Key	Description of Associated Value
name	(optional) The name of the repository. The default is a Hash value of the rootdir paths. The name is used in the console output, to point to information related to a particular repository. A name must be unique amongst a repository group.
dirs	Specifies a list of rootDirs where to look for dependencies.

Examples:

 repositories {
     flatDir name: 'libs', dirs: "$projectDir/libs"
     flatDir dirs: ["$projectDir/libs1", "$projectDir/libs2"]
 }
 

Parameters:

args -

Returns:

the added resolver

Throws:

InvalidUserDataException - In the case neither rootDir nor rootDirs is specified of if both are specified.

mavenCentral

org.apache.ivy.plugins.resolver.DependencyResolver mavenCentral(Map args)

Adds a repository which looks in the Maven central repository for dependencies. The URL used to access this repository is always ResolverContainer.MAVEN_CENTRAL_URL. The behavior of this resolver is otherwise the same as the ones added by mavenRepo(java.util.Map). The following parameter are accepted as keys for the map:

Key	Description of Associated Value
name	(optional) The name of the repository. The default is ResolverContainer.DEFAULT_MAVEN_CENTRAL_REPO_NAME is used as the name. A name must be unique amongst a repository group.
urls	A single jar repository or a collection of jar repositories. Sometimes the artifact lives in a different repository than the pom. In such a case you can specify further locations to look for an artifact. But be aware that the pom is only looked up in the root repository

Examples:

 repositories {
     mavenCentral urls: ["http://www.mycompany.com/repository1", "http://www.mycompany.com/repository2"]
     mavenCentral name: "nonDefaultName", urls: ["http://www.mycompany.com/repository"]
 }
 

Parameters:

args - A list of urls of repositories to look for artifacts only.

Returns:

the added resolver

See Also:

mavenRepo(java.util.Map)

mavenCentral

org.apache.ivy.plugins.resolver.DependencyResolver mavenCentral()

Adds a repository which looks in the Maven central repository for dependencies. The URL used to access this repository is ResolverContainer.MAVEN_CENTRAL_URL. The name of the repository is ResolverContainer.DEFAULT_MAVEN_CENTRAL_REPO_NAME.

Examples:

 repositories {
     mavenCentral()
 }
 

Returns:

the added resolver

See Also:

mavenRepo(java.util.Map), mavenCentral(java.util.Map)

mavenRepo

org.apache.ivy.plugins.resolver.DependencyResolver mavenRepo(Map args)

Adds a repository which is Maven compatible. The compatibility is in regard to layout, snapshothandling and dealing with the pom.xml. This repository can't be used for publishing in a Maven compatible way. For publishing to a Maven repository, have a look at mavenDeployer(java.util.Map) or mavenInstaller(java.util.Map). By default the repository accepts to resolve artifacts without a pom. The repository always looks first for the pom in the root repository. It then looks for the artifact in the root repository. Sometimes the artifact lives in a different repository than the pom. In such a case you can specify further locations to look for an artifact. But be aware that the pom is only looked up in the root repository. The following parameter are accepted as keys for the map:

Key	Description of Associated Value
name	(optional) The name of the repository. The default is the URL of the root repo. The name is used in the console output, to point to information related to a particular repository. A name must be unique amongst a repository group.
urls	A single repository url or a list of urls. The first url is the the url of the root repo. Gradle always looks first for the pom in the root repository. After this it looks for the artifact in the root repository. If the artifact can't be found there, it looks for it in the other repositories.

Examples:

 repositories {
     mavenRepo urls: ["http://www.mycompany.com/repository1", "http://www.mycompany.com/repository2"]
     mavenRepo name: "nonDefaultName", urls: ["http://www.mycompany.com/repository"]
 }
 

For Ivy related reasons, Maven Snapshot dependencies are only properly resolved if no additional jar locations are specified. This is unfortunate and we hope to improve this in a future release.

Parameters:

args - The argument to create the repository

Returns:

the added repository

See Also:

mavenCentral(java.util.Map)

mavenDeployer

GroovyMavenDeployer mavenDeployer()

mavenDeployer

GroovyMavenDeployer mavenDeployer(Closure configureClosure)

mavenDeployer

GroovyMavenDeployer mavenDeployer(Map args)

Adds a repository for publishing to a Maven repository. This repository can not be used for reading from a Maven repository. The following parameter are accepted as keys for the map:

Key	Description of Associated Value
name	(optional) The name of the repository. The default is mavenDeployer-{SOME_ID}. The name is used in the console output, to point to information related to a particular repository. A name must be unique amongst a repository group.

Parameters:

args - The argument to create the repository

Returns:

The added repository

See Also:

mavenDeployer(java.util.Map, groovy.lang.Closure)

mavenDeployer

GroovyMavenDeployer mavenDeployer(Map args,
                                  Closure configureClosure)

Behaves the same way as mavenDeployer(java.util.Map). Additionally a closure can be passed to further configure the added repository.

Parameters:

args - The argument to create the repository

configureClosure -

Returns:

The added repository

mavenInstaller

MavenResolver mavenInstaller()

mavenInstaller

MavenResolver mavenInstaller(Closure configureClosure)

mavenInstaller

MavenResolver mavenInstaller(Map args)

Adds a repository for installing to a local Maven cache. This repository can not be used for reading. The following parameter are accepted as keys for the map:

Key	Description of Associated Value
name	(optional) The name of the repository. The default is mavenInstaller-{SOME_ID}. The name is used in the console output, to point to information related to a particular repository. A name must be unique amongst a repository group.

Parameters:

args - The argument to create the repository

Returns:

The added repository

See Also:

(java.util.Map, groovy.lang.Closure)

mavenInstaller

MavenResolver mavenInstaller(Map args,
                             Closure configureClosure)

Behaves the same way as mavenInstaller(java.util.Map). Additionally a closure can be passed to further configure the added repository.

Parameters:

args - The argument to create the repository

configureClosure -

Returns:

The added repository