001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider;
018
019import java.io.Closeable;
020
021import org.apache.commons.logging.Log;
022import org.apache.commons.vfs2.FileSystemException;
023
024/**
025 * This interface is used to manage the lifecycle of all VFS components. This includes all implementations of the
026 * following interfaces:
027 * <ul>
028 * <li>{@link FileProvider}
029 * <li>{@link org.apache.commons.vfs2.FileSystem}
030 * <li>{@link FileReplicator}
031 * <li>{@link TemporaryFileStore}
032 * </ul>
033 */
034public interface VfsComponent extends Closeable {
035
036    /**
037     * Closes the component.
038     */
039    @Override
040    void close();
041
042    /**
043     * Initializes the component.
044     *
045     * @throws FileSystemException if an error occurs.
046     */
047    void init() throws FileSystemException;
048
049    /**
050     * Sets the context for the component.
051     *
052     * @param context The context.
053     */
054    void setContext(VfsComponentContext context);
055
056    /**
057     * Sets the Logger to use for the component.
058     *
059     * @param logger The Log
060     */
061    void setLogger(Log logger);
062}