001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kew.plugin;
017    
018    /**
019     * Loads a plugin from some source (i.e. filesytem, classpath, network...)
020     *
021     * @author Kuali Rice Team (rice.collab@kuali.org)
022     */
023    public interface PluginLoader extends Modifiable {
024    
025        public String getPluginName();
026        
027            /**
028             * Loads the plugin, this method should NOT invoke any of the Lifecycle methods of the plugin
029             * before returning it to the calling code.
030             */
031            public Plugin load() throws Exception;
032            
033            /**
034             * Returns true if the Plugin loaded by this loader has been removed (for example, it was
035             * deleted from the file system which should result in the plugin being undeployed).
036             */
037            public boolean isRemoved();
038            
039            public void setPluginConfigPath(String pluginConfigPath);
040            
041    }