01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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-28 22:15:24 -0800 (Tue, 28 Nov 2006) $
34: */
35: public interface VfsComponent {
36: /**
37: * Sets the Logger to use for the component.
38: *
39: * @param logger
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: * Initialises the component.
52: */
53: void init() throws FileSystemException;
54:
55: /**
56: * Closes the component.
57: */
58: void close();
59: }
|