Source code

001package org.apache.archiva.repository.connector;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.archiva.repository.ManagedRepository;
023import org.apache.archiva.repository.RemoteRepository;
024
025import java.util.List;
026
027/**
028 *
029 * A RepositoryConnector maps a managed repository to a remote repository.
030 *
031 *
032 */
033public interface RepositoryConnector
034{
035    /**
036     * Returns the local repository that is connected to the remote.
037     * @return The local managed repository.
038     */
039    ManagedRepository getSourceRepository();
040
041    /**
042     * Returns the remote repository that is connected to the local.
043     * @return The remote repository.
044     */
045    RemoteRepository getTargetRepository();
046
047    /**
048     * Returns a list of paths that are not fetched from the remote repository.
049     * @return A list of paths.
050     */
051    List<String> getBlacklist();
052
053    /**
054     * Returns a list of paths that are fetched from the remote repository, even if a
055     * parent path is in the blacklist.
056     *
057     * @return The list of paths.
058     */
059    List<String> getWhitelist();
060
061    /**
062     * Returns true, if this connector is enabled, otherwise false.
063     * @return True, if enabled.
064     */
065    boolean isEnabled();
066
067    /**
068     * Enables this connector, if it was disabled before, otherwise does nothing.
069     */
070    void enable();
071
072    /**
073     * Disables this connector, if it was enabled before, otherwise does nothing.
074     */
075    void disable();
076
077}