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

   1 package org.apache.archiva.indexer;
   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.archiva.model.ArtifactReference;
  23 import org.apache.archiva.repository.Repository;
  24 import org.apache.archiva.repository.RepositoryType;
  25
  26 import java.io.IOException;
  27 import java.net.URI;
  28
  29 public interface ArchivaIndexManager {
  30
  31     /**
  32      * Compresses the index to a more dense packed format.
  33      * @param context
  34      */
  35     void pack(ArchivaIndexingContext context) throws IndexUpdateFailedException;
  36
  37     /**
  38      * Rescans the whole repository, this index is associated to.
  39      * @param context
  40      * @param update
  41      */
  42     void scan(ArchivaIndexingContext context, boolean update) throws IndexUpdateFailedException;
  43
  44     /**
  45      * Updates the index from the remote url.
  46      * @param context
  47      * @param remoteUpdateUri
  48      * @param fullUpdate
  49      */
  50     void update(ArchivaIndexingContext context, URI remoteUpdateUri, boolean fullUpdate) throws IndexUpdateFailedException;
  51
  52     /**
  53      * Adds a artifact to the index.
  54      * @param context
  55      * @param artifactReference
  56      */
  57     void addArtifactToIndex(ArchivaIndexingContext context, ArtifactReference artifactReference) throws IndexUpdateFailedException;
  58
  59     /**
  60      * Removes a artifact from the index.
  61      * @param context
  62      * @param artifactReference
  63      */
  64     void removeArtifactFromIndex(ArchivaIndexingContext context, ArtifactReference artifactReference) throws IndexUpdateFailedException;
  65
  66
  67     /**
  68      * Returns true, if this manager is able to apply the index actions for the given repository type.
  69      * @param type
  70      * @return
  71      */
  72     boolean supportsRepository(RepositoryType type);
  73
  74     /**
  75      * Creates the indexing context for the given repository.
  76      * @param repository the repository for which the index context should be created
  77      * @return the index context
  78      */
  79     ArchivaIndexingContext createContext(Repository repository) throws IndexCreationFailedException;
  80 }