1 package org.apache.maven.plugin;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.util.List;
23 import java.util.Map;
24
25 import org.apache.maven.artifact.Artifact;
26 import org.apache.maven.model.Plugin;
27 import org.apache.maven.project.MavenProject;
28 import org.codehaus.plexus.classworlds.realm.ClassRealm;
29 import org.eclipse.aether.RepositorySystemSession;
30 import org.eclipse.aether.graph.DependencyFilter;
31 import org.eclipse.aether.repository.RemoteRepository;
32
33 /**
34 * Caches plugin class realms. <strong>Warning:</strong> This is an internal utility interface that is only public for
35 * technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without
36 * prior notice.
37 *
38 * @author Igor Fedorenko
39 * @author Benjamin Bentmann
40 */
41 public interface PluginRealmCache
42 {
43 /**
44 * CacheRecord
45 */
46 class CacheRecord
47 {
48 public ClassRealm getRealm()
49 {
50 return realm;
51 }
52
53 public List<Artifact> getArtifacts()
54 {
55 return artifacts;
56 }
57
58 private final ClassRealm realm;
59
60 private final List<Artifact> artifacts;
61
62 public CacheRecord( ClassRealm realm, List<Artifact> artifacts )
63 {
64 this.realm = realm;
65 this.artifacts = artifacts;
66 }
67 }
68
69 /**
70 * A cache key.
71 */
72 interface Key
73 {
74 // marker interface for cache keys
75 }
76
77 Key createKey( Plugin plugin, ClassLoader parentRealm, Map<String, ClassLoader> foreignImports,
78 DependencyFilter dependencyFilter, List<RemoteRepository> repositories,
79 RepositorySystemSession session );
80
81 CacheRecord get( Key key );
82
83 CacheRecord put( Key key, ClassRealm pluginRealm, List<Artifact> pluginArtifacts );
84
85 void flush();
86
87 /**
88 * Registers the specified cache record for usage with the given project. Integrators can use the information
89 * collected from this method in combination with a custom cache implementation to dispose unused records from the
90 * cache.
91 *
92 * @param project The project that employs the plugin realm, must not be {@code null}.
93 * @param record The cache record being used for the project, must not be {@code null}.
94 */
95 void register( MavenProject project, Key key, CacheRecord record );
96
97 }