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 * @author Igor Fedorenko
38 * @author Benjamin Bentmann
39 */
40 public interface PluginRealmCache {
41 /**
42 * CacheRecord
43 */
44 class CacheRecord {
45 public ClassRealm getRealm() {
46 return realm;
47 }
48
49 public List<Artifact> getArtifacts() {
50 return artifacts;
51 }
52
53 private final ClassRealm realm;
54
55 private final List<Artifact> artifacts;
56
57 public CacheRecord(ClassRealm realm, List<Artifact> artifacts) {
58 this.realm = realm;
59 this.artifacts = artifacts;
60 }
61 }
62
63 /**
64 * A cache key.
65 */
66 interface Key {
67 // marker interface for cache keys
68 }
69
70 @FunctionalInterface
71 interface PluginRealmSupplier {
72 CacheRecord load() throws PluginResolutionException, PluginContainerException;
73 }
74
75 Key createKey(
76 Plugin plugin,
77 ClassLoader parentRealm,
78 Map<String, ClassLoader> foreignImports,
79 DependencyFilter dependencyFilter,
80 List<RemoteRepository> repositories,
81 RepositorySystemSession session);
82
83 CacheRecord get(Key key);
84
85 default CacheRecord get(Key key, PluginRealmSupplier supplier)
86 throws PluginResolutionException, PluginContainerException {
87 CacheRecord cr = get(key);
88 if (cr == null) {
89 CacheRecord tcr = supplier.load();
90 cr = put(key, tcr.getRealm(), tcr.getArtifacts());
91 }
92 return cr;
93 }
94
95 CacheRecord put(Key key, ClassRealm pluginRealm, List<Artifact> pluginArtifacts);
96
97 void flush();
98
99 /**
100 * Registers the specified cache record for usage with the given project. Integrators can use the information
101 * collected from this method in combination with a custom cache implementation to dispose unused records from the
102 * cache.
103 *
104 * @param project The project that employs the plugin realm, must not be {@code null}.
105 * @param record The cache record being used for the project, must not be {@code null}.
106 */
107 void register(MavenProject project, Key key, CacheRecord record);
108 }