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.project.ExtensionDescriptor;
26 import org.apache.maven.project.MavenProject;
27 import org.codehaus.plexus.classworlds.realm.ClassRealm;
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 * A cache key.
41 */
42 interface Key
43 {
44 // marker interface for cache keys
45 }
46
47 /**
48 * CacheRecord
49 */
50 class CacheRecord
51 {
52
53 private final ClassRealm realm;
54
55 private final ExtensionDescriptor descriptor;
56
57 private final List<Artifact> artifacts;
58
59 CacheRecord( ClassRealm realm, ExtensionDescriptor descriptor, List<Artifact> artifacts )
60 {
61 this.realm = realm;
62 this.descriptor = descriptor;
63 this.artifacts = artifacts;
64 }
65
66 public ClassRealm getRealm()
67 {
68 return realm;
69 }
70
71 public ExtensionDescriptor getDescriptor()
72 {
73 return descriptor;
74 }
75
76 public List<Artifact> getArtifacts()
77 {
78 return artifacts;
79 }
80 }
81
82 Key createKey( List<Artifact> extensionArtifacts );
83
84 CacheRecord get( Key key );
85
86 CacheRecord put( Key key, ClassRealm extensionRealm, ExtensionDescriptor extensionDescriptor,
87 List<Artifact> artifacts );
88
89 void flush();
90
91 /**
92 * Registers the specified cache record for usage with the given project. Integrators can use the information
93 * collected from this method in combination with a custom cache implementation to dispose unused records from the
94 * cache.
95 *
96 * @param project The project that employs the plugin realm, must not be {@code null}.
97 * @param record The cache record being used for the project, must not be {@code null}.
98 */
99 void register( MavenProject project, Key key, CacheRecord record );
100
101 }