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 org.apache.maven.execution.MavenSession;
023    import org.sonatype.aether.RepositorySystemSession;
024    
025    /**
026     * Helps to provide backward-compatibility with plugins that use legacy components. <strong>Warning:</strong> This is an
027     * internal utility interface that is only public for technical reasons, it is not part of the public API. In
028     * particular, this interface can be changed or deleted without prior notice.
029     * 
030     * @since 3.0
031     * @author Benjamin Bentmann
032     */
033    public interface LegacySupport
034    {
035    
036        /**
037         * Sets the currently active session. Some legacy components are basically stateful and their API is missing
038         * parameters that would be required to delegate to a stateless component. Saving the session (in a thread-local
039         * variable) is our best effort to record any state that is required to enable proper delegation.
040         * 
041         * @param session The currently active session, may be {@code null}.
042         */
043        void setSession( MavenSession session );
044    
045        /**
046         * Gets the currently active session.
047         * 
048         * @return The currently active session or {@code null} if none.
049         */
050        MavenSession getSession();
051    
052        /**
053         * Gets the currently active repository session.
054         * 
055         * @return The currently active repository session or {@code null} if none.
056         */
057        RepositorySystemSession getRepositorySession();
058    
059    }