org.gradle.api.artifacts.repositories

Interface IvyArtifactRepository

All Superinterfaces:

ArtifactRepository, AuthenticationSupported

public interface IvyArtifactRepository
extends ArtifactRepository, AuthenticationSupported

An artifact repository which uses an Ivy format to store artifacts and meta-data.

When used to resolve metadata and artifact files, all available patterns will be searched.

When used to upload metadata and artifact files, only a single, primary pattern will be used:

1. If a URL is specified via setUrl(java.lang.Object) then that URL will be used for upload, combined with the applied layout(String).
2. If no URL has been specified but additional patterns have been added via artifactPattern(java.lang.String) or ivyPattern(java.lang.String), then the first defined pattern will be used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRADLE_ARTIFACT_PATTERN
static String	GRADLE_IVY_PATTERN
static String	IVY_ARTIFACT_PATTERN
static String	MAVEN_ARTIFACT_PATTERN
static String	MAVEN_IVY_PATTERN

Method Summary

Methods

Modifier and Type	Method and Description
void	artifactPattern(String pattern) Adds an independent pattern that will be used to locate artifact files in this repository.
IvyArtifactRepositoryMetaDataProvider	getResolve() Returns the meta-data provider used when resolving artifacts from this repository.
URI	getUrl() The base URL of this repository.
void	ivyPattern(String pattern) Adds an independent pattern that will be used 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 how the items of the repository are organized.
void	setUrl(Object url) Sets the base URL of this repository.

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

getName, setName

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

credentials, getCredentials

Field Detail

IVY_ARTIFACT_PATTERN

static final String IVY_ARTIFACT_PATTERN

See Also:

Constant Field Values

GRADLE_ARTIFACT_PATTERN

static final String GRADLE_ARTIFACT_PATTERN

See Also:

Constant Field Values

GRADLE_IVY_PATTERN

static final String GRADLE_IVY_PATTERN

See Also:

Constant Field Values

MAVEN_ARTIFACT_PATTERN

static final String MAVEN_ARTIFACT_PATTERN

See Also:

Constant Field Values

MAVEN_IVY_PATTERN

static final String MAVEN_IVY_PATTERN

See Also:

Constant Field Values

Method Detail

getUrl

URI getUrl()

The base URL of this repository.

Returns:

The URL.

setUrl

void setUrl(Object url)

Sets the base URL of this repository. The provided value is evaluated as per 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 layout(String, Closure) for this repository.

Parameters:

url - The base URL.

artifactPattern

void artifactPattern(String pattern)

Adds an independent pattern that will be used to locate artifact files in this repository. This pattern will be used to locate ivy files as well, unless a specific ivy pattern is supplied via ivyPattern(String). If this pattern is not a fully-qualified URL, it will be interpreted as a file relative to the project directory. It is not interpreted relative the the URL specified in setUrl(Object). Patterns added in this way will be in addition to any layout-based patterns added via setUrl(java.lang.Object).

Parameters:

pattern - The artifact pattern.

ivyPattern

void ivyPattern(String pattern)

Adds an independent pattern that will be used to locate ivy files in this repository. If this pattern is not a fully-qualified URL, it will be interpreted as a file relative to the project directory. It is not interpreted relative the the URL specified in setUrl(Object). Patterns added in this way will be in addition to any layout-based patterns added via setUrl(java.lang.Object).

Parameters:

pattern - The ivy pattern.

layout

void layout(String layoutName)

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

Parameters:

layoutName - The name of the layout to use.

layout

void layout(String layoutName,
          Closure config)

Specifies how the items of the repository are organized.

The layout is configured with the supplied closure.

Recognised values are as follows:

'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 '/'.

'ivy'

A Repository Layout that applies the following patterns:

• Artifacts: $baseUri/"[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"
• Ivy: $baseUri/"[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"

Note: this pattern is currently incubating.

'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'
         }
     }
 }
 

Parameters:

layoutName - The name of the layout to use.

config - The closure used to configure the layout.

getResolve

@Incubating
IvyArtifactRepositoryMetaDataProvider getResolve()

Returns the meta-data provider used when resolving artifacts from this repository. The provider is responsible for locating and interpreting the meta-data for the modules and artifacts contained in this repository. Using this provider, you can fine tune how this resolution happens.

Returns:

The meta-data provider for this repository.