component.java

来自「用java写的ftp服务器程序」· Java 代码 · 共 51 行

// $Id: Component.java 306760 2005-10-06 11:42:47 +0530 (Thu, 06 Oct 2005) rana_b $
/*
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ftpserver.ftplet;

import org.apache.commons.logging.LogFactory;

/**
 * This interface abstracts the basic lifecycle method. 
 * <ol>
 *     <li>Default constructor will be called.</li>
 *     <li>Set the LogFactory.</li>
 *     <li>The component will be configured using Component.configure(Configuration)</li>
 *     <li>Other component specific methods will be called.</li>
 *     <li>Finnaly Component.dispose() method will be called.</li>
 * </ol>
 * 
 * @author <a href="mailto:[e-mail]">Rana Bhattacharyya</a>
 */
public 
interface Component {

    /**
     * Set the LogFactory.
     */
    void setLogFactory(LogFactory logFact);
    
    /**
     * Configure the component.
     */
    void configure(Configuration config) throws FtpException;
    
    /**
     * Dispose component - release all the resources.
     */
    void dispose();
}