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

   1 package org.apache.maven.archiva.consumers;
   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 org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  23
  24 import java.util.Date;
  25 import java.util.List;
  26
  27 /**
  28  * A consumer of content (files) in the repository.
  29  *
  30  * @version $Id$
  31  */
  32 public interface RepositoryContentConsumer extends Consumer
  33 {
  34     /**
  35      * Get the list of included file patterns for this consumer.
  36      *
  37      * @return the list of {@link String} patterns. (example: <code>"**<span />/*.pom"</code>)
  38      */
  39     public List<String> getIncludes();
  40
  41     /**
  42      * Get the list of excluded file patterns for this consumer.
  43      *
  44      * @return the list of {@link String} patterns. (example: <code>"**<span />/*.pom"</code>) - (can be null for no exclusions)
  45      */
  46     public List<String> getExcludes();
  47
  48     /**
  49      * <p>
  50      * Event that triggers at the beginning of a scan.
  51      * </p>
  52      *
  53      * <p>
  54      * NOTE: This would be a good place to initialize the consumer, to lock any resources, and to
  55      * generally start tracking the scan as a whole.
  56      * </p>
  57      *
  58      * @param repository the repository that this consumer is being used for.
  59      * @param whenGathered the start of the repository scan
  60      * @throws ConsumerException if there was a problem with using the provided repository with the consumer.
  61      */
  62     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered ) throws ConsumerException;
  63
  64     /**
  65      * <p>
  66      * Event indicating a file is to be processed by this consumer.
  67      * </p>
  68      *
  69      * <p>
  70      * NOTE: The consumer does not need to process the file immediately, can can opt to queue and/or track
  71      * the files to be processed in batch.  Just be sure to complete the processing by the {@link #completeScan()}
  72      * event.
  73      * </p>
  74      *
  75      * @param path the relative file path (in the repository) to process.
  76      * @throws ConsumerException if there was a problem processing this file.
  77      */
  78     public void processFile( String path ) throws ConsumerException;
  79
  80     /**
  81      * <p>
  82      * Event that triggers on the completion of a scan.
  83      * </p>
  84      *
  85      * <p>
  86      * NOTE: If the consumer opted to batch up processing requests in the {@link #processFile(String)} event
  87      * this would be the last opportunity to drain any processing queue's.
  88      * </p>
  89      */
  90     public void completeScan();
  91
  92     /**
  93      * Whether the consumer should process files that have not been modified since the time passed in to the scan
  94      * method.
  95      * @return whether to process the unmodified files
  96      */
  97     boolean isProcessUnmodified();
  98 }