/*
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * [Additional notices, if required by prior licensing conditions]
 *
 */ 

package org.apache.tomcat.core;

import org.apache.tomcat.util.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.security.*;

// This is not a class loader, any "normal" class loader can be used.

// XXX Should be named DynamicLoader - has nothing specific to servlets

/** Handle servlet and resource reloading
 */
public interface ServletLoader {

    /** Check if we need to reload one particular class.
     *  No check is done for dependent classes.
     *  The final decision about reloading is left to the caller.
     */
    public boolean shouldReload( String className );

    /** Check if we need to reload. All loaded classes are
     *  checked.
     *  The final decision about reloading is left to the caller.
     */
    public boolean shouldReload();

    /** Reset the class loader. The caller should take all actions
     *  required by this step ( free resources for GC, etc)
     */
    public void reload();

    /** Return a real class loader
     */
    public ClassLoader getClassLoader();
    
    /** Handle servlet loading. Same as getClassLoader().loadClass(name, true); 
     */
    public Class loadClass( String name)
	throws ClassNotFoundException;


    /** Return the class loader view of the class path
     */
    public String getClassPath();


    /** Add a new directory or jar to the class loader.
     *  Optionally, a SecurityManager ProtectionDomain can
     *  be specified for use by the ClassLoader when defining
     *  a class loaded from this entry in the repository.
     *  Not all loaders can add resources dynamically -
     *  that may require a reload.
     */
    public void addRepository( File f, Object protectionDomain );
    // XXX notify if it can't add it
    
    
    /** Add a new remote repository. Not all class loader will
     *  support remote resources, use File if it's a local resource.
     */
    public void addRepository( URL url );
    // XXX notify if it can't add it

    /** The parent loader - used to load tomcat classes. The Loader must delegate
     *  to it, instead of using the system loader
     */
    public void setParentLoader( ClassLoader parent );

    public ClassLoader getParentLoader();
}











