archiva/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/EditableRepository.java

package org.apache.archiva.repository;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.archiva.indexer.ArchivaIndexingContext;

import java.net.URI;
import java.util.Locale;

/**
 * This is the editable part of a repository.
 * Normally a repository should also implement this interface but it is not
 * required.
 *
 * Capabilities and features are a integral part of the implementation and not
 * provided here by the interface.
 * Feature setting methods are provided by the features itself.
 *
 */
public interface EditableRepository extends Repository
{

    /**
     * Returns the primary locale used for setting the default values for
     * name and description.
     *
     * @return The locale used for name and description when they are not set
     */
    Locale getPrimaryLocale();

    /**
     * Sets the name for the given locale
     *
     * @param locale the locale for which the name is set
     * @param name The name value in the language that matches the locale
     */
    void setName( Locale locale, String name);

    /**
     * Sets the description for the given locale
     *
     * @param locale the locale for which the description is set
     * @param description The description in the language that matches the locale.
     */
    void setDescription(Locale locale, String description);

    /**
     * Sets the location of the repository. May be a URI that is suitable for the
     * repository implementation. Not all implementations will accept the same URI schemes.
     * @param location the location URI
     * @throws UnsupportedURIException if the URI scheme is not supported by the repository type.
     */
    void setLocation(URI location) throws UnsupportedURIException;

    /**
     * Sets the base uri for relative location uris.
     *
     * @param baseUri
     */
    void setBaseUri(URI baseUri);

    /**
     * Adds a failover location for the repository.
     *
     * @param location The location that should be used as failover.
     * @throws UnsupportedURIException if the URI scheme is not supported by the repository type.
     */
    void addFailoverLocation(URI location) throws UnsupportedURIException;

    /**
     * Removes a failover location from the set.
     *
     * @param location the location uri to remove
     */
    void removeFailoverLocation(URI location);

    /**
     * Clears the failover location set.
     */
    void clearFailoverLocations();

    /**
     * Sets the flag for scanning the repository. If true, the repository will be scanned.
     * You have to set the scheduling times, if you set this to true.
     *
     * @param scanned if true, the repository is scanned regulary.
     */
    void setScanned(boolean scanned);

    /**
     * Sets the scheduling definition, that defines the times, when the regular repository
     * jobs are started. The <code>cronExpression</code> must be a valid
     * quartz cron definition.
     *
     * @See http://www.quartz-scheduler.org/api/2.2.1/org/quartz/CronExpression.html
     *
     * @param cronExpression the cron expression.
     * @throws IllegalArgumentException if the cron expression is not valid.
     */
    void setSchedulingDefinition(String cronExpression) throws IllegalArgumentException;

    /**
     * Sets the layout string.
     * @param layout
     */
    void setLayout(String layout);

    /**
     * Sets the indexing context reference.
     * @param context
     */
    void setIndexingContext(ArchivaIndexingContext context);


}