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.project.ExtensionDescriptor;
25 import org.apache.maven.project.MavenProject;
26 import org.codehaus.plexus.classworlds.realm.ClassRealm;
27 import org.eclipse.aether.artifact.Artifact;
28
29 /**
30 * Caches extension class realms. <strong>Warning:</strong> This is an internal utility interface that is only public
31 * for technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted
32 * without prior notice.
33 *
34 * @author Igor Fedorenko
35 * @author Benjamin Bentmann
36 */
37 public interface ExtensionRealmCache
38 {
39
40 public static class CacheRecord
41 {
42
43 public final ClassRealm realm;
44
45 public final ExtensionDescriptor desciptor;
46
47 public CacheRecord( ClassRealm realm, ExtensionDescriptor descriptor )
48 {
49 this.realm = realm;
50 this.desciptor = descriptor;
51 }
52
53 }
54
55 CacheRecord get( List<? extends Artifact> extensionArtifacts );
56
57 CacheRecord put( List<? extends Artifact> extensionArtifacts, ClassRealm extensionRealm,
58 ExtensionDescriptor extensionDescriptor );
59
60 void flush();
61
62 /**
63 * Registers the specified cache record for usage with the given project. Integrators can use the information
64 * collected from this method in combination with a custom cache implementation to dispose unused records from the
65 * cache.
66 *
67 * @param project The project that employs the plugin realm, must not be {@code null}.
68 * @param record The cache record being used for the project, must not be {@code null}.
69 */
70 void register( MavenProject project, CacheRecord record );
71
72 }