source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.repository.base;
   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 com.cronutils.model.CronType;
  23 import com.cronutils.model.definition.CronDefinition;
  24 import com.cronutils.model.definition.CronDefinitionBuilder;
  25 import com.cronutils.parser.CronParser;
  26 import org.apache.archiva.event.Event;
  27 import org.apache.archiva.event.EventHandler;
  28 import org.apache.archiva.event.EventManager;
  29 import org.apache.archiva.event.EventType;
  30 import org.apache.archiva.indexer.ArchivaIndexingContext;
  31 import org.apache.archiva.repository.EditableRepository;
  32 import org.apache.archiva.repository.RepositoryCapabilities;
  33 import org.apache.archiva.repository.RepositoryType;
  34 import org.apache.archiva.repository.UnsupportedFeatureException;
  35 import org.apache.archiva.repository.event.*;
  36 import org.apache.archiva.repository.storage.RepositoryStorage;
  37 import org.apache.archiva.repository.storage.StorageAsset;
  38 import org.apache.archiva.repository.features.RepositoryFeature;
  39 import org.apache.archiva.repository.features.StagingRepositoryFeature;
  40 import org.apache.commons.lang3.StringUtils;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 import java.io.IOException;
  45 import java.io.InputStream;
  46 import java.io.OutputStream;
  47 import java.net.URI;
  48 import java.nio.channels.ReadableByteChannel;
  49 import java.nio.channels.WritableByteChannel;
  50 import java.nio.file.CopyOption;
  51 import java.util.Collections;
  52 import java.util.HashMap;
  53 import java.util.HashSet;
  54 import java.util.Locale;
  55 import java.util.Map;
  56 import java.util.Set;
  57 import java.util.concurrent.atomic.AtomicBoolean;
  58 import java.util.function.Consumer;
  59
  60 /**
  61  * Implementation of a repository with the necessary fields for a bare repository.
  62  * No features are provided. Capabilities and features must be implemented by concrete classes.
  63  *
  64  */
  65 public abstract class AbstractRepository implements EditableRepository, EventHandler<RepositoryEvent>
  66 {
  67
  68
  69     Logger log = LoggerFactory.getLogger(AbstractRepository.class);
  70
  71     private final AtomicBoolean openStatus = new AtomicBoolean(false);
  72
  73
  74     private final RepositoryType type;
  75     private final String id;
  76     private Map<Locale, String> names = new HashMap<>(  );
  77     private Map<Locale, String> descriptions = new HashMap<>(  );
  78
  79     private Locale primaryLocale = new Locale("en_US");
  80     protected URI location;
  81     private URI baseUri;
  82     private Set<URI> failoverLocations = new HashSet<>(  );
  83     private Set<URI> uFailoverLocations = Collections.unmodifiableSet( failoverLocations );
  84     private boolean scanned = true;
  85     String schedulingDefinition = "0 0 02 * * ?";
  86     private String layout = "default";
  87     public static final CronDefinition CRON_DEFINITION = CronDefinitionBuilder.instanceDefinitionFor(CronType.QUARTZ);
  88
  89     private final EventManager eventManager;
  90
  91     Map<Class<? extends RepositoryFeature<?>>, RepositoryFeature<?>> featureMap = new HashMap<>(  );
  92
  93     private ArchivaIndexingContext indexingContext;
  94     private RepositoryStorage storage;
  95
  96     public AbstractRepository(RepositoryType type, String id, String name, RepositoryStorage repositoryStorage) {
  97         this.id = id;
  98         this.names.put( primaryLocale, name);
  99         this.type = type;
 100         this.storage = repositoryStorage;
 101         this.location = repositoryStorage.getLocation();
 102         this.openStatus.compareAndSet(false, true);
 103         this.eventManager = new EventManager(this);
 104     }
 105
 106     public AbstractRepository(Locale primaryLocale, RepositoryType type, String id, String name, RepositoryStorage repositoryStorage) {
 107         setPrimaryLocale( primaryLocale );
 108         this.id = id;
 109         this.names.put( primaryLocale, name);
 110         this.type = type;
 111         this.storage = repositoryStorage;
 112         this.location = repositoryStorage.getLocation();
 113         this.openStatus.compareAndSet(false, true);
 114         this.eventManager = new EventManager(this);
 115     }
 116
 117     protected void setPrimaryLocale(Locale locale) {
 118         this.primaryLocale = locale;
 119     }
 120
 121     @Override
 122     public String getId( )
 123     {
 124         return id;
 125     }
 126
 127     @Override
 128     public String getName( )
 129     {
 130         return getName( primaryLocale );
 131     }
 132
 133     @Override
 134     public String getName( Locale locale )
 135     {
 136         return names.get(locale);
 137     }
 138
 139     @Override
 140     public String getDescription( )
 141     {
 142         return getDescription( primaryLocale );
 143     }
 144
 145     @Override
 146     public String getDescription( Locale locale )
 147     {
 148         return descriptions.get(primaryLocale);
 149     }
 150
 151     @Override
 152     public RepositoryType getType( )
 153     {
 154         return type;
 155     }
 156
 157     @Override
 158     public URI getLocation( )
 159     {
 160         return location;
 161     }
 162
 163     @Override
 164     public StorageAsset getLocalPath() {
 165         return storage.getRoot( );
 166     }
 167
 168     @Override
 169     public StorageAsset getRoot( )
 170     {
 171         return storage.getRoot( );
 172     }
 173
 174     @Override
 175     public Set<URI> getFailoverLocations( )
 176     {
 177         return uFailoverLocations;
 178     }
 179
 180     @Override
 181     public boolean isScanned( )
 182     {
 183         return scanned;
 184     }
 185
 186     @Override
 187     public String getSchedulingDefinition( )
 188     {
 189         return schedulingDefinition;
 190     }
 191
 192     @Override
 193     public abstract boolean hasIndex( );
 194
 195     @Override
 196     public String getLayout( )
 197     {
 198         return layout;
 199     }
 200
 201     @Override
 202     public abstract RepositoryCapabilities getCapabilities( );
 203
 204     @SuppressWarnings( "unchecked" )
 205     @Override
 206     public <T extends RepositoryFeature<T>> RepositoryFeature<T> getFeature( Class<T> clazz ) throws UnsupportedFeatureException
 207     {
 208         if (featureMap.containsKey( clazz )) {
 209             return (RepositoryFeature<T>) featureMap.get(clazz);
 210         } else
 211         {
 212             throw new UnsupportedFeatureException( "Feature " + clazz + " not supported" );
 213         }
 214     }
 215
 216     @Override
 217     public <T extends RepositoryFeature<T>> boolean supportsFeature( Class<T> clazz )
 218     {
 219         return featureMap.containsKey( clazz );
 220     }
 221
 222     @Override
 223     public Locale getPrimaryLocale( )
 224     {
 225         return primaryLocale;
 226     }
 227
 228     @Override
 229     public void setName( Locale locale, String name )
 230     {
 231         names.put(locale, name);
 232     }
 233
 234     @Override
 235     public void setDescription( Locale locale, String description )
 236     {
 237         descriptions.put(locale, description);
 238     }
 239
 240     @Override
 241     public void setLocation( final URI location )
 242     {
 243         if (location!=null && ( this.location == null || !this.location.equals(location))) {
 244             try {
 245                 updateLocation(location);
 246             } catch (IOException e) {
 247                 log.error("Could not update location of repository {} to {}", getId(), location, e);
 248             }
 249         }
 250     }
 251
 252     @Override
 253     public void updateLocation(URI newLocation) throws IOException {
 254         storage.updateLocation(newLocation);
 255         this.location = newLocation;
 256     }
 257
 258     @Override
 259     public void addFailoverLocation( URI location )
 260     {
 261         this.failoverLocations.add(location);
 262     }
 263
 264     @Override
 265     public void removeFailoverLocation( URI location )
 266     {
 267         this.failoverLocations.remove( location );
 268     }
 269
 270     @Override
 271     public void clearFailoverLocations( )
 272     {
 273         this.failoverLocations.clear();
 274     }
 275
 276     @Override
 277     public void setScanned( boolean scanned )
 278     {
 279         this.scanned = scanned;
 280     }
 281
 282     @Override
 283     public void setLayout( String layout )
 284     {
 285         this.layout = layout;
 286     }
 287
 288     @Override
 289     public void setBaseUri(URI baseUri) {
 290         this.baseUri = baseUri;
 291     }
 292
 293     @Override
 294     public void setSchedulingDefinition(String cronExpression) {
 295         if (StringUtils.isNotEmpty( cronExpression ))
 296         {
 297             CronParser parser = new CronParser( CRON_DEFINITION );
 298             parser.parse( cronExpression ).validate( );
 299         }
 300         this.schedulingDefinition = cronExpression;
 301     }
 302
 303     @SuppressWarnings( "unchecked" )
 304     protected <T extends RepositoryFeature<T>> void addFeature(RepositoryFeature<T> feature) {
 305        featureMap.put( (Class<? extends RepositoryFeature<?>>) feature.getClass(), feature);
 306     }
 307
 308     @Override
 309     public void setIndexingContext(ArchivaIndexingContext context) {
 310         if (this.indexingContext!=null) {
 311
 312         }
 313         this.indexingContext = context;
 314     }
 315
 316     @Override
 317     public ArchivaIndexingContext getIndexingContext() {
 318         return indexingContext;
 319     }
 320
 321     @Override
 322     public void close() {
 323         if (this.openStatus.compareAndSet(true, false)) {
 324             ArchivaIndexingContext ctx = getIndexingContext();
 325             if (ctx != null) {
 326                 try {
 327                     ctx.close();
 328                 } catch (IOException e) {
 329                     log.warn("Error during index context close.", e);
 330                 }
 331                 this.indexingContext = null;
 332
 333             }
 334             if (supportsFeature(StagingRepositoryFeature.class)) {
 335                 StagingRepositoryFeature sf = getFeature(StagingRepositoryFeature.class).get();
 336                 if (sf.getStagingRepository() != null) {
 337                     sf.getStagingRepository().close();
 338                 }
 339             }
 340         }
 341
 342     }
 343
 344     @Override
 345     public boolean isOpen() {
 346         return openStatus.get();
 347     }
 348
 349     @Override
 350     public void handle(RepositoryEvent event) {
 351         // We just rethrow the events
 352         eventManager.fireEvent(event);
 353     }
 354
 355     @Override
 356     public <T extends Event> void registerEventHandler( EventType<T> eventType, EventHandler<? super T> eventHandler) {
 357         if (!EventType.isInstanceOf(eventType, RepositoryEvent.ANY)) {
 358             throw new IllegalArgumentException("Can only register RepositoryEvent Handlers");
 359         }
 360         eventManager.registerEventHandler(eventType, eventHandler);
 361     }
 362
 363     @Override
 364     public <T extends Event> void unregisterEventHandler(EventType<T> type, EventHandler<? super T> eventHandler) {
 365         eventManager.unregisterEventHandler(type, eventHandler);
 366     }
 367
 368     @Override
 369     public StorageAsset getAsset(String path )
 370     {
 371         return storage.getAsset(path);
 372     }
 373
 374     @Override
 375     public StorageAsset addAsset( String path, boolean container )
 376     {
 377         return storage.addAsset(path, container);
 378     }
 379
 380     @Override
 381     public void removeAsset( StorageAsset asset ) throws IOException
 382     {
 383         storage.removeAsset(asset);
 384     }
 385
 386     @Override
 387     public StorageAsset moveAsset( StorageAsset origin, String destination, CopyOption... copyOptions ) throws IOException
 388     {
 389         return storage.moveAsset(origin, destination);
 390     }
 391
 392     @Override
 393     public void moveAsset( StorageAsset origin, StorageAsset destination, CopyOption... copyOptions ) throws IOException
 394     {
 395         storage.moveAsset( origin, destination, copyOptions );
 396     }
 397
 398     @Override
 399     public StorageAsset copyAsset( StorageAsset origin, String destination, CopyOption... copyOptions ) throws IOException
 400     {
 401         return storage.copyAsset(origin, destination);
 402     }
 403
 404     @Override
 405     public void copyAsset( StorageAsset origin, StorageAsset destination, CopyOption... copyOptions ) throws IOException
 406     {
 407         storage.copyAsset( origin, destination, copyOptions);
 408     }
 409
 410     @Override
 411     public void consumeData(StorageAsset asset, Consumer<InputStream> consumerFunction, boolean readLock ) throws IOException
 412     {
 413         storage.consumeData(asset, consumerFunction, readLock);
 414     }
 415
 416     @Override
 417     public void consumeDataFromChannel( StorageAsset asset, Consumer<ReadableByteChannel> consumerFunction, boolean readLock ) throws IOException
 418     {
 419         storage.consumeDataFromChannel( asset, consumerFunction, readLock );
 420     }
 421
 422     @Override
 423     public void writeData( StorageAsset asset, Consumer<OutputStream> consumerFunction, boolean writeLock ) throws IOException
 424     {
 425         storage.writeData( asset, consumerFunction, writeLock );
 426     }
 427
 428     @Override
 429     public void writeDataToChannel( StorageAsset asset, Consumer<WritableByteChannel> consumerFunction, boolean writeLock ) throws IOException
 430     {
 431         storage.writeDataToChannel( asset, consumerFunction, writeLock );
 432     }
 433
 434     protected void setStorage( RepositoryStorage storage) {
 435         this.storage = storage;
 436     }
 437
 438     protected RepositoryStorage getStorage() {
 439         return storage;
 440     }
 441 }