1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.vfs2.provider;
18
19 import java.io.File;
20
21 import org.apache.commons.vfs2.FileObject;
22 import org.apache.commons.vfs2.FileSelector;
23 import org.apache.commons.vfs2.FileSystemException;
24
25 /**
26 * Responsible for making local replicas of files.
27 * <p>
28 * A file replicator may also implement {@link VfsComponent}.
29 * </p>
30 */
31 public interface FileReplicator {
32
33 /**
34 * Creates a local copy of the file, and all its descendants.
35 *
36 * @param srcFile The file to copy.
37 * @param selector Selects the files to copy.
38 * @return The local copy of the source file.
39 * @throws FileSystemException If the source files does not exist, or on error copying.
40 */
41 File replicateFile(FileObject srcFile, FileSelector selector) throws FileSystemException;
42 }