View Javadoc

1   /**
2    * Copyright 2005-2014 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.kew.plugin;
17  
18  /**
19   * Loads a plugin from some source (i.e. filesytem, classpath, network...)
20   *
21   * @author Kuali Rice Team (rice.collab@kuali.org)
22   */
23  public interface PluginLoader extends Modifiable {
24  
25      public String getPluginName();
26      
27  	/**
28  	 * Loads the plugin, this method should NOT invoke any of the Lifecycle methods of the plugin
29  	 * before returning it to the calling code.
30  	 */
31  	public Plugin load() throws Exception;
32  	
33  	/**
34  	 * Returns true if the Plugin loaded by this loader has been removed (for example, it was
35  	 * deleted from the file system which should result in the plugin being undeployed).
36  	 */
37  	public boolean isRemoved();
38  	
39  	public void setPluginConfigPath(String pluginConfigPath);
40  	
41  }