org.gradle.apimaven.MavenDeployer Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2007-2008 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.maven;
import java.io.File;
import java.util.Collection;
/**
* A resolver that can only be used for uploading artifacts to a Maven repository. If you use this resolver for
* getting dependencies from a Maven repository, an exception is thrown. This resolver support all aspects of Maven
* deployment, including snapshot deployment and metadata.xml manipulation.
*
* You have to specify at least one repository. Otherwise, if there is only one artifact, usually there is not more
* to do. If there is more than one artifact you have to decide what to do about this, as a Maven POM can only deal with
* one artifact. There are two strategies. If you want to deploy only one artifact you have to specify a filter to
* select this artifact. If you want to deploy more than one artifact, you have to specify filters which select each
* artifact. Associated with each filter is a separate configurable POM.
*
* You can create an instance of this type via the {@link org.gradle.api.tasks.Upload#getRepositories()}
* container
*/
public interface MavenDeployer extends MavenResolver {
/**
* Returns the repository to be used for uploading artifacts.
*
* @see #setRepository(Object)
*/
Object getRepository();
/**
* Sets the repository to be used for uploading artifacts. If {@link #getSnapshotRepository()} is not set, this repository
* is also used for uploading snapshot artifacts.
*
* @param repository The repository to be used
*/
void setRepository(Object repository);
/**
* Returns the repository to be used for uploading snapshot artifacts.
*
* @see #setSnapshotRepository(Object)
*/
Object getSnapshotRepository();
/**
* Sets the repository to be used for uploading snapshot artifacts. If this is not set, the {@link #getRepository()}
* is used for uploading snapshot artifacts.
*
* @param snapshotRepository The repository to be used
*/
void setSnapshotRepository(Object snapshotRepository);
/**
* Out of the box only uploading to the filesysten and via http is supported. If other protocolls should be used,
* the appropriate Maven wagon jars have to be passed via this method.
*/
void addProtocolProviderJars(Collection jars);
}