PluginTypeInterface.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.core.plugins;

import java.net.URL;
import java.util.List;

import org.pentaho.di.core.exception.KettlePluginException;

/**
 * This interface describes a plugin type.<br>
 * It expresses the ID and the name of the plugin type.<br>
 * Then it also explains what the plugin meta class is called and classes the plugin interface itself.<br>
 * It also explains us where to load plugins of this type.<br>
 *
 * @author matt
 *
 */
public interface PluginTypeInterface {

  /**
   * Register an additional class type to be managed by the plugin system.
   *
   * @param clz
   *          category class, usually an interface
   * @param xmlNodeName
   *          xml node to search for a class name
   */
  public void addObjectType( Class<?> clz, String xmlNodeName );

  /**
   * @return The ID of this plugin type
   */
  public String getId();

  /**
   * @return The name of this plugin
   */
  public String getName();

  /**
   * @return The places where we should look for plugins, both as plugin.xml and as
   */
  public List<PluginFolderInterface> getPluginFolders();

  /**
   *
   * @throws KettlePluginException
   */
  public void searchPlugins() throws KettlePluginException;

  /**
   * Handle an annotated plugin
   *
   * @param clazz
   *          The class to use
   * @param annotation
   *          The annotation to get information from
   * @param libraries
   *          The libraries to add
   * @param nativePluginType
   *          Is this a native plugin?
   * @param pluginFolder
   *          The plugin folder to use
   * @throws KettlePluginException
   */
  public void handlePluginAnnotation( Class<?> clazz, java.lang.annotation.Annotation annotation,
    List<String> libraries, boolean nativePluginType, URL pluginFolder ) throws KettlePluginException;
}