View Javadoc
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.Closeable;
20  
21  import org.apache.commons.logging.Log;
22  import org.apache.commons.vfs2.FileSystemException;
23  
24  /**
25   * This interface is used to manage the lifecycle of all VFS components. This includes all implementations of the
26   * following interfaces:
27   * <ul>
28   * <li>{@link FileProvider}
29   * <li>{@link org.apache.commons.vfs2.FileSystem}
30   * <li>{@link FileReplicator}
31   * <li>{@link TemporaryFileStore}
32   * </ul>
33   */
34  public interface VfsComponent extends Closeable {
35  
36      /**
37       * Sets the Logger to use for the component.
38       *
39       * @param logger The Log
40       */
41      void setLogger(Log logger);
42  
43      /**
44       * Sets the context for the component.
45       *
46       * @param context The context.
47       */
48      void setContext(VfsComponentContext context);
49  
50      /**
51       * Initializes the component.
52       *
53       * @throws FileSystemException if an error occurs.
54       */
55      void init() throws FileSystemException;
56  
57      /**
58       * Closes the component.
59       */
60      @Override
61      void close();
62  }