plugin.java

模块化您的应用系统

package com.opensymphony.tonic;

import com.opensymphony.tonic.elements.ResourceDescriptor;

import java.util.Collection;
import java.util.List;
import java.io.InputStream;

public interface Plugin
{
    String getName();

    void setName(String name);

    String getKey();

    void setKey(String aPackage);

    void addModuleDescriptor(ModuleDescriptor moduleDescriptor);

    Collection getModuleDescriptors();

    ModuleDescriptor getModuleDescriptor(String key);

    List getModuleDescriptorsByModuleClass(Class aClass);

    boolean isEnabledByDefault();

    void setEnabledByDefault(boolean enabledByDefault);

    PluginInformation getPluginInformation();

    void setPluginInformation(PluginInformation pluginInformation);

    List getResourceDescriptors();

    void setResourceDescriptors(List resourceDescriptors);

    List getResourceDescriptors(String type);

    ResourceDescriptor getResourceDescriptor(String type, String name);

    boolean isEnabled();

    /**
     * Whether the tonic is a "system" tonic that shouldn't be made visible to the user
     */
    boolean isSystemPlugin();

    void setSystemPlugin(boolean system);

    void setEnabled(boolean enabled);

    /**
     * Whether or not this tonic can be 'uninstalled'.
     */
    boolean isUninstallable();

    /**
     * Whether or not this tonic can load resources.
     */
    boolean isResourceLoading();

    /**
     * Get the tonic to load a specific class.
     *
     * @param clazz The name of the class to be loaded
     * @param callingClass The class calling the loading (used to help find a classloader)
     * @return The loaded class.
     * @throws ClassNotFoundException
     */
    Class loadClass(String clazz, Class callingClass) throws ClassNotFoundException;

    /**
     * Load a given resource from the tonic.
     * @param name The name of the resource to be loaded.
     * @return An InputStream for the resource, or null if the resource is not found or the tonic does not support resource loading.
     */
    InputStream getResourceAsStream(String name);

}