com.logicbus.backend.Servant Maven / Gradle / Ivy
package com.logicbus.backend;
import com.anysoft.pool.Pooled;
import com.anysoft.util.PropertiesConstants;
import com.logicbus.models.servant.Argument;
import com.logicbus.models.servant.ServiceDescription;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.log4j.Logger;
import org.apache.log4j.LogManager;
/**
* 服务员(所有服务实现的基类)
*
* @author duanyy
*
* @version 1.0.3 [20140410 duanyy]
* - 增加调用参数读取的封装函数
*
* @version 1.0.5 [20140412 duanyy]
* - 修改消息传递模型。
*
* @version 1.0.8 [20140412 duanyy]
* - 增加从Message获取参数功能
*
* @version 1.2.4 [20140703 duanyy]
* - 实现Pooled接口
*
* @version 1.2.5 [20140722 duanyy]
* - Pooled接口取消了desctory方法，增加了close方法
*
* @version 1.4.0 [20141117 duanyy]
* - 将MessageDoc和Context进行合并整合
*
* @version 1.6.4.29 [20160126 duanyy]
* - 清除Servant体系中处于deprecated的方法
*/
public abstract class Servant implements Pooled{
/**
* 服务描述
*/
protected ServiceDescription desc = null;
/**
* 服务员的工作状态
*/
private int state;
/**
* 服务调用超时时间
*/
private long timeOut = 3000;
/**
* 工作状态:繁忙
*/
public static final int STATE_BUSY = 0;
/**
* 工作状态：空闲
*/
public static final int STATE_IDLE = 1;
/**
* a logger of log4j
*/
protected static final Logger logger = LogManager.getLogger(Servant.class);
/**
* 构造函数
*/
public Servant(){
}
/**
* 获取服务者的工作状态
* @return state
*/
public int getState(){return state;}
/**
* 设置服务者的工作状态
* @param iState 工作状态
*/
public void setState(int iState){state = iState;}
/**
* 初始化服务者
*
*
* 根据服务描述初始化服务者.
*
* @param sd service description
* @throws ServantException
*/
public void create(ServiceDescription sd){
desc = sd;
timeOut = PropertiesConstants.getLong(sd.getProperties(), "time_out", 3000);
}
/**
* 获取超时时长
* @return value
*/
public long getTimeOutValue(){
return timeOut;
}
/**
* 判断是否已经超时
* @param startTime start time
* @return if time out return true,otherwise false.
*/
public boolean isTimeOut(long startTime){
long current = System.currentTimeMillis();
if (current - startTime > timeOut)
return true;
return false;
}
/**
* 销毁服务
*
*
* 在{@link com.logicbus.backend.ServantPool ServantPool}类
* {@link com.logicbus.backend.ServantPool#close() close}时调用。
*
*/
@Override
public void close(){
}
/**
* 获取服务描述
* @return 服务描述
*/
public ServiceDescription getDescription(){
return desc;
}
/**
* 读取参数
* @param id 参数ID
* @param dftValue 缺省值
* @param ctx 上下文
* @return 参数值
* @throws ServantException
*
* @since 1.4.0
*/
public String getArgument(String id,String dftValue,Context ctx){
Argument argu = desc.getArgument(id);
if (argu == null){
//没有定义参数
return ctx.GetValue(id, dftValue);
}
String value = argu.getValue(ctx);
if (value == null || value.length() <= 0){
return dftValue;
}
return value;
}
/**
* 读取参数
* @param id 参数ID
* @param dftValue 缺省值
* @param ctx 上下文
* @return 参数值
*
* @since 1.6.4
*/
public long getArgument(String id,long dftValue,Context ctx){
String value = getArgument(id,String.valueOf(dftValue),ctx);
try {
return Long.parseLong(value);
}catch (NumberFormatException ex){
return dftValue;
}
}
/**
* 读取参数
* @param id 参数ID
* @param dftValue 缺省值
* @param ctx 上下文
* @return 参数值
*
* @since 1.6.4
*/
public int getArgument(String id,int dftValue,Context ctx){
String value = getArgument(id,String.valueOf(dftValue),ctx);
try {
return Integer.parseInt(value);
}catch (NumberFormatException ex){
return dftValue;
}
}
/**
* 读取参数
* @param id 参数ID
* @param dftValue 缺省值
* @param ctx 上下文
* @return 参数值
*
* @since 1.6.4
*/
public boolean getArgument(String id,boolean dftValue,Context ctx){
String value = getArgument(id,Boolean.toString(dftValue),ctx);
try {
return BooleanUtils.toBoolean(value);
}catch (NumberFormatException ex){
return dftValue;
}
}
/**
* 读取参数
* @param id 参数ID
* @param ctx 上下文
* @return 参数值
* @throws ServantException
*/
public String getArgument(String id,Context ctx){
Argument argu = desc.getArgument(id);
String value;
if (argu == null){
//没有定义参数
value = ctx.GetValue(id, "");
}else{
value = argu.getValue(ctx);
}
if (value == null || value.length() <= 0){
throw new ServantException("client.args_not_found",
"Can not find parameter:" + id);
}
return value;
}
/**
* 获取参数列表
* @return 参数列表
*
* @since 1.0.5
*/
public Argument [] getArgumentList(){
return desc.getArgumentList();
}
/**
* 服务处理过程
* @param ctx 上下文
* @return 处理结果
* @throws Exception
*
* @since 1.4.0
*/
public abstract int actionProcess(Context ctx) throws Exception; // NOSONAR
/**
* 服务处理即将开始
* @param ctx 上下文
*
* @since 1.4.0
*/
public void actionBefore(Context ctx){
// nothing to do
}
/**
* 服务处理已经结束
* @param ctx 上下文
*
* @since 1.4.0
*/
public void actionAfter(Context ctx){
ctx.setReturn("core.ok","It is successful");
ctx.setEndTime(System.currentTimeMillis());
}
/**
* 服务处理发生异常
* @param ctx 上下文
* @param ex 异常
* @since 1.4.0
*/
public void actionException(Context ctx,ServantException ex){
ctx.setReturn(ex.getCode(), ex.getMessage());
ctx.setEndTime(System.currentTimeMillis());
}
}