com.logicbus.models.servant.ServiceDescription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alogic-core Show documentation
alogic服务框架核心
There is a newer version: 1.6.17
package com.logicbus.models.servant;

import com.alogic.load.Loadable;
import com.alogic.xscript.Logiclet;
import com.anysoft.loadbalance.Load;
import com.anysoft.util.Properties;
import com.anysoft.util.Reportable;
import com.anysoft.util.XmlSerializer;
import com.anysoft.util.JsonSerializer;


/**
 * 服务描述
 * 
 * @author duanyy
 * @version 1.0.3 [20140410 duanyy]

 * + 增加调用参数列表

 * 
 * 
 * @version 1.2.3 [20140617 duanyy]

 * - 增加日志的相关属性 

 * 
 * @version 1.2.4.4 [20140709 duanyy]

 * - 增加LogType的设置方法 

 * - 增加properties和arguments的设置方法 

 * 
 * @version 1.2.5.4 [20140801 duanyy]

 * - ServiceDescription变更为interface 

 * 
 * @version 1.2.8.2 [20141015 duanyy]

 * - 实现Reportable 

 * 
 * @version 1.6.7.20 

 * - 改造ServantManager模型,增加服务配置监控机制 

 *
 * @version 1.6.13.7 [20200812 duanyy] 

 * - 增加swagger事件处理 

 *
 * @version 1.6.14.12 [20210617 duanyy] 

 * - 增加路径模版属性 

 */
public interface ServiceDescription extends XmlSerializer,JsonSerializer,Reportable, Loadable {
	/**
	 * 业务日志的类型
	 * 
	 * 

	 * 分为三种类型:

	 * - none 

	 * - brief 

	 * - detail 

	 * 
	 * @author duanyy
	 * @since 1.2.3
	 * 
	 */
	public enum LogType {none,brief,detail};
	
	/**
	 * 可见性：public
	 */
	public static final String PUBLIC = "public";
	
	/**
	 * 可见性：protected
	 */
	public static final String PROTECTED = "protected";
	
	/**
	 * 获取日志类型
	 * @return 日志类型
	 */
	public LogType getLogType();
	
	/**
	 * 启动配置监控
	 * @return 是否启用
	 */
	public boolean guard();
	
	/**
	 * 获得服务ID
	 * @return 服务ID
	 */
	public String getServiceID();
	
	/**
	 * 获得服务的可见性
	 * @return 可见性
	 */
	public String getVisible();
	
	/**
	 * 获取访问控制组id
	 * @return acGroupId
	 */
	public String getAcGroup();

	/**
	 * 获取路径模版
	 * @return 路径模版
	 */
	public String getPattern();

	/**
	 * 获取所需的权限项
	 * @return　privilege
	 */
	public String getPrivilege();
	
	/**
	 * 获得服务名称
	 * @return name
	 */
	public String getName();
	
	/**
	 * 获取服务说明
	 * @return 服务说明
	 */
	public String getNote();
	
	/**
	 * 获得服务路径
	 * @return 服务路径
	 */
	public String getPath();
	
	/**
	 * 获得服务实现代码
	 * @return 服务实现代码
	 */
	public String getModule();

	/**
	 * 获取参数变量集
	 * @return 参数变量集
	 */
	public Properties getProperties();
	
	/**
	 * 获取服务依赖库文件列表
	 * @return 文件列表
	 */
	public String [] getModules();

	/**
	 * 获取Swagger生成逻辑
	 * @return logiclet
	 */
	public Logiclet getSwaggerLogiclet();
}