gradle/org.gradle.api.artifacts.repositories/IvyArtifactRepository

IvyArtifactRepository

interface IvyArtifactRepository : ArtifactRepository, UrlArtifactRepository, AuthenticationSupported, MetadataSupplierAware(source)

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 then that URL will be used for upload, combined with the applied layout.
  2. If no URL has been specified but additional patterns have been added via artifactPattern or ivyPattern, then the first defined pattern will be used.

Repositories of this type are created by the ivy group of methods.

Types

Link copied to clipboard
interface MetadataSources
Allows configuring the sources of metadata for a specific repository.

Properties

Link copied to clipboard
val GRADLE_ARTIFACT_PATTERN: String = "[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
Link copied to clipboard
val GRADLE_IVY_PATTERN: String = "[organisation]/[module]/[revision]/ivy-[revision].xml"
Link copied to clipboard
val IVY_ARTIFACT_PATTERN: String = "[organisation]/[module]/[revision]/[type]s/[artifact](.[ext])"
Link copied to clipboard
val MAVEN_ARTIFACT_PATTERN: String = "[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier])(.[ext])"
Link copied to clipboard
val MAVEN_IVY_PATTERN: String = "[organisation]/[module]/[revision]/ivy-[revision].xml"

Functions

Link copied to clipboard
abstract fun artifactPattern(pattern: String)
Adds an independent pattern that will be used to locate artifact files in this repository.
Link copied to clipboard
abstract fun authentication(action: Action<in AuthenticationContainer>)
Configures the authentication schemes for this repository.
Link copied to clipboard
abstract fun content(configureAction: Action<in RepositoryContentDescriptor>)
Configures the content of this repository.
Link copied to clipboard
abstract fun credentials(credentialsType: Class<out Credentials>)
Configures the credentials for this repository that will be provided by the build.
abstract fun credentials(action: Action<in PasswordCredentials>)
Configures the username and password credentials for this repository using the supplied action.
abstract fun <T : Credentials?> credentials(credentialsType: Class<T>, action: Action<in T>)
Configures the credentials for this repository using the supplied action.
Link copied to clipboard
abstract fun getAllowInsecureContinueWhenDisabled(): Property<Boolean>
Specifies whether to continue checking other repositories if this repository is disabled due to connection or communication errors.
Link copied to clipboard
abstract fun getAuthentication(): AuthenticationContainer
Returns the authentication schemes for this repository.
Link copied to clipboard
abstract fun getCredentials(): PasswordCredentials
Returns the username and password credentials used to authenticate to this repository.
abstract fun <T : Credentials?> getCredentials(credentialsType: Class<T>): T
Returns the credentials of the specified type used to authenticate with this repository.
Link copied to clipboard
abstract fun getMetadataSources(): IvyArtifactRepository.MetadataSources
Returns the current metadata sources configuration for the repository.
Link copied to clipboard
abstract fun getName(): String
Returns the name for this repository.
Link copied to clipboard
abstract fun getResolve(): IvyArtifactRepositoryMetaDataProvider
Returns the meta-data provider used when resolving artifacts from this repository.
Link copied to clipboard
abstract fun getUrl(): URI
The base URL of this repository.
Link copied to clipboard
abstract fun isAllowInsecureProtocol(): Boolean
Specifies whether it is acceptable to communicate with a repository over an insecure HTTP connection.
Link copied to clipboard
abstract fun ivyPattern(pattern: String)
Adds an independent pattern that will be used to locate ivy files in this repository.
Link copied to clipboard
abstract fun layout(layoutName: String)
Specifies how the items of the repository are organized.
Link copied to clipboard
abstract fun metadataSources(configureAction: Action<in IvyArtifactRepository.MetadataSources>)
Configures the metadata sources for this repository.
Link copied to clipboard
abstract fun patternLayout(config: Action<in IvyPatternRepositoryLayout>)
Specifies how the items of the repository are organized.
Link copied to clipboard
abstract fun setAllowInsecureProtocol(allowInsecureProtocol: Boolean)
Specifies whether it is acceptable to communicate with a repository over an insecure HTTP connection.
Link copied to clipboard
abstract fun setComponentVersionsLister(lister: Class<out ComponentMetadataVersionLister>)
abstract fun setComponentVersionsLister(lister: Class<out ComponentMetadataVersionLister>, configureAction: Action<in ActionConfiguration>)
Sets a custom component versions lister.
Link copied to clipboard
abstract fun setMetadataSupplier(rule: Class<out ComponentMetadataSupplier>)
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.
abstract fun setMetadataSupplier(rule: Class<out ComponentMetadataSupplier>, configureAction: Action<in ActionConfiguration>)
Sets a custom metadata rule, possibly configuring the rule.
Link copied to clipboard
abstract fun setName(name: String)
Sets the name for this repository.
Link copied to clipboard
abstract fun setUrl(url: Any)
abstract fun setUrl(url: URI)
Sets the base URL of this repository.
Generated by Dokka
Gradle Kotlin DSL Reference