View Javadoc
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.eclipse.aether.impl;
20  
21  import org.eclipse.aether.RepositorySystemSession.CloseableSession;
22  
23  /**
24   * Lifecycle managing component for repository system.
25   *
26   * @noimplement This interface is not intended to be implemented by clients.
27   * @noextend This interface is not intended to be extended by clients.
28   * @provisional This type is provisional and can be changed, moved or removed without prior notice.
29   * @since 1.9.0
30   */
31  public interface RepositorySystemLifecycle {
32      /**
33       * Marks the repository system as ended (shut down): all "on close" handlers will be invoked. This method may be
34       * invoked multiple times, only once will execute, subsequent calls will be no-op.
35       */
36      void systemEnded();
37  
38      /**
39       * Registers an "on repository system end" handler.
40       * <p>
41       * Throws if repository system is already shut down.
42       */
43      void addOnSystemEndedHandler(Runnable handler);
44  
45      /**
46       * Registers the session for lifecycle tracking: it marks that the passed in session instance is about to start.
47       * <p>
48       * <em>Same session instance can be started only once.</em>
49       *
50       * @since 2.0.0
51       */
52      void sessionStarted(CloseableSession session);
53  
54      /**
55       * Signals that passed in session was ended, it will not be used anymore. Repository system
56       * will invoke the registered handlers for this session, if any. This method throws if the passed in session
57       * instance was not passed to method {@link #sessionStarted(CloseableSession)} beforehand.
58       * <p>
59       * <em>Same session instance can be ended only once.</em>
60       *
61       * @since 2.0.0
62       */
63      void sessionEnded(CloseableSession session);
64  
65      /**
66       * Registers an "on session end" handler.
67       * <p>
68       * Throws if session was not passed to {@link #sessionStarted(CloseableSession)} beforehand.
69       *
70       * @since 2.0.0
71       */
72      void addOnSessionEndedHandle(CloseableSession session, Runnable handler);
73  }