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 static class CacheRecord 48 { 49 50 public final ClassRealm realm; 51 52 public final ExtensionDescriptor descriptor; 53 54 public final List<Artifact> artifacts; 55 56 public CacheRecord( ClassRealm realm, ExtensionDescriptor descriptor, List<Artifact> artifacts ) 57 { 58 this.realm = realm; 59 this.descriptor = descriptor; 60 this.artifacts = artifacts; 61 } 62 63 } 64 65 Key createKey( List<Artifact> extensionArtifacts ); 66 67 CacheRecord get( Key key ); 68 69 CacheRecord put( Key key, ClassRealm extensionRealm, ExtensionDescriptor extensionDescriptor, 70 List<Artifact> artifacts ); 71 72 void flush(); 73 74 /** 75 * Registers the specified cache record for usage with the given project. Integrators can use the information 76 * collected from this method in combination with a custom cache implementation to dispose unused records from the 77 * cache. 78 * 79 * @param project The project that employs the plugin realm, must not be {@code null}. 80 * @param record The cache record being used for the project, must not be {@code null}. 81 */ 82 void register( MavenProject project, Key key, CacheRecord record ); 83 84 }