org.gradle.apirepositories.MavenArtifactRepository Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2011 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.artifacts.repositories;
import org.gradle.api.Action;
import org.gradle.api.Incubating;
import java.net.URI;
import java.util.Set;
/**
* An artifact repository which uses a Maven format to store artifacts and meta-data.
*
* Repositories of this type are created by the {@link org.gradle.api.artifacts.dsl.RepositoryHandler#maven(org.gradle.api.Action)} group of methods.
*/
public interface MavenArtifactRepository extends ArtifactRepository, UrlArtifactRepository, AuthenticationSupported, MetadataSupplierAware {
/**
* The base URL of this repository. This URL is used to find both POMs and artifact files. You can add additional URLs to use to look for artifact files, such as jars, using {@link
* #setArtifactUrls(Iterable)}.
*
* @return The URL.
*/
@Override
URI getUrl();
/**
* Sets the base URL of this repository. This URL is used to find both POMs and artifact files. You can add additional URLs to use to look for artifact files, such as jars, using {@link
* #setArtifactUrls(Iterable)}.
*
* @param url The base URL.
* @since 4.0
*/
@Override
void setUrl(URI url);
/**
* Sets the base URL of this repository. This URL is used to find both POMs and artifact files. You can add additional URLs to use to look for artifact files, such as jars, using {@link
* #setArtifactUrls(Iterable)}.
*
*
The provided value is evaluated as per {@link org.gradle.api.Project#uri(Object)}. This means, for example, you can pass in a {@code File} object, or a relative path to be evaluated relative
* to the project directory.
*
* @param url The base URL.
*/
@Override
void setUrl(Object url);
/**
* Returns the additional URLs to use to find artifact files. Note that these URLs are not used to find POM files.
*
* @return The additional URLs. Returns an empty list if there are no such URLs.
*/
Set getArtifactUrls();
/**
* Adds some additional URLs to use to find artifact files. Note that these URLs are not used to find POM files.
*
* The provided values are evaluated as per {@link org.gradle.api.Project#uri(Object)}. This means, for example, you can pass in a {@code File} object, or a relative path to be evaluated
* relative to the project directory.
*
* @param urls The URLs to add.
*/
void artifactUrls(Object... urls);
/**
* Sets the additional URLs to use to find artifact files. Note that these URLs are not used to find POM files.
*
* @param urls The URLs.
* @since 4.0
*/
void setArtifactUrls(Set urls);
/**
* Sets the additional URLs to use to find artifact files. Note that these URLs are not used to find POM files.
*
* The provided values are evaluated as per {@link org.gradle.api.Project#uri(Object)}. This means, for example, you can pass in a {@code File} object, or a relative path to be evaluated
* relative to the project directory.
*
* @param urls The URLs.
*/
void setArtifactUrls(Iterable urls);
/**
* Configures the metadata sources for this repository. This method will replace any previously configured sources
* of metadata.
*
* @param configureAction the configuration of metadata sources.
*
* @since 4.5
*/
void metadataSources(Action configureAction);
/**
* Returns the current metadata sources configuration for the repository.
*
* @since 6.4
*/
@Incubating
MetadataSources getMetadataSources();
/**
* Allows configuring the sources of metadata for a specific repository.
*
* @since 4.5
*
*/
interface MetadataSources {
/**
* Indicates that this repository will contain Gradle metadata.
*/
void gradleMetadata();
/**
* Indicates that this repository will contain Maven POM files.
* If the POM file contains a marker telling that Gradle metadata exists
* for this component, Gradle will also look for the Gradle metadata
* file. Gradle module metadata redirection will not happen if {@code ignoreGradleMetadataRedirection()} has been used.
*/
void mavenPom();
/**
* Indicates that this repository may not contain metadata files,
* but we can infer it from the presence of an artifact file.
*/
void artifact();
/**
* Indicates that this repository will ignore Gradle module metadata redirection markers found in POM files.
*
* @since 5.6
*
*/
void ignoreGradleMetadataRedirection();
/**
* Indicates if this repository contains Gradle module metadata.
*
* @since 6.4
*/
@Incubating
boolean isGradleMetadataEnabled();
/**
* Indicates if this repository contains Maven POM files.
*
* @since 6.4
*/
@Incubating
boolean isMavenPomEnabled();
/**
* Indicates if this repository only contains artifacts.
*
* @since 6.4
*/
@Incubating
boolean isArtifactEnabled();
/**
* Indicates if this repository ignores Gradle module metadata redirection markers.
*
* @since 6.4
*/
@Incubating
boolean isIgnoreGradleMetadataRedirectionEnabled();
}
/**
* Configures the content of this Maven repository.
* @param configureAction the configuration action
*
* @since 5.1
*/
void mavenContent(Action configureAction);
}