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 org.apache.maven.execution.MavenSession;
23 import org.sonatype.aether.RepositorySystemSession;
24
25 /**
26 * Helps to provide backward-compatibility with plugins that use legacy components. <strong>Warning:</strong> This is an
27 * internal utility interface that is only public for technical reasons, it is not part of the public API. In
28 * particular, this interface can be changed or deleted without prior notice.
29 *
30 * @since 3.0
31 * @author Benjamin Bentmann
32 */
33 public interface LegacySupport
34 {
35
36 /**
37 * Sets the currently active session. Some legacy components are basically stateful and their API is missing
38 * parameters that would be required to delegate to a stateless component. Saving the session (in a thread-local
39 * variable) is our best effort to record any state that is required to enable proper delegation.
40 *
41 * @param session The currently active session, may be {@code null}.
42 */
43 void setSession( MavenSession session );
44
45 /**
46 * Gets the currently active session.
47 *
48 * @return The currently active session or {@code null} if none.
49 */
50 MavenSession getSession();
51
52 /**
53 * Gets the currently active repository session.
54 *
55 * @return The currently active repository session or {@code null} if none.
56 */
57 RepositorySystemSession getRepositorySession();
58
59 }