net.ymate.platform.plugin.IPlugin Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2007-2107 the original author or authors.
 *
 * 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 net.ymate.platform.plugin;

/**
 * 
 * IPlugin
 * 
 * 
 * 插件启动器接口类; 任何插件的启动器类都必须实现该接口;
 * 
 * 注：请采用继承 AbstractPluginImpl类实现插件开发
 * 
 * @author 刘镇([email protected])
 * @version 0.0.0
 *          
 *          
 *          
 *          
 *          
 *          
 *          
 *          
 *          
 *          
 *          
 *          版本号 动作 修改人 修改时间
0.0.0 创建类 刘镇 2011-10-17下午04:44:06
 */
public interface IPlugin {

	/**
	 * 初始化插件, 重写此方法时需执行super()调用
	 * 
	 * @param context
	 * @throws PluginException 插件运行时异常
	 */
	public void doInit(PluginContext context) throws PluginException;

    /**
     * @return 插件工厂对象
     */
    public IPluginFactory getPluginFactory();

	/**
	 * @return 插件配置信息元数据描述对象
	 */
	public PluginMeta getPluginMeta();

	/**
	 * 启动插件
	 * 
	 * @throws PluginException 插件运行时异常
	 */
	public void doStart() throws PluginException;

	/**
	 * 停止插件
	 * 
	 * @throws PluginException 插件运行时异常
	 */
	public void doStop() throws PluginException;

	/**
	 * 销毁插件, 同时调用doStop()接口方法, 重写此方法时需执行super()调用
	 * 
	 * @throws PluginException 插件运行时异常
	 */
	public void destroy() throws PluginException;

}