/*
 * Copyright 2000-2018 JetBrains s.r.o.
 *
 * Licensed 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.
 */

package jetbrains.buildServer.buildTriggers.vcs.mercurial;

import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.util.List;
import java.util.Map;

/**
 * @author dmitry.neverov
 */
public interface MirrorManager {

  /**
   * Get directory of local mirror repository for specified url, if directory is not exists it is created
   * @param url url of interest
   * @return see above
   */
  @NotNull
  public File getMirrorDir(@NotNull final String url);

  /**
   * Get all local mirror repository dirs
   * @return see above
   */
  @NotNull
  public List<File> getMirrors();

  public long getLastUsedTime(@NotNull final File mirrorDir);

  /**
   * Forget specified dir. After call to this method with non-empty dir,
   * all urls which were mapped to this dir will be mapped to another.
   * If dir is empty, subsequent call getMirrorDir(dir) will return the
   * same dir.
   *
   * @param dir dir of interest
   */
  public void forgetDir(@NotNull final File dir);

  @NotNull
  public Map<String, File> getMappings();

  public void lockDir(@NotNull File dir);

  public void unlockDir(@NotNull File dir);
}