1 package org.apache.maven.eventspy;
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.Map;
23
24 /**
25 * A core extension to monitor Maven's execution. Typically, such an extension gets loaded into Maven by specifying the
26 * system property {@code maven.ext.class.path} on the command line. As soon as dependency injection is setup, Maven
27 * looks up all implementers of this interface and calls their {@link #init(Context)} method. <em>Note:</em>
28 * Implementors are strongly advised to inherit from {@link AbstractEventSpy} instead of directly implementing this
29 * interface.
30 * @since 3.0.2
31 */
32 public interface EventSpy
33 {
34
35 interface Context
36 {
37
38 /**
39 * Gets key-value pairs providing information about the Maven runtime.
40 *
41 * @return The key-value pairs, never {@code null}.
42 */
43 Map<String, Object> getData();
44
45 }
46
47 /**
48 * Initializes the spy.
49 *
50 * @param context The event spy context, never {@code null}.
51 */
52 void init( Context context )
53 throws Exception;
54
55 /**
56 * Notifies the spy of some build event/operation.
57 *
58 * @param event The event, never {@code null}.
59 * @see org.apache.maven.settings.building.SettingsBuildingRequest
60 * @see org.apache.maven.settings.building.SettingsBuildingResult
61 * @see org.apache.maven.execution.MavenExecutionRequest
62 * @see org.apache.maven.execution.MavenExecutionResult
63 * @see org.apache.maven.project.DependencyResolutionRequest
64 * @see org.apache.maven.project.DependencyResolutionResult
65 * @see org.apache.maven.execution.ExecutionEvent
66 * @see org.eclipse.aether.RepositoryEvent
67 */
68 void onEvent( Object event )
69 throws Exception;
70
71 /**
72 * Notifies the spy of Maven's termination, allowing it to free any resources allocated by it.
73 */
74 void close()
75 throws Exception;
76
77 }