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.buildcache;
20
21 import javax.annotation.Nonnull;
22
23 import java.io.IOException;
24 import java.nio.file.Path;
25 import java.util.Optional;
26
27 import org.apache.maven.buildcache.xml.Build;
28 import org.apache.maven.buildcache.xml.build.Artifact;
29 import org.apache.maven.project.MavenProject;
30
31 /**
32 * Remote cache repository.
33 */
34 public interface RemoteCacheRepository extends CacheRepository {
35
36 String BUILDINFO_XML = "buildinfo.xml";
37 String CACHE_REPORT_XML = "build-cache-report.xml";
38
39 /**
40 * Download an artifact to the given location.
41 * Returns <code>true</code> if success, <code>false</code> if the artifact does not exists
42 * and throws an <code>IOException</code> if a problem occurs.
43 */
44 boolean getArtifactContent(CacheContext context, Artifact artifact, Path target) throws IOException;
45
46 @Nonnull
47 String getResourceUrl(CacheContext context, String filename);
48
49 @Nonnull
50 Optional<Build> findBaselineBuild(MavenProject project);
51 }