View Javadoc
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.CacheSource;
29  import org.apache.maven.buildcache.xml.build.Artifact;
30  import org.apache.maven.execution.MavenSession;
31  import org.apache.maven.model.Dependency;
32  
33  /**
34   * Local cache repository.
35   */
36  public interface LocalCacheRepository extends CacheRepository {
37  
38      void beforeSave(CacheContext environment) throws IOException;
39  
40      Path getArtifactFile(CacheContext context, CacheSource source, Artifact artifact) throws IOException;
41  
42      void clearCache(CacheContext context);
43  
44      @Nonnull
45      Optional<Build> findBestMatchingBuild(MavenSession session, Dependency dependency) throws IOException;
46  
47      @Nonnull
48      Optional<Build> findLocalBuild(CacheContext context) throws IOException;
49  }