blob: 4284fce9bec81962c7f2ceab11cdac1f60efe9ee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
package org.apache.maven.eventspy;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Map;
/**
* A core extension to monitor Maven's execution. Typically, such an extension gets loaded into Maven by specifying the
* system property {@code maven.ext.class.path} on the command line. As soon as dependency injection is setup, Maven
* looks up all implementators of this interface and calls their {@link #init(Context)} method. <em>Note:</em>
* Implementors are strongly advised to inherit from {@link AbstractEventSpy} instead of directly implementing this
* interface.
* @since 3.0.2
*/
public interface EventSpy
{
interface Context
{
/**
* Gets key-value pairs providing information about the Maven runtime.
*
* @return The key-value pairs, never {@code null}.
*/
Map<String, Object> getData();
}
/**
* Initializes the spy.
*
* @param context The event spy context, never {@code null}.
*/
void init( Context context )
throws Exception;
/**
* Notifies the spy of some build event/operation.
*
* @param event The event, never {@code null}.
* @see org.apache.maven.settings.building.SettingsBuildingRequest
* @see org.apache.maven.settings.building.SettingsBuildingResult
* @see org.apache.maven.execution.MavenExecutionRequest
* @see org.apache.maven.execution.MavenExecutionResult
* @see org.apache.maven.project.DependencyResolutionRequest
* @see org.apache.maven.project.DependencyResolutionResult
* @see org.apache.maven.execution.ExecutionEvent
* @see org.eclipse.aether.RepositoryEvent
*/
void onEvent( Object event )
throws Exception;
/**
* Notifies the spy of Maven's termination, allowing it to free any resources allocated by it.
*/
void close()
throws Exception;
}
|
