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.vfs.provider;
18  
19  import org.apache.commons.logging.Log;
20  import org.apache.commons.vfs.FileSystemException;
21  
22  /***
23   * This interface is used to manage the lifecycle of all VFS components.
24   * This includes all implementations of the following interfaces:
25   * <ul>
26   * <li>{@link FileProvider}
27   * <li>{@link org.apache.commons.vfs.FileSystem}
28   * <li>{@link FileReplicator}
29   * <li>{@link TemporaryFileStore}
30   * </ul>
31   *
32   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
33   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
34   */
35  public interface VfsComponent
36  {
37      /***
38       * Sets the Logger to use for the component.
39       *
40       * @param logger
41       */
42      void setLogger(Log logger);
43  
44      /***
45       * Sets the context for the component.
46       *
47       * @param context The context.
48       */
49      void setContext(VfsComponentContext context);
50  
51      /***
52       * Initialises the component.
53       */
54      void init() throws FileSystemException;
55  
56      /***
57       * Closes the component.
58       */
59      void close();
60  }