View Javadoc
1   package org.eclipse.aether.spi.locator;
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.List;
23  
24  /**
25   * A simple infrastructure to programmatically wire the various components of the repository system together when it is
26   * used outside of an IoC container. Once a concrete implementation of a service locator has been setup, clients could
27   * use
28   * 
29   * <pre>
30   * RepositorySystem repoSystem = serviceLocator.getService( RepositorySystem.class );
31   * </pre>
32   * 
33   * to acquire the repository system. Components that implement {@link Service} will be given an opportunity to acquire
34   * further components from the locator, thereby allowing to create the complete object graph of the repository system.
35   */
36  public interface ServiceLocator
37  {
38  
39      /**
40       * Gets an instance of the specified service.
41       * 
42       * @param <T> The service type.
43       * @param type The interface describing the service, must not be {@code null}.
44       * @return The service instance or {@code null} if the service could not be located/initialized.
45       */
46      <T> T getService( Class<T> type );
47  
48      /**
49       * Gets all available instances of the specified service.
50       * 
51       * @param <T> The service type.
52       * @param type The interface describing the service, must not be {@code null}.
53       * @return The (read-only) list of available service instances, never {@code null}.
54       */
55      <T> List<T> getServices( Class<T> type );
56  
57  }