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.plugin;
20
21 import java.util.List;
22
23 import org.apache.maven.artifact.Artifact;
24 import org.apache.maven.model.Plugin;
25 import org.apache.maven.project.MavenProject;
26 import org.eclipse.aether.RepositorySystemSession;
27 import org.eclipse.aether.graph.DependencyFilter;
28 import org.eclipse.aether.repository.RemoteRepository;
29
30 /**
31 * Caches plugin 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 * @author Igor Fedorenko
36 * @author Benjamin Bentmann
37 */
38 public interface PluginArtifactsCache {
39
40 /**
41 * A cache key.
42 */
43 interface Key {
44 // marker interface for cache keys
45 }
46
47 /**
48 * CacheRecord
49 */
50 class CacheRecord {
51
52 private final List<Artifact> artifacts;
53
54 public List<Artifact> getArtifacts() {
55 return artifacts;
56 }
57
58 public PluginResolutionException getException() {
59 return exception;
60 }
61
62 private final PluginResolutionException exception;
63
64 public CacheRecord(List<Artifact> artifacts) {
65 this.artifacts = artifacts;
66 this.exception = null;
67 }
68
69 public CacheRecord(PluginResolutionException exception) {
70 this.artifacts = null;
71 this.exception = exception;
72 }
73 }
74
75 Key createKey(
76 Plugin plugin,
77 DependencyFilter extensionFilter,
78 List<RemoteRepository> repositories,
79 RepositorySystemSession session);
80
81 CacheRecord get(Key key) throws PluginResolutionException;
82
83 CacheRecord put(Key key, List<Artifact> pluginArtifacts);
84
85 CacheRecord put(Key key, PluginResolutionException e);
86
87 void flush();
88
89 /**
90 * Registers the specified cache record for usage with the given project. Integrators can use the information
91 * collected from this method in combination with a custom cache implementation to dispose unused records from the
92 * cache.
93 *
94 * @param project The project that employs the plugin realm, must not be {@code null}.
95 * @param record The cache record being used for the project, must not be {@code null}.
96 */
97 void register(MavenProject project, Key cacheKey, CacheRecord record);
98 }