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 org.apache.commons.logging.Log;
020import org.apache.commons.vfs2.FileSystemException;
021
022/**
023 * This interface is used to manage the lifecycle of all VFS components. This includes all implementations of the
024 * following interfaces:
025 * <ul>
026 * <li>{@link FileProvider}
027 * <li>{@link org.apache.commons.vfs2.FileSystem}
028 * <li>{@link FileReplicator}
029 * <li>{@link TemporaryFileStore}
030 * </ul>
031 */
032public interface VfsComponent {
033    /**
034     * Sets the Logger to use for the component.
035     *
036     * @param logger The Log
037     */
038    void setLogger(Log logger);
039
040    /**
041     * Sets the context for the component.
042     *
043     * @param context The context.
044     */
045    void setContext(VfsComponentContext context);
046
047    /**
048     * Initializes the component.
049     *
050     * @throws FileSystemException if an error occurs.
051     */
052    void init() throws FileSystemException;
053
054    /**
055     * Closes the component.
056     */
057    void close();
058}