net.ymate.platform.plugin.AbstractPlugin Maven / Gradle / Ivy
/*
* Copyright 2007-2019 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;
/**
* 插件启动器接口抽象实现，完成必要参数的赋值动作
*
* @author 刘镇 ([email protected]) on 2012-4-20 下午5:30:30
*/
public abstract class AbstractPlugin implements IPlugin {
private IPluginContext context;
private boolean initialized;
private boolean started;
@Override
public void initialize(IPluginContext context) throws Exception {
if (!initialized) {
this.context = context;
doInitialize(context);
initialized = true;
}
}
/**
* 初始化
*
* @param context 插件环境上下文对象
* @throws Exception 初始过程中产生的任何异常
*/
protected abstract void doInitialize(IPluginContext context) throws Exception;
@Override
public boolean isInitialized() {
return initialized;
}
@Override
public IPluginContext getPluginContext() {
return context;
}
@Override
public boolean isStarted() {
return started;
}
@Override
public void startup() throws Exception {
if (initialized) {
doStartup();
started = true;
}
}
/**
* 启动插件
*
* @throws Exception 启动插件时可能产生的异常
*/
protected abstract void doStartup() throws Exception;
@Override
public void shutdown() throws Exception {
if (started) {
started = false;
doShutdown();
}
}
/**
* 停止插件
*
* @throws Exception 停止插件时可能产生的异常
*/
protected abstract void doShutdown() throws Exception;
@Override
public void close() throws Exception {
if (initialized) {
initialized = false;
shutdown();
context = null;
}
}
}