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

   1 package org.apache.archiva.repository;
   2 /*
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  * Unless required by applicable law or agreed to in writing,
  13  * software distributed under the License is distributed on an
  14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15  * KIND, either express or implied.  See the License for the
  16  * specific language governing permissions and limitations
  17  * under the License.
  18  */
  19
  20 import org.apache.archiva.configuration.Configuration;
  21 import org.apache.archiva.repository.validation.RepositoryChecker;
  22
  23 import java.util.Collection;
  24 import java.util.Map;
  25
  26 /**
  27  *
  28  * This is the generic interface that handles different repository flavours.
  29  *
  30  * @author Martin Stockhammer <martin_s@apache.org>
  31  */
  32 public interface RepositoryHandler<R extends Repository, C>
  33 {
  34
  35     /**
  36      * Creates instances from the archiva configuration. The instances are not registered in the registry.
  37      *
  38      * @return A map of (repository id, Repository) pairs
  39      */
  40     Map<String, R> newInstancesFromConfig();
  41
  42     /**
  43      * Creates a new instance without registering and without updating the archiva configuration
  44      *
  45      * @param type the repository type
  46      * @param id the repository identifier
  47      * @return the repository instance
  48      * @throws RepositoryException if the creation failed
  49      */
  50     R newInstance(RepositoryType type, String id) throws RepositoryException;
  51
  52     /**
  53      * Creates a new instance and updates the given configuration object.
  54      *
  55      * @param repositoryConfiguration the configuration instance
  56      * @return a newly created instance
  57      * @throws RepositoryException if the creation failed
  58      */
  59     R newInstance( C repositoryConfiguration ) throws RepositoryException;
  60
  61     /**
  62      * Adds the given repository to the registry or replaces a already existing repository in the registry.
  63      * If an error occurred during the update, it will revert to the old repository status.
  64      *
  65      * @param repository the repository
  66      * @return the created or updated repository instance
  67      * @throws RepositoryException if the update or creation failed
  68      */
  69     R put( R repository ) throws RepositoryException;
  70
  71     /**
  72      * Adds the repository to the registry, based on the given configuration.
  73      * If there is a repository registered with the given id, it is updated.
  74      * The archiva configuration is updated. The status is not defined, if an error occurs during update. The
  75      * The repository instance is registered and initialized if no error occurs
  76      *
  77      * @param repositoryConfiguration the repository configuration
  78      * @return the updated or created repository instance
  79      * @throws RepositoryException if the update or creation failed
  80      */
  81     R put( C repositoryConfiguration ) throws RepositoryException;
  82
  83     /**
  84      * Adds a repository from the given repository configuration. The changes are stored in
  85      * the configuration object. The archiva registry is not updated.
  86      * The returned repository instance is a clone of the registered repository instance. It is not registered
  87      * and not initialized. References are not updated.
  88      *
  89      * @param repositoryConfiguration the repository configuration
  90      * @param configuration the configuration instance
  91      * @return the repository instance that was created or updated
  92      * @throws RepositoryException if the update or creation failed
  93      */
  94     R put( C repositoryConfiguration, Configuration configuration ) throws RepositoryException;
  95
  96     /**
  97      * Adds or updates a repository from the given configuration data. The resulting repository is
  98      * checked by the repository checker and the result is returned.
  99      * If the checker returns a valid result, the registry is updated and configuration is saved.
 100      *
 101      * @param repositoryConfiguration the repository configuration
 102      * @param checker the checker that validates the repository data
 103      * @return the repository and the check result
 104      * @throws RepositoryException if the creation or update failed
 105      */
 106     <D> CheckedResult<R, D>
 107     putWithCheck( C repositoryConfiguration, RepositoryChecker<R, D> checker) throws RepositoryException;
 108
 109     /**
 110      * Removes the given repository from the registry and updates references and saves the new configuration.
 111      *
 112      * @param id The repository identifier
 113      * @throws RepositoryException if the repository could not be removed
 114      */
 115     void remove( final String id ) throws RepositoryException;
 116
 117     /**
 118      * Removes the given repository from the registry and updates only the given configuration instance.
 119      * The archiva registry is not updated
 120      *
 121      * @param id the repository identifier
 122      * @param configuration the configuration to update
 123      * @throws RepositoryException if the repository could not be removed
 124      */
 125     void remove( String id, Configuration configuration ) throws RepositoryException;
 126
 127     /**
 128      * Returns the repository with the given identifier or <code>null</code>, if it is not registered.
 129      *
 130      * @param id the repository id
 131      * @return if the retrieval failed
 132      */
 133     R get( String id );
 134
 135     /**
 136      * Clones a given repository without registering.
 137      *
 138      * @param repo the repository that should be cloned
 139      * @return a newly created instance with the same repository data
 140      */
 141     R clone(R repo) throws RepositoryException;
 142
 143     /**
 144      * Updates the references and stores updates in the given <code>configuration</code> instance.
 145      * The references that are updated depend on the concrete repository subclass <code>R</code>.
 146      * This method may register/unregister repositories depending on the implementation. That means there is no simple
 147      * way to roll back, if an error occurs.
 148      *
 149      * @param repo the repository for which references are updated
 150      * @param repositoryConfiguration the repository configuration
 151      */
 152     void updateReferences( R repo, C repositoryConfiguration ) throws RepositoryException;
 153
 154     /**
 155      * Returns all registered repositories.
 156      *
 157      * @return the list of repositories
 158      */
 159     Collection<R> getAll();
 160
 161     /**
 162      * Returns <code>true</code>, if the repository is registered with the given id, otherwise <code>false</code>
 163      * @param id the repository identifier
 164      * @return <code>true</code>, if it is registered, otherwise <code>false</code>
 165      */
 166     boolean has(String id);
 167
 168     /**
 169      * Initializes
 170      */
 171     void init();
 172
 173     /**
 174      * Closes the handler
 175      */
 176     void close();
 177
 178 }