ArtifactRepository
, AuthenticationSupported
, MetadataSupplierAware
public interface IvyArtifactRepository extends ArtifactRepository, AuthenticationSupported, MetadataSupplierAware
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:
setUrl(Object)
then that URL will be used for upload, combined with the applied layout(String)
.artifactPattern(java.lang.String)
or ivyPattern(java.lang.String)
, then the first defined pattern will be used.
Repositories of this type are created by the RepositoryHandler.ivy(org.gradle.api.Action)
group of methods.
Modifier and Type | Interface | Description |
---|---|---|
static interface |
IvyArtifactRepository.MetadataSources |
Allows configuring the sources of metadata for a specific repository.
|
Modifier and Type | Field | 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 |
Modifier and Type | Method | 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 how the items of the repository are organized.
|
void |
layout(String layoutName,
Closure config) |
Deprecated.
|
void |
layout(String layoutName,
Action<? extends RepositoryLayout> config) |
Deprecated.
|
void |
metadataSources(Action<? super IvyArtifactRepository.MetadataSources> configureAction) |
Configures the metadata sources for this repository.
|
void |
patternLayout(Action<? super IvyPatternRepositoryLayout> config) |
Specifies how the items of the repository are organized.
|
void |
setMetadataSupplier(Class<? extends ComponentMetadataSupplier> rule) |
Sets a custom metadata rule, which is capable of supplying the metadata of a component (status, status scheme, changing flag)
whenever a dynamic version is requested.
|
void |
setMetadataSupplier(Class<? extends ComponentMetadataSupplier> rule,
Action<? super ActionConfiguration> configureAction) |
Sets a custom metadata rule, possibly configuring the rule.
|
void |
setUrl(Object url) |
Sets the base URL of this repository.
|
void |
setUrl(URI url) |
Sets the base URL of this repository.
|
content, getName, setName
authentication, credentials, credentials, getAuthentication, getCredentials, getCredentials
setComponentVersionsLister, setComponentVersionsLister
static final String IVY_ARTIFACT_PATTERN
static final String GRADLE_ARTIFACT_PATTERN
static final String GRADLE_IVY_PATTERN
static final String MAVEN_ARTIFACT_PATTERN
static final String MAVEN_IVY_PATTERN
URI getUrl()
void setUrl(URI url)
url
- The base URL.void setUrl(Object url)
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.url
- The base URL.void artifactPattern(String pattern)
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 URL specified in setUrl(Object)
.
Patterns added in this way will be in addition to any layout-based patterns added via setUrl(Object)
.pattern
- The artifact pattern.void ivyPattern(String pattern)
setUrl(Object)
.
Patterns added in this way will be in addition to any layout-based patterns added via setUrl(Object)
.pattern
- The ivy pattern.void layout(String layoutName)
Recognised values are as follows:
A Repository Layout that applies the following patterns:
$baseUri/"[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
$baseUri/"[organisation]/[module]/[revision]/ivy-[revision].xml"
A Repository Layout that applies the following patterns:
$baseUri/"[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
$baseUri/"[organisation]/[module]/[revision]/ivy-[revision].xml"
Following the Maven convention, the 'organisation' value is further processed by replacing '.' with '/'.
A Repository Layout that applies the following patterns:
$baseUri/"[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"
$baseUri/"[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"
layoutName
- The name of the layout to use.patternLayout(Action)
@Deprecated void layout(String layoutName, Action<? extends RepositoryLayout> config)
The layout is configured with the supplied closure.
Recognised values are as follows:
A Repository Layout that applies the following patterns:
$baseUri/"[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
$baseUri/"[organisation]/[module]/[revision]/ivy-[revision].xml"
A Repository Layout that applies the following patterns:
$baseUri/"[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
$baseUri/"[organisation]/[module]/[revision]/ivy-[revision].xml"
Following the Maven convention, the 'organisation' value is further processed by replacing '.' with '/'.
A Repository Layout that applies the following patterns:
$baseUri/"[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"
$baseUri/"[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"
Note: this pattern is currently incubating
.
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' } } }
The available pattern tokens are listed as part of Ivy's Main Concepts documentation.
layoutName
- The name of the layout to use.config
- The action used to configure the layout.@Incubating void patternLayout(Action<? super IvyPatternRepositoryLayout> config)
The layout is configured with the supplied closure.
repositories { ivy { patternLayout { artifact '[module]/[revision]/[artifact](.[ext])' ivy '[module]/[revision]/ivy.xml' } } }
The available pattern tokens are listed as part of Ivy's Main Concepts documentation.
config
- The action used to configure the layout.@Deprecated void layout(String layoutName, Closure config)
layout(String, org.gradle.api.Action)
layoutName
- The name of the layout to use.config
- The closure used to configure the layout.
An instance of RepositoryLayout
is passed as a parameter to the closure.IvyArtifactRepositoryMetaDataProvider getResolve()
@Incubating void setMetadataSupplier(Class<? extends ComponentMetadataSupplier> rule)
setMetadataSupplier
in interface MetadataSupplierAware
rule
- the class of the rule. Gradle will instantiate a new rule for each dependency which requires metadata.@Incubating void setMetadataSupplier(Class<? extends ComponentMetadataSupplier> rule, Action<? super ActionConfiguration> configureAction)
setMetadataSupplier
in interface MetadataSupplierAware
rule
- the class of the rule. Gradle will instantiate a new rule for each dependency which requires metadata.configureAction
- the action to use to configure the rule.@Incubating void metadataSources(Action<? super IvyArtifactRepository.MetadataSources> configureAction)
configureAction
- the configuration of metadata sources.