/**
 * Copyright (c) 2010, Sebastian Sdorra
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of SCM-Manager; nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */



package sonia.scm.repository;

//~--- non-JDK imports --------------------------------------------------------

import sonia.scm.ConfigChangedListener;
import sonia.scm.Handler;
import sonia.scm.ListenerSupport;
import sonia.scm.NotSupportedFeatuerException;
import sonia.scm.plugin.ExtensionPoint;

/**
 * Handler class for a specific {@link Repository} type.
 * These classes are singletons.
 *
 * @author Sebastian Sdorra
 */
@ExtensionPoint
public interface RepositoryHandler
        extends Handler<Repository, RepositoryException>,
                ListenerSupport<ConfigChangedListener>,
                RepositoryBrowserProvider, ChangesetViewerProvider,
                DiffViewerProvider, BlameViewerProvider
{

  /**
   * Returns the resource path for the given {@link Repository}.
   * The resource path is part of the {@link Repository} url.
   *
   *
   *
   * @param repository given {@link Repository}
   * @return resource path of the {@link Repository}
   */
  public String createResourcePath(Repository repository);

  //~--- get methods ----------------------------------------------------------

  /**
   * Returns the {@link ImportHandler} for the repository type of this handler.
   *
   *
   * @return {@link ImportHandler} for the repository type of this handler
   * @since 1.12
   *
   * @throws NotSupportedFeatuerException
   */
  public ImportHandler getImportHandler() throws NotSupportedFeatuerException;

  /**
   * Returns informations about the version of the RepositoryHandler.
   *
   *
   * @return version informations
   * @since 1.15
   */
  public String getVersionInformation();
}
