1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugin;
20
21 import org.apache.maven.execution.MavenSession;
22 import org.eclipse.aether.RepositorySystemSession;
23
24 /**
25 * Helps to provide backward-compatibility with plugins that use legacy components. <strong>Warning:</strong> This is an
26 * internal utility interface that is only public for technical reasons, it is not part of the public API. In
27 * particular, this interface can be changed or deleted without prior notice.
28 *
29 * @since 3.0
30 * @author Benjamin Bentmann
31 */
32 public interface LegacySupport {
33
34 /**
35 * Sets the currently active session. Some legacy components are basically stateful and their API is missing
36 * parameters that would be required to delegate to a stateless component. Saving the session (in a thread-local
37 * variable) is our best effort to record any state that is required to enable proper delegation.
38 *
39 * @param session The currently active session, may be {@code null}.
40 */
41 void setSession(MavenSession session);
42
43 /**
44 * Gets the currently active session.
45 *
46 * @return The currently active session or {@code null} if none.
47 */
48 MavenSession getSession();
49
50 /**
51 * Gets the currently active repository session.
52 *
53 * @return The currently active repository session or {@code null} if none.
54 */
55 RepositorySystemSession getRepositorySession();
56 }