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