KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > vfs > provider > VfsComponent


1 /*
2  * Copyright 2002-2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.commons.vfs.provider;
17
18 import org.apache.commons.logging.Log;
19 import org.apache.commons.vfs.FileSystemException;
20
21 /**
22  * This interface is used to manage the lifecycle of all VFS components.
23  * This includes all implementations of the following interfaces:
24  * <ul>
25  * <li>{@link FileProvider}
26  * <li>{@link org.apache.commons.vfs.FileSystem}
27  * <li>{@link FileReplicator}
28  * <li>{@link TemporaryFileStore}
29  * </ul>
30  *
31  * @author <a HREF="mailto:adammurdoch@apache.org">Adam Murdoch</a>
32  */
33 public interface VfsComponent
34 {
35     /**
36      * Sets the Logger to use for the component.
37      *
38      * @param logger
39      */
40     void setLogger(Log logger);
41
42     /**
43      * Sets the context for the component.
44      *
45      * @param context The context.
46      */
47     void setContext(VfsComponentContext context);
48
49     /**
50      * Initialises the component.
51      */
52     void init() throws FileSystemException;
53
54     /**
55      * Closes the component.
56      */
57     void close();
58 }
59
Popular Tags