All Downloads are FREE. Search and download functionalities are using the official Maven repository.

shaded.org.eclipse.aether.impl.DefaultServiceLocator Maven / Gradle / Ivy

There is a newer version: 4.1.2
Show newest version
/*******************************************************************************
 * Copyright (c) 2010, 2014 Sonatype, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Sonatype, Inc. - initial API and implementation
 *******************************************************************************/
package shaded.shaded.org.eclipse.aether.impl;

import java.lang.reflect.Constructor;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;

import org.eclipse.aether.RepositorySystem;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultArtifactResolver;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultChecksumPolicyProvider;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultDependencyCollector;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultDeployer;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultFileProcessor;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultInstaller;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultLocalRepositoryProvider;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultMetadataResolver;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultOfflineController;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultRemoteRepositoryManager;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultRepositoryConnectorProvider;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultRepositoryEventDispatcher;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultRepositoryLayoutProvider;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultRepositorySystem;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultSyncContextFactory;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultTransporterProvider;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultUpdateCheckManager;
import shaded.shaded.org.eclipse.aether.internal.impl.DefaultUpdatePolicyAnalyzer;
import shaded.shaded.org.eclipse.aether.internal.impl.EnhancedLocalRepositoryManagerFactory;
import shaded.shaded.org.eclipse.aether.internal.impl.Maven2RepositoryLayoutFactory;
import shaded.shaded.org.eclipse.aether.internal.impl.SimpleLocalRepositoryManagerFactory;
import shaded.shaded.org.eclipse.aether.internal.impl.slf4j.Slf4jLoggerFactory;
import shaded.shaded.org.eclipse.aether.spi.connector.checksum.ChecksumPolicyProvider;
import shaded.shaded.org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory;
import shaded.shaded.org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider;
import shaded.shaded.org.eclipse.aether.spi.connector.transport.TransporterProvider;
import shaded.shaded.org.eclipse.aether.spi.io.FileProcessor;
import shaded.shaded.org.eclipse.aether.spi.localrepo.LocalRepositoryManagerFactory;
import shaded.shaded.org.eclipse.aether.spi.locator.Service;
import shaded.shaded.org.eclipse.aether.spi.locator.ServiceLocator;
import shaded.shaded.org.eclipse.aether.spi.log.LoggerFactory;

/**
 * A simple service locator that is already setup with all components from this library. To acquire a complete
 * repository system, clients need to add an artifact descriptor reader, a version resolver, a version range resolver
 * and optionally some repository connector and transporter factories to access remote repositories. Once the locator is
 * fully populated, the repository system can be created like this:
 * 
 * 
 * RepositorySystem repoSystem = serviceLocator.getService( RepositorySystem.class );
 * 
* * Note: This class is not thread-safe. Clients are expected to create the service locator and the repository * system on a single thread. */ public final class DefaultServiceLocator implements ServiceLocator { private class Entry { private final Class type; private final Collection providers; private List instances; public Entry( Class type ) { if ( type == null ) { throw new IllegalArgumentException( "service type not specified" ); } this.type = type; providers = new LinkedHashSet( 8 ); } public synchronized void setServices( T... services ) { providers.clear(); if ( services != null ) { for ( T service : services ) { if ( service == null ) { throw new IllegalArgumentException( "service instance not specified" ); } providers.add( service ); } } instances = null; } public synchronized void setService( Class impl ) { providers.clear(); addService( impl ); } public synchronized void addService( Class impl ) { if ( impl == null ) { throw new IllegalArgumentException( "implementation class not specified" ); } providers.add( impl ); instances = null; } public T getInstance() { List instances = getInstances(); return instances.isEmpty() ? null : instances.get( 0 ); } public synchronized List getInstances() { if ( instances == null ) { instances = new ArrayList( providers.size() ); for ( Object provider : providers ) { T instance; if ( provider instanceof Class ) { instance = newInstance( (Class) provider ); } else { instance = type.cast( provider ); } if ( instance != null ) { instances.add( instance ); } } instances = Collections.unmodifiableList( instances ); } return instances; } private T newInstance( Class impl ) { try { Constructor constr = impl.getDeclaredConstructor(); if ( !Modifier.isPublic( constr.getModifiers() ) ) { constr.setAccessible( true ); } Object obj = constr.newInstance(); T instance = type.cast( obj ); if ( instance instanceof Service ) { ( (Service) instance ).initService( DefaultServiceLocator.this ); } return instance; } catch ( Exception e ) { serviceCreationFailed( type, impl, e ); } catch ( LinkageError e ) { serviceCreationFailed( type, impl, e ); } return null; } } private final Map, Entry> entries; private ErrorHandler errorHandler; /** * Creates a new service locator that already knows about all service implementations included this library. */ public DefaultServiceLocator() { entries = new HashMap, Entry>(); addService( RepositorySystem.class, DefaultRepositorySystem.class ); addService( ArtifactResolver.class, DefaultArtifactResolver.class ); addService( DependencyCollector.class, DefaultDependencyCollector.class ); addService( Deployer.class, DefaultDeployer.class ); addService( Installer.class, DefaultInstaller.class ); addService( MetadataResolver.class, DefaultMetadataResolver.class ); addService( RepositoryLayoutProvider.class, DefaultRepositoryLayoutProvider.class ); addService( RepositoryLayoutFactory.class, Maven2RepositoryLayoutFactory.class ); addService( TransporterProvider.class, DefaultTransporterProvider.class ); addService( ChecksumPolicyProvider.class, DefaultChecksumPolicyProvider.class ); addService( RepositoryConnectorProvider.class, DefaultRepositoryConnectorProvider.class ); addService( RemoteRepositoryManager.class, DefaultRemoteRepositoryManager.class ); addService( UpdateCheckManager.class, DefaultUpdateCheckManager.class ); addService( UpdatePolicyAnalyzer.class, DefaultUpdatePolicyAnalyzer.class ); addService( FileProcessor.class, DefaultFileProcessor.class ); addService( SyncContextFactory.class, DefaultSyncContextFactory.class ); addService( RepositoryEventDispatcher.class, DefaultRepositoryEventDispatcher.class ); addService( OfflineController.class, DefaultOfflineController.class ); addService( LocalRepositoryProvider.class, DefaultLocalRepositoryProvider.class ); addService( LocalRepositoryManagerFactory.class, SimpleLocalRepositoryManagerFactory.class ); addService( LocalRepositoryManagerFactory.class, EnhancedLocalRepositoryManagerFactory.class ); if ( Slf4jLoggerFactory.isSlf4jAvailable() ) { addService( LoggerFactory.class, Slf4jLoggerFactory.class ); } } private Entry getEntry( Class type, boolean create ) { if ( type == null ) { throw new IllegalArgumentException( "service type not specified" ); } @SuppressWarnings( "unchecked" ) Entry entry = (Entry) entries.get( type ); if ( entry == null && create ) { entry = new Entry( type ); entries.put( type, entry ); } return entry; } /** * Sets the implementation class for a service. The specified class must have a no-arg constructor (of any * visibility). If the service implementation itself requires other services for its operation, it should implement * {@link Service} to gain access to this service locator. * * @param The service type. * @param type The interface describing the service, must not be {@code null}. * @param impl The implementation class of the service, must not be {@code null}. * @return This locator for chaining, never {@code null}. */ public DefaultServiceLocator setService( Class type, Class impl ) { getEntry( type, true ).setService( impl ); return this; } /** * Adds an implementation class for a service. The specified class must have a no-arg constructor (of any * visibility). If the service implementation itself requires other services for its operation, it should implement * {@link Service} to gain access to this service locator. * * @param The service type. * @param type The interface describing the service, must not be {@code null}. * @param impl The implementation class of the service, must not be {@code null}. * @return This locator for chaining, never {@code null}. */ public DefaultServiceLocator addService( Class type, Class impl ) { getEntry( type, true ).addService( impl ); return this; } /** * Sets the instances for a service. * * @param The service type. * @param type The interface describing the service, must not be {@code null}. * @param services The instances of the service, may be {@code null} but must not contain {@code null} elements. * @return This locator for chaining, never {@code null}. */ public DefaultServiceLocator setServices( Class type, T... services ) { getEntry( type, true ).setServices( services ); return this; } public T getService( Class type ) { Entry entry = getEntry( type, false ); return ( entry != null ) ? entry.getInstance() : null; } public List getServices( Class type ) { Entry entry = getEntry( type, false ); return ( entry != null ) ? entry.getInstances() : null; } private void serviceCreationFailed( Class type, Class impl, Throwable exception ) { if ( errorHandler != null ) { errorHandler.serviceCreationFailed( type, impl, exception ); } } /** * Sets the error handler to use. * * @param errorHandler The error handler to use, may be {@code null} to ignore/swallow errors. */ public void setErrorHandler( ErrorHandler errorHandler ) { this.errorHandler = errorHandler; } /** * A hook to customize the handling of errors encountered while locating a service implementation. */ public static abstract class ErrorHandler { /** * Handles errors during creation of a service. The default implemention does nothing. * * @param type The interface describing the service, must not be {@code null}. * @param impl The implementation class of the service, must not be {@code null}. * @param exception The error that occurred while trying to instantiate the implementation class, must not be * {@code null}. */ public void serviceCreationFailed( Class type, Class impl, Throwable exception ) { } } }