|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625 |
- package org.apache.archiva.repository.base.group;
- /*
- * 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 org.apache.archiva.components.registry.RegistryException;
- import org.apache.archiva.configuration.Configuration;
- import org.apache.archiva.configuration.IndeterminateConfigurationException;
- import org.apache.archiva.configuration.RepositoryGroupConfiguration;
- import org.apache.archiva.indexer.merger.MergedRemoteIndexesScheduler;
- import org.apache.archiva.repository.base.ArchivaRepositoryRegistry;
- import org.apache.archiva.repository.base.ConfigurationHandler;
- import org.apache.archiva.repository.validation.CheckedResult;
- import org.apache.archiva.repository.EditableRepository;
- import org.apache.archiva.repository.EditableRepositoryGroup;
- import org.apache.archiva.repository.ManagedRepository;
- import org.apache.archiva.repository.Repository;
- import org.apache.archiva.repository.RepositoryException;
- import org.apache.archiva.repository.RepositoryGroup;
- import org.apache.archiva.repository.RepositoryHandler;
- import org.apache.archiva.repository.RepositoryProvider;
- import org.apache.archiva.repository.RepositoryType;
- import org.apache.archiva.repository.event.RepositoryEvent;
- import org.apache.archiva.repository.features.IndexCreationFeature;
- import org.apache.archiva.repository.storage.StorageAsset;
- import org.apache.archiva.repository.validation.CombinedValidator;
- import org.apache.archiva.repository.validation.RepositoryChecker;
- import org.apache.archiva.repository.validation.RepositoryValidator;
- import org.apache.archiva.repository.validation.ValidationResponse;
- import org.apache.commons.lang3.StringUtils;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- import org.springframework.stereotype.Service;
-
- import javax.annotation.PostConstruct;
- import javax.annotation.PreDestroy;
- import javax.inject.Named;
- import java.io.IOException;
- import java.nio.file.Files;
- import java.nio.file.Path;
- import java.util.Collection;
- import java.util.Collections;
- import java.util.HashMap;
- import java.util.LinkedHashMap;
- import java.util.List;
- import java.util.Map;
- import java.util.concurrent.locks.ReentrantReadWriteLock;
- import java.util.stream.Collectors;
-
- import static org.apache.archiva.indexer.ArchivaIndexManager.DEFAULT_INDEX_PATH;
-
- /**
- * This class manages repository groups for the RepositoryRegistry.
- * It is tightly coupled with the {@link ArchivaRepositoryRegistry}.
- *
- * @author Martin Stockhammer <martin_s@apache.org>
- */
- @Service( "repositoryGroupHandler#default" )
- public class RepositoryGroupHandler implements RepositoryHandler<RepositoryGroup, RepositoryGroupConfiguration>
- {
- private static final Logger log = LoggerFactory.getLogger( RepositoryGroupHandler.class );
-
- private final ArchivaRepositoryRegistry repositoryRegistry;
- private final ConfigurationHandler configurationHandler;
- private final MergedRemoteIndexesScheduler mergedRemoteIndexesScheduler;
-
- private final Map<String, RepositoryGroup> repositoryGroups = new HashMap<>( );
- private final RepositoryValidator<RepositoryGroup> validator;
-
- private Path groupsDirectory;
-
-
- /**
- * Creates a new instance. All dependencies are injected on the constructor.
- *
- * @param repositoryRegistry the registry. To avoid circular dependencies via DI, this class registers itself on the registry.
- * @param configurationHandler the configuration handler is used to retrieve and save configuration.
- * @param mergedRemoteIndexesScheduler the index scheduler is used for merging the indexes from all group members
- */
- public RepositoryGroupHandler( ArchivaRepositoryRegistry repositoryRegistry,
- ConfigurationHandler configurationHandler,
- @Named( "mergedRemoteIndexesScheduler#default" ) MergedRemoteIndexesScheduler mergedRemoteIndexesScheduler,
- List<RepositoryValidator<? extends Repository>> repositoryGroupValidatorList
- )
- {
- this.configurationHandler = configurationHandler;
- this.mergedRemoteIndexesScheduler = mergedRemoteIndexesScheduler;
- this.repositoryRegistry = repositoryRegistry;
- List<RepositoryValidator<RepositoryGroup>> validatorList = initValidators( repositoryGroupValidatorList );
- this.validator = new CombinedValidator<>( RepositoryGroup.class, validatorList );
- }
-
- private List<RepositoryValidator<RepositoryGroup>> initValidators(List<RepositoryValidator<? extends Repository>> repositoryGroupValidatorList) {
- if (repositoryGroupValidatorList!=null && repositoryGroupValidatorList.size()>0) {
- return repositoryGroupValidatorList.stream( ).filter(
- v -> v.isFlavour( RepositoryGroup.class )
- ).map( v -> v.narrowTo( RepositoryGroup.class ) ).collect( Collectors.toList( ) );
- } else {
- return Collections.emptyList( );
- }
- }
-
- @Override
- @PostConstruct
- public void init( )
- {
- log.debug( "Initializing repository group handler " + repositoryRegistry.toString( ) );
- initializeStorage( );
- // We are registering this class on the registry. This is necessary to avoid circular dependencies via injection.
- this.repositoryRegistry.registerGroupHandler( this );
- }
-
- public void initializeFromConfig( )
- {
- this.repositoryGroups.clear( );
- this.repositoryGroups.putAll( newInstancesFromConfig( ) );
- for ( RepositoryGroup group : this.repositoryGroups.values( ) )
- {
- initializeGroup( group );
- }
- }
-
- private void initializeStorage( )
- {
- Path baseDir = this.configurationHandler.getArchivaConfiguration( ).getRepositoryGroupBaseDir( );
- if ( !Files.exists( baseDir ) )
- {
- try
- {
- Files.createDirectories( baseDir );
- }
- catch ( IOException e )
- {
- log.error( "Could not create group base directory: {}", e.getMessage( ), e );
- }
- }
- this.groupsDirectory = baseDir;
- }
-
- private void initializeGroup( RepositoryGroup repositoryGroup )
- {
- StorageAsset indexDirectory = getMergedIndexDirectory( repositoryGroup );
- if ( !indexDirectory.exists( ) )
- {
- try
- {
- indexDirectory.create( );
- }
- catch ( IOException e )
- {
- log.error( "Could not create index directory {} for group {}: {}", indexDirectory, repositoryGroup.getId( ), e.getMessage( ) );
- }
- }
- Path groupPath = groupsDirectory.resolve( repositoryGroup.getId( ) );
- if ( !Files.exists( groupPath ) )
- {
- try
- {
- Files.createDirectories( groupPath );
- }
- catch ( IOException e )
- {
- log.error( "Could not create repository group directory {}", groupPath );
- }
- }
- mergedRemoteIndexesScheduler.schedule( repositoryGroup,
- indexDirectory );
- }
-
- public StorageAsset getMergedIndexDirectory( RepositoryGroup group )
- {
- if ( group != null )
- {
- return group.getFeature( IndexCreationFeature.class ).get( ).getLocalIndexPath( );
- }
- else
- {
- return null;
- }
- }
-
-
- @Override
- public Map<String, RepositoryGroup> newInstancesFromConfig( )
- {
- try
- {
- List<RepositoryGroupConfiguration> repositoryGroupConfigurations =
- this.configurationHandler.getBaseConfiguration( ).getRepositoryGroups( );
-
- if ( repositoryGroupConfigurations == null )
- {
- return Collections.emptyMap( );
- }
-
- Map<String, RepositoryGroup> repositoryGroupMap = new LinkedHashMap<>( repositoryGroupConfigurations.size( ) );
-
- Map<RepositoryType, RepositoryProvider> providerMap = repositoryRegistry.getRepositoryProviderMap( );
- for ( RepositoryGroupConfiguration repoConfig : repositoryGroupConfigurations )
- {
- RepositoryType repositoryType = RepositoryType.valueOf( repoConfig.getType( ) );
- if ( providerMap.containsKey( repositoryType ) )
- {
- try
- {
- RepositoryGroup repo = createNewRepositoryGroup( providerMap.get( repositoryType ), repoConfig );
- repositoryGroupMap.put( repo.getId( ), repo );
- }
- catch ( Exception e )
- {
- log.error( "Could not create repository group {}: {}", repoConfig.getId( ), e.getMessage( ), e );
- }
- }
- }
- return repositoryGroupMap;
- }
- catch ( Throwable e )
- {
- log.error( "Could not initialize repositories from config: {}", e.getMessage( ), e );
- return Collections.emptyMap( );
- }
- }
-
- @Override
- public RepositoryGroup newInstance( final RepositoryType type, String id ) throws RepositoryException
- {
- RepositoryProvider provider = repositoryRegistry.getProvider( type );
- RepositoryGroupConfiguration config = new RepositoryGroupConfiguration( );
- config.setId( id );
- return createNewRepositoryGroup( provider, config );
- }
-
- @Override
- public RepositoryGroup newInstance( final RepositoryGroupConfiguration repositoryConfiguration ) throws RepositoryException
- {
- RepositoryType type = RepositoryType.valueOf( repositoryConfiguration.getType( ) );
- RepositoryProvider provider = repositoryRegistry.getProvider( type );
- return createNewRepositoryGroup( provider, repositoryConfiguration );
- }
-
- private RepositoryGroup createNewRepositoryGroup( RepositoryProvider provider, RepositoryGroupConfiguration config ) throws RepositoryException
- {
- RepositoryGroup repositoryGroup = provider.createRepositoryGroup( config );
- updateReferences( repositoryGroup, config );
- return repositoryGroup;
- }
-
-
- /**
- * Adds a new repository group to the current list, or replaces the repository group definition with
- * the same id, if it exists already.
- * The change is saved to the configuration immediately.
- *
- * @param repositoryGroup the new repository group.
- * @throws RepositoryException if the new repository group could not be saved to the configuration.
- */
- @Override
- public RepositoryGroup put( final RepositoryGroup repositoryGroup ) throws RepositoryException
- {
- final String id = repositoryGroup.getId( );
- RepositoryGroup originRepoGroup = repositoryGroups.remove( id );
- try
- {
- if ( originRepoGroup != null && originRepoGroup != repositoryGroup )
- {
- this.mergedRemoteIndexesScheduler.unschedule( originRepoGroup );
- originRepoGroup.close( );
- }
- RepositoryProvider provider = repositoryRegistry.getProvider( repositoryGroup.getType( ) );
- RepositoryGroupConfiguration newCfg = provider.getRepositoryGroupConfiguration( repositoryGroup );
- ReentrantReadWriteLock.WriteLock configLock = this.configurationHandler.getLock( ).writeLock( );
- configLock.lock( );
- try
- {
- Configuration configuration = this.configurationHandler.getBaseConfiguration( );
- updateReferences( repositoryGroup, newCfg );
- RepositoryGroupConfiguration oldCfg = configuration.findRepositoryGroupById( id );
- if ( oldCfg != null )
- {
- configuration.removeRepositoryGroup( oldCfg );
- }
- configuration.addRepositoryGroup( newCfg );
- configurationHandler.save( configuration, ConfigurationHandler.REGISTRY_EVENT_TAG );
- initializeGroup( repositoryGroup );
- }
- finally
- {
- configLock.unlock( );
- }
- repositoryGroups.put( id, repositoryGroup );
- return repositoryGroup;
- }
- catch ( Exception e )
- {
- // Rollback
- if ( originRepoGroup != null )
- {
- repositoryGroups.put( id, originRepoGroup );
- }
- else
- {
- repositoryGroups.remove( id );
- }
- log.error( "Exception during configuration update {}", e.getMessage( ), e );
- throw new RepositoryException( "Could not save the configuration" + ( e.getMessage( ) == null ? "" : ": " + e.getMessage( ) ), e);
- }
- }
-
- /**
- * Adds a new repository group or updates the repository with the same id, if it exists already.
- * The configuration is saved immediately.
- *
- * @param repositoryGroupConfiguration the repository configuration
- * @return the updated or created repository
- * @throws RepositoryException if an error occurs, or the configuration is not valid.
- */
- @Override
- public RepositoryGroup put( RepositoryGroupConfiguration repositoryGroupConfiguration ) throws RepositoryException
- {
- final String id = repositoryGroupConfiguration.getId( );
- final RepositoryType repositoryType = RepositoryType.valueOf( repositoryGroupConfiguration.getType( ) );
- final RepositoryProvider provider = repositoryRegistry.getProvider( repositoryType );
- RepositoryGroup currentRepository;
- ReentrantReadWriteLock.WriteLock configLock = this.configurationHandler.getLock( ).writeLock( );
- configLock.lock( );
- try
- {
- Configuration configuration = this.configurationHandler.getBaseConfiguration( );
- currentRepository = repositoryRegistry.getRepositoryGroup( id );
- RepositoryGroup oldRepository = currentRepository == null ? null : clone( currentRepository );
- try
- {
-
- if (currentRepository==null) {
- currentRepository = put( repositoryGroupConfiguration, configuration );
- } else
- {
- setRepositoryGroupDefaults( repositoryGroupConfiguration );
- provider.updateRepositoryGroupInstance( (EditableRepositoryGroup) currentRepository, repositoryGroupConfiguration );
- }
- configurationHandler.save( configuration, ConfigurationHandler.REGISTRY_EVENT_TAG );
- updateReferences( currentRepository, repositoryGroupConfiguration );
- initializeGroup( currentRepository );
- this.repositoryGroups.put( id, currentRepository );
- }
- catch ( IndeterminateConfigurationException | RegistryException | RepositoryException e )
- {
- // Trying a rollback
- if ( oldRepository != null )
- {
- RepositoryGroupConfiguration oldCfg = provider.getRepositoryGroupConfiguration( oldRepository );
- provider.updateRepositoryGroupInstance( (EditableRepositoryGroup) currentRepository, oldCfg);
- replaceOrAddRepositoryConfig( oldCfg, configuration );
- try
- {
- configurationHandler.save( configuration, ConfigurationHandler.REGISTRY_EVENT_TAG );
- }
- catch ( IndeterminateConfigurationException | RegistryException indeterminateConfigurationException )
- {
- log.error( "Fatal error, config save during rollback failed: {}", e.getMessage( ), e );
- }
- updateReferences( oldRepository, oldCfg );
- initializeGroup( oldRepository );
- }
- log.error( "Could not save the configuration for repository group {}: {}", id, e.getMessage( ), e );
- if (e instanceof RepositoryException) {
- throw (RepositoryException) e;
- } else
- {
- throw new RepositoryException( "Could not save the configuration for repository group " + id + ": " + e.getMessage( ) );
- }
- }
- }
- finally
- {
- configLock.unlock( );
- }
- return currentRepository;
- }
-
- @Override
- public RepositoryGroup put( RepositoryGroupConfiguration repositoryGroupConfiguration, Configuration configuration ) throws RepositoryException
- {
- final String id = repositoryGroupConfiguration.getId( );
- final RepositoryType repoType = RepositoryType.valueOf( repositoryGroupConfiguration.getType( ) );
- RepositoryGroup repo;
- setRepositoryGroupDefaults( repositoryGroupConfiguration );
- if ( repositoryGroups.containsKey( id ) )
- {
- repo = clone( repositoryGroups.get( id ) );
- if ( repo instanceof EditableRepositoryGroup )
- {
- repositoryRegistry.getProvider( repoType ).updateRepositoryGroupInstance( (EditableRepositoryGroup) repo, repositoryGroupConfiguration );
- }
- else
- {
- throw new RepositoryException( "The repository is not editable " + id );
- }
- }
- else
- {
- repo = repositoryRegistry.getProvider( repoType ).createRepositoryGroup( repositoryGroupConfiguration );
- }
- replaceOrAddRepositoryConfig( repositoryGroupConfiguration, configuration );
- updateReferences( repo, repositoryGroupConfiguration );
- return repo;
- }
-
- @Override
- public <D> CheckedResult<RepositoryGroup, D> putWithCheck( RepositoryGroupConfiguration repositoryConfiguration, RepositoryChecker<RepositoryGroup, D> checker ) throws RepositoryException
- {
- final String id = repositoryConfiguration.getId( );
- RepositoryGroup currentGroup = repositoryGroups.get( id );
- Configuration configuration = configurationHandler.getBaseConfiguration( );
- RepositoryGroup repositoryGroup = put( repositoryConfiguration, configuration );
- CheckedResult<RepositoryGroup, D> result;
- if ( currentGroup == null )
- {
- result = checker.apply( repositoryGroup );
- }
- else
- {
- result = checker.applyForUpdate( repositoryGroup );
- }
- if ( result.isValid( ) )
- {
- put( result.getRepository() );
- }
- return result;
- }
-
-
- private void setRepositoryGroupDefaults( RepositoryGroupConfiguration repositoryGroupConfiguration )
- {
- if ( StringUtils.isEmpty( repositoryGroupConfiguration.getMergedIndexPath( ) ) )
- {
- repositoryGroupConfiguration.setMergedIndexPath( DEFAULT_INDEX_PATH );
- }
- if ( repositoryGroupConfiguration.getMergedIndexTtl( ) <= 0 )
- {
- repositoryGroupConfiguration.setMergedIndexTtl( 300 );
- }
- if ( StringUtils.isEmpty( repositoryGroupConfiguration.getCronExpression( ) ) )
- {
- repositoryGroupConfiguration.setCronExpression( "0 0 03 ? * MON" );
- }
- }
-
- private void replaceOrAddRepositoryConfig( RepositoryGroupConfiguration repositoryGroupConfiguration, Configuration configuration )
- {
- RepositoryGroupConfiguration oldCfg = configuration.findRepositoryGroupById( repositoryGroupConfiguration.getId( ) );
- if ( oldCfg != null )
- {
- configuration.removeRepositoryGroup( oldCfg );
- }
- configuration.addRepositoryGroup( repositoryGroupConfiguration );
- }
-
- public void removeRepositoryFromGroups( ManagedRepository repo )
- {
- if ( repo != null )
- {
- repositoryGroups.values( ).stream( ).filter( repoGroup -> repoGroup instanceof EditableRepository ).
- map( repoGroup -> (EditableRepositoryGroup) repoGroup ).forEach( repoGroup -> repoGroup.removeRepository( repo ) );
- }
- }
-
- /**
- * Removes a repository group from the registry and configuration, if it exists.
- * The change is saved to the configuration immediately.
- *
- * @param id the id of the repository group to remove
- * @throws RepositoryException if a error occurs during configuration save
- */
- @Override
- public void remove( final String id ) throws RepositoryException
- {
- RepositoryGroup repo = get( id );
- if ( repo != null )
- {
- try
- {
- repo = repositoryGroups.remove( id );
- if ( repo != null )
- {
- this.mergedRemoteIndexesScheduler.unschedule( repo );
- repo.close( );
- Configuration configuration = this.configurationHandler.getBaseConfiguration( );
- RepositoryGroupConfiguration cfg = configuration.findRepositoryGroupById( id );
- if ( cfg != null )
- {
- configuration.removeRepositoryGroup( cfg );
- }
- this.configurationHandler.save( configuration, ConfigurationHandler.REGISTRY_EVENT_TAG );
- }
-
- }
- catch ( RegistryException | IndeterminateConfigurationException e )
- {
- // Rollback
- log.error( "Could not save config after repository removal: {}", e.getMessage( ), e );
- repositoryGroups.put( repo.getId( ), repo );
- throw new RepositoryException( "Could not save configuration after repository removal: " + e.getMessage( ) );
- }
- }
- }
-
- @Override
- public void remove( String id, Configuration configuration ) throws RepositoryException
- {
- RepositoryGroup repo = repositoryGroups.get( id );
- if ( repo != null )
- {
- repo = repositoryGroups.remove( id );
- if ( repo != null )
- {
- this.mergedRemoteIndexesScheduler.unschedule( repo );
- repo.close( );
- RepositoryGroupConfiguration cfg = configuration.findRepositoryGroupById( id );
- if ( cfg != null )
- {
- configuration.removeRepositoryGroup( cfg );
- }
- }
- }
-
- }
-
- @Override
- public RepositoryGroup get( String groupId )
- {
- return repositoryGroups.get( groupId );
- }
-
- @Override
- public RepositoryGroup clone( RepositoryGroup repo ) throws RepositoryException
- {
- RepositoryProvider provider = repositoryRegistry.getProvider( repo.getType( ) );
- RepositoryGroupConfiguration cfg = provider.getRepositoryGroupConfiguration( repo );
- RepositoryGroup cloned = provider.createRepositoryGroup( cfg );
- cloned.registerEventHandler( RepositoryEvent.ANY, repositoryRegistry );
- return cloned;
- }
-
- @Override
- public void updateReferences( RepositoryGroup repo, RepositoryGroupConfiguration repositoryConfiguration ) throws RepositoryException
- {
- if ( repo instanceof EditableRepositoryGroup )
- {
- EditableRepositoryGroup eGroup = (EditableRepositoryGroup) repo;
- eGroup.setRepositories( repositoryConfiguration.getRepositories( ).stream( )
- .map( repositoryRegistry::getManagedRepository ).collect( Collectors.toList( ) ) );
- }
-
- }
-
- @Override
- public Collection<RepositoryGroup> getAll( )
- {
- return repositoryGroups.values( );
- }
-
- @Override
- public RepositoryValidator<RepositoryGroup> getValidator( )
- {
- return this.validator;
- }
-
- @Override
- public ValidationResponse<RepositoryGroup> validateRepository( RepositoryGroup repository )
- {
- return null;
- }
-
- @Override
- public ValidationResponse<RepositoryGroup> validateRepositoryForUpdate( RepositoryGroup repository )
- {
- return null;
- }
-
- @Override
- public boolean has( String id )
- {
- return repositoryGroups.containsKey( id );
- }
-
- @PreDestroy
- private void destroy( )
- {
- this.close( );
- }
-
- @Override
- public void close( )
- {
- for ( RepositoryGroup group : repositoryGroups.values( ) )
- {
- try
- {
- mergedRemoteIndexesScheduler.unschedule( group );
- group.close( );
- }
- catch ( Throwable e )
- {
- log.error( "Could not close repository group {}: {}", group.getId( ), e.getMessage( ) );
- }
- }
- this.repositoryGroups.clear( );
- }
-
- }
|