Interface IvyArtifactRepository
- All Superinterfaces:
ArtifactRepository,AuthenticationSupported,MetadataSupplierAware,UrlArtifactRepository
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:
- If a URL is specified via
setUrl(Object)then that URL will be used for upload, combined with the appliedlayout(String). - If no URL has been specified but additional patterns have been added via
artifactPattern(java.lang.String)orivyPattern(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.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceAllows configuring the sources of metadata for a specific repository. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidartifactPattern(String pattern) Adds an independent pattern that will be used to locate artifact files in this repository.Returns the current metadata sources configuration for the repository.Returns the meta-data provider used when resolving artifacts from this repository.getUrl()The base URL of this repository.voidivyPattern(String pattern) Adds an independent pattern that will be used to locate ivy files in this repository.voidSpecifies how the items of the repository are organized.voidmetadataSources(Action<? super IvyArtifactRepository.MetadataSources> configureAction) Configures the metadata sources for this repository.voidpatternLayout(Action<? super IvyPatternRepositoryLayout> config) Specifies how the items of the repository are organized.voidsetMetadataSupplier(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.voidsetMetadataSupplier(Class<? extends ComponentMetadataSupplier> rule, Action<? super ActionConfiguration> configureAction) Sets a custom metadata rule, possibly configuring the rule.voidSets the base URL of this repository.voidSets the base URL of this repository.Methods inherited from interface org.gradle.api.artifacts.repositories.ArtifactRepository
content, getName, setNameMethods inherited from interface org.gradle.api.artifacts.repositories.AuthenticationSupported
authentication, credentials, credentials, credentials, getAuthentication, getCredentials, getCredentialsMethods inherited from interface org.gradle.api.artifacts.repositories.MetadataSupplierAware
setComponentVersionsLister, setComponentVersionsListerMethods inherited from interface org.gradle.api.artifacts.repositories.UrlArtifactRepository
isAllowInsecureProtocol, setAllowInsecureProtocol
-
Field Details
-
IVY_ARTIFACT_PATTERN
- See Also:
-
GRADLE_ARTIFACT_PATTERN
- See Also:
-
GRADLE_IVY_PATTERN
- See Also:
-
MAVEN_ARTIFACT_PATTERN
- See Also:
-
MAVEN_IVY_PATTERN
- See Also:
-
-
Method Details
-
getUrl
URI getUrl()The base URL of this repository.- Specified by:
getUrlin interfaceUrlArtifactRepository- Returns:
- The URL.
-
setUrl
Sets the base URL of this repository.- Specified by:
setUrlin interfaceUrlArtifactRepository- Parameters:
url- The base URL.- Since:
- 4.0
-
setUrl
Sets the base URL of this repository. The provided value is evaluated as perProject.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 configuredlayout(String)for this repository.- Specified by:
setUrlin interfaceUrlArtifactRepository- Parameters:
url- The base URL.
-
artifactPattern
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 viaivyPattern(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 insetUrl(Object). Patterns added in this way will be in addition to any layout-based patterns added viasetUrl(Object).- Parameters:
pattern- The artifact pattern.
-
ivyPattern
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 URL specified insetUrl(Object). Patterns added in this way will be in addition to any layout-based patterns added viasetUrl(Object).- Parameters:
pattern- The ivy pattern.
-
layout
Specifies how the items of the repository are organized.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])"
- Parameters:
layoutName- The name of the layout to use.- See Also:
- Artifacts:
-
patternLayout
Specifies how the items of the repository are organized.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.
- Parameters:
config- The action used to configure the layout.- Since:
- 5.0
-
getResolve
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.
-
setMetadataSupplier
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. It can be used to provide metadata directly, instead of having to parse the Ivy descriptor.- Specified by:
setMetadataSupplierin interfaceMetadataSupplierAware- Parameters:
rule- the class of the rule. Gradle will instantiate a new rule for each dependency which requires metadata.- Since:
- 4.0
-
setMetadataSupplier
void setMetadataSupplier(Class<? extends ComponentMetadataSupplier> rule, Action<? super ActionConfiguration> configureAction) Sets a custom metadata rule, possibly configuring the rule.- Specified by:
setMetadataSupplierin interfaceMetadataSupplierAware- Parameters:
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.- Since:
- 4.0
-
metadataSources
Configures the metadata sources for this repository. This method will replace any previously configured sources of metadata.- Parameters:
configureAction- the configuration of metadata sources.- Since:
- 4.5
-
getMetadataSources
IvyArtifactRepository.MetadataSources getMetadataSources()Returns the current metadata sources configuration for the repository.- Since:
- 6.4
-