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.project.artifact;
20
21 import java.util.Collection;
22 import java.util.Set;
23
24 import org.apache.maven.artifact.Artifact;
25 import org.apache.maven.lifecycle.LifecycleExecutionException;
26 import org.apache.maven.project.DependencyResolutionResult;
27 import org.apache.maven.project.MavenProject;
28 import org.eclipse.aether.RepositorySystemSession;
29
30 /**
31 * Caches project artifacts. <strong>Warning:</strong> This is an internal utility interface that is only public for
32 * technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without
33 * prior notice.
34 *
35 */
36 public interface ProjectArtifactsCache {
37
38 /**
39 * A cache key.
40 */
41 interface Key {
42 // marker interface for cache keys
43 }
44
45 interface ArtifactsSetWithResult extends Set<Artifact> {
46 DependencyResolutionResult getResult();
47 }
48
49 /**
50 * CacheRecord
51 */
52 class CacheRecord {
53
54 private final Set<Artifact> artifacts;
55
56 private final LifecycleExecutionException exception;
57
58 CacheRecord(Set<Artifact> artifacts) {
59 this.artifacts = artifacts;
60 this.exception = null;
61 }
62
63 CacheRecord(LifecycleExecutionException exception) {
64 this.artifacts = null;
65 this.exception = exception;
66 }
67
68 public Set<Artifact> getArtifacts() {
69 return artifacts;
70 }
71
72 public LifecycleExecutionException getException() {
73 return exception;
74 }
75 }
76
77 Key createKey(
78 MavenProject project,
79 Collection<String> scopesToCollect,
80 Collection<String> scopesToResolve,
81 boolean aggregating,
82 RepositorySystemSession session);
83
84 CacheRecord get(Key key) throws LifecycleExecutionException;
85
86 CacheRecord put(Key key, Set<Artifact> pluginArtifacts);
87
88 CacheRecord put(Key key, LifecycleExecutionException e);
89
90 void flush();
91
92 /**
93 * Registers the specified cache record for usage with the given project. Integrators can use the information
94 * collected from this method in combination with a custom cache implementation to dispose unused records from the
95 * cache.
96 *
97 * @param project The project that employs the plugin realm, must not be {@code null}.
98 * @param record The cache record being used for the project, must not be {@code null}.
99 */
100 void register(MavenProject project, Key cacheKey, CacheRecord record);
101 }