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 import java.util.Map;
23
24 import org.apache.maven.artifact.Artifact;
25 import org.apache.maven.model.Plugin;
26 import org.apache.maven.project.MavenProject;
27 import org.codehaus.plexus.classworlds.realm.ClassRealm;
28 import org.eclipse.aether.RepositorySystemSession;
29 import org.eclipse.aether.graph.DependencyFilter;
30 import org.eclipse.aether.repository.RemoteRepository;
31
32 /**
33 * Caches plugin class realms. <strong>Warning:</strong> This is an internal utility interface that is only public for
34 * technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without
35 * prior notice.
36 *
37 */
38 public interface PluginRealmCache {
39 /**
40 * CacheRecord
41 */
42 class CacheRecord {
43 public ClassRealm getRealm() {
44 return realm;
45 }
46
47 public List<Artifact> getArtifacts() {
48 return artifacts;
49 }
50
51 private final ClassRealm realm;
52
53 private final List<Artifact> artifacts;
54
55 public CacheRecord(ClassRealm realm, List<Artifact> artifacts) {
56 this.realm = realm;
57 this.artifacts = artifacts;
58 }
59 }
60
61 /**
62 * A cache key.
63 */
64 interface Key {
65 // marker interface for cache keys
66 }
67
68 @FunctionalInterface
69 interface PluginRealmSupplier {
70 CacheRecord load() throws PluginResolutionException, PluginContainerException;
71 }
72
73 Key createKey(
74 Plugin plugin,
75 ClassLoader parentRealm,
76 Map<String, ClassLoader> foreignImports,
77 DependencyFilter dependencyFilter,
78 List<RemoteRepository> repositories,
79 RepositorySystemSession session);
80
81 CacheRecord get(Key key);
82
83 default CacheRecord get(Key key, PluginRealmSupplier supplier)
84 throws PluginResolutionException, PluginContainerException {
85 CacheRecord cr = get(key);
86 if (cr == null) {
87 CacheRecord tcr = supplier.load();
88 cr = put(key, tcr.getRealm(), tcr.getArtifacts());
89 }
90 return cr;
91 }
92
93 CacheRecord put(Key key, ClassRealm pluginRealm, List<Artifact> pluginArtifacts);
94
95 void flush();
96
97 /**
98 * Registers the specified cache record for usage with the given project. Integrators can use the information
99 * collected from this method in combination with a custom cache implementation to dispose unused records from the
100 * cache.
101 *
102 * @param project The project that employs the plugin realm, must not be {@code null}.
103 * @param record The cache record being used for the project, must not be {@code null}.
104 */
105 void register(MavenProject project, Key key, CacheRecord record);
106 }