1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services;
20
21 import java.util.Collection;
22
23 import org.apache.maven.api.Artifact;
24 import org.apache.maven.api.RemoteRepository;
25 import org.apache.maven.api.Service;
26 import org.apache.maven.api.Session;
27 import org.apache.maven.api.annotations.Experimental;
28 import org.apache.maven.api.annotations.Nonnull;
29
30 /**
31 * Deploys {@link Artifact}s to a {@link RemoteRepository}.
32 *
33 * @since 4.0.0
34 * @see Session#deployArtifact(RemoteRepository, Artifact...)
35 */
36 @Experimental
37 public interface ArtifactDeployer extends Service {
38
39 /**
40 * @param request {@link ArtifactDeployerRequest}
41 * @throws ArtifactDeployerException if the deployment failed
42 */
43 void deploy(@Nonnull ArtifactDeployerRequest request);
44
45 /**
46 * @param session the repository session
47 * @param repository the repository to deploy to
48 * @param artifacts the collection of artifacts to deploy
49 * @throws ArtifactDeployerException if the deployment failed
50 * @throws IllegalArgumentException if an argument is {@code null} or invalid
51 */
52 default void deploy(
53 @Nonnull Session session, @Nonnull RemoteRepository repository, @Nonnull Collection<Artifact> artifacts) {
54 deploy(ArtifactDeployerRequest.build(session, repository, artifacts));
55 }
56 }