001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider;
018
019import java.io.File;
020
021import org.apache.commons.vfs2.FileObject;
022import org.apache.commons.vfs2.FileSelector;
023import org.apache.commons.vfs2.FileSystemException;
024
025/**
026 * Responsible for making local replicas of files.
027 * <p>
028 * A file replicator may also implement {@link VfsComponent}.
029 * </p>
030 */
031public interface FileReplicator {
032
033    /**
034     * Creates a local copy of the file, and all its descendants.
035     *
036     * @param srcFile The file to copy.
037     * @param selector Selects the files to copy.
038     * @return The local copy of the source file.
039     * @throws FileSystemException If the source files does not exist, or on error copying.
040     */
041    File replicateFile(FileObject srcFile, FileSelector selector) throws FileSystemException;
042}