View Javadoc

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 implementators 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   */
31  public interface EventSpy
32  {
33  
34      interface Context
35      {
36  
37          /**
38           * Gets key-value pairs providing information about the Maven runtime.
39           * 
40           * @return The key-value pairs, never {@code null}.
41           */
42          Map<String, Object> getData();
43  
44      }
45  
46      /**
47       * Initializes the spy.
48       * 
49       * @param context The event spy context, never {@code null}.
50       */
51      void init( Context context )
52          throws Exception;
53  
54      /**
55       * Notifies the spy of some build event/operation.
56       * 
57       * @param event The event, never {@code null}.
58       * @see org.apache.maven.settings.building.SettingsBuildingRequest
59       * @see org.apache.maven.settings.building.SettingsBuildingResult
60       * @see org.apache.maven.execution.MavenExecutionRequest
61       * @see org.apache.maven.execution.MavenExecutionResult
62       * @see org.apache.maven.project.DependencyResolutionRequest
63       * @see org.apache.maven.project.DependencyResolutionResult
64       * @see org.apache.maven.execution.ExecutionEvent
65       * @see org.eclipse.aether.RepositoryEvent
66       */
67      void onEvent( Object event )
68          throws Exception;
69  
70      /**
71       * Notifies the spy of Maven's termination, allowing it to free any resources allocated by it.
72       */
73      void close()
74          throws Exception;
75  
76  }