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 java.io.IOException;
22 import java.util.List;
23 import java.util.Map;
24
25 import org.apache.maven.buildcache.artifact.ArtifactRestorationReport;
26 import org.apache.maven.execution.MavenSession;
27 import org.apache.maven.execution.MojoExecutionEvent;
28 import org.apache.maven.plugin.MojoExecution;
29 import org.apache.maven.project.MavenProject;
30
31 /**
32 * CacheController
33 */
34 public interface CacheController {
35
36 CacheResult findCachedBuild(
37 MavenSession session, MavenProject project, List<MojoExecution> mojoExecutions, boolean skipCache);
38
39 ArtifactRestorationReport restoreProjectArtifacts(CacheResult cacheResult);
40
41 void save(
42 CacheResult cacheResult,
43 List<MojoExecution> mojoExecutions,
44 Map<String, MojoExecutionEvent> executionEvents);
45
46 boolean isForcedExecution(MavenProject project, MojoExecution execution);
47
48 void saveCacheReport(MavenSession session);
49
50 /**
51 * Move pre-existing artifacts to staging directory to prevent caching stale files.
52 * Called before mojos run to ensure save() only sees fresh files.
53 *
54 * @param session the Maven session
55 * @param project the Maven project
56 * @throws IOException if file operations fail
57 */
58 void stagePreExistingArtifacts(MavenSession session, MavenProject project) throws IOException;
59
60 /**
61 * Restore staged artifacts after save() completes.
62 * Files that were rebuilt are discarded; files that weren't rebuilt are restored.
63 *
64 * @param session the Maven session
65 * @param project the Maven project
66 */
67 void restoreStagedArtifacts(MavenSession session, MavenProject project);
68 }