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
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.sonatype.aether.RepositorySystemSession;
29 import org.sonatype.aether.graph.DependencyFilter;
30 import org.sonatype.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
43 public static class CacheRecord
44 {
45 public final ClassRealm realm;
46
47 public final List<Artifact> artifacts;
48
49 public CacheRecord( ClassRealm realm, List<Artifact> artifacts )
50 {
51 this.realm = realm;
52 this.artifacts = artifacts;
53 }
54 }
55
56 /**
57 * A cache key.
58 */
59 interface Key
60 {
61 // marker interface for cache keys
62 }
63
64 Key createKey( Plugin plugin, ClassLoader parentRealm, List<String> parentImports,
65 DependencyFilter dependencyFilter, List<RemoteRepository> repositories, RepositorySystemSession session );
66
67 CacheRecord get( Key key );
68
69 CacheRecord put( Key key, ClassRealm pluginRealm, List<Artifact> pluginArtifacts );
70
71 void flush();
72
73 /**
74 * Registers the specified cache record for usage with the given project. Integrators can use the information
75 * collected from this method in combination with a custom cache implementation to dispose unused records from the
76 * cache.
77 *
78 * @param project The project that employs the plugin realm, must not be {@code null}.
79 * @param record The cache record being used for the project, must not be {@code null}.
80 */
81 void register( MavenProject project, CacheRecord record );
82
83 }