001    package org.apache.maven.plugin;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.util.List;
023    
024    import org.apache.maven.project.ExtensionDescriptor;
025    import org.apache.maven.project.MavenProject;
026    import org.codehaus.plexus.classworlds.realm.ClassRealm;
027    import org.sonatype.aether.artifact.Artifact;
028    
029    /**
030     * Caches extension class realms. <strong>Warning:</strong> This is an internal utility interface that is only public
031     * for technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted
032     * without prior notice.
033     * 
034     * @author Igor Fedorenko
035     * @author Benjamin Bentmann
036     */
037    public interface ExtensionRealmCache
038    {
039    
040        public static class CacheRecord
041        {
042    
043            public final ClassRealm realm;
044    
045            public final ExtensionDescriptor desciptor;
046    
047            public CacheRecord( ClassRealm realm, ExtensionDescriptor descriptor )
048            {
049                this.realm = realm;
050                this.desciptor = descriptor;
051            }
052    
053        }
054    
055        CacheRecord get( List<? extends Artifact> extensionArtifacts );
056    
057        CacheRecord put( List<? extends Artifact> extensionArtifacts, ClassRealm extensionRealm,
058                         ExtensionDescriptor extensionDescriptor );
059    
060        void flush();
061    
062        /**
063         * Registers the specified cache record for usage with the given project. Integrators can use the information
064         * collected from this method in combination with a custom cache implementation to dispose unused records from the
065         * cache.
066         * 
067         * @param project The project that employs the plugin realm, must not be {@code null}.
068         * @param record The cache record being used for the project, must not be {@code null}.
069         */
070        void register( MavenProject project, CacheRecord record );
071    
072    }