DataInterfaceService.java 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  1. package jnpf.base.service;
  2. import jnpf.base.ActionResult;
  3. import jnpf.base.Pagination;
  4. import jnpf.base.UserInfo;
  5. import jnpf.base.entity.DataInterfaceEntity;
  6. import jnpf.base.model.datainterface.*;
  7. import jnpf.exception.DataException;
  8. import java.util.List;
  9. import java.util.Map;
  10. /**
  11. * 数据接口业务层
  12. *
  13. * @author JNPF开发平台组
  14. * @version V3.1.0
  15. * @copyright 引迈信息技术有限公司(https://www.jnpfsoft.com)
  16. * @date 2021-03-23
  17. */
  18. public interface DataInterfaceService extends SuperService<DataInterfaceEntity> {
  19. /**
  20. * 获取接口列表(分页)
  21. *
  22. * @param pagination 分页参数
  23. * @return ignore
  24. */
  25. List<DataInterfaceEntity> getList(PaginationDataInterface pagination, Integer isSelector);
  26. /**
  27. * 分页下拉框选择列表
  28. *
  29. * @param pagination
  30. * @return
  31. */
  32. List<DataInterfaceEntity> getList(PaginationDataInterfaceSelector pagination);
  33. /**
  34. * 通过ids获取列表
  35. *
  36. * @param ids
  37. * @return
  38. */
  39. List<DataInterfaceEntity> getList(List<String> ids);
  40. /**
  41. * 获取接口列表下拉框
  42. *
  43. * @return ignore
  44. * @param filterPage
  45. */
  46. List<DataInterfaceEntity> getList(boolean filterPage);
  47. /**
  48. * 获取接口数据
  49. *
  50. * @param id 主键
  51. * @return ignore
  52. */
  53. DataInterfaceEntity getInfo(String id);
  54. /**
  55. * 添加数据接口
  56. *
  57. * @param entity 实体
  58. */
  59. void create(DataInterfaceEntity entity);
  60. /**
  61. * 修改接口
  62. *
  63. * @param entity 实体
  64. * @param id 主键
  65. * @return 实体
  66. * @throws DataException ignore
  67. */
  68. boolean update(DataInterfaceEntity entity, String id) throws DataException;
  69. /**
  70. * 删除接口
  71. *
  72. * @param entity 实体
  73. */
  74. void delete(DataInterfaceEntity entity);
  75. /**
  76. * 判断接口名称是否重复
  77. *
  78. * @param fullName 名称
  79. * @param id 主键
  80. * @return ignore
  81. */
  82. boolean isExistByFullNameOrEnCode(String id, String fullName, String enCode);
  83. /**
  84. * 获取接口分页数据
  85. *
  86. * @param id 主键
  87. * @param page 分页参数
  88. * @return ignore
  89. */
  90. ActionResult infoToIdPageList(String id, DataInterfacePage page);
  91. /**
  92. * 获取接口详情数据
  93. *
  94. * @param id 主键
  95. * @param page 分页参数
  96. * @return ignore
  97. */
  98. List<Map<String, Object>> infoToInfo(String id, DataInterfacePage page);
  99. /**
  100. * 访问接口路径的应用认证
  101. *
  102. * @param id 主键
  103. * @param tenantId 租户encode
  104. * @param model 需要替换的参数
  105. * @return ignore
  106. */
  107. ActionResult infoToIdNew(String id, String tenantId, DataInterfaceActionModel model);
  108. /**
  109. * 检查参数
  110. * @param
  111. * @return
  112. * @copyright 引迈信息技术有限公司
  113. * @date 2022/6/14
  114. */
  115. DataInterfaceActionModel checkParams(Map<String,String> map);
  116. /**
  117. * 访问接口路径
  118. *
  119. * @param id 主键
  120. * @param tenantId 租户encode
  121. * @param map 需要替换的参数
  122. * @return ignore
  123. */
  124. ActionResult infoToId(String id, String tenantId, Map<String, String> map);
  125. /**
  126. * 任务调度使用
  127. * @param id 主键
  128. * @param tenantId 租户encode
  129. * @param map 需要替换的参数
  130. * @param token token
  131. * @return
  132. */
  133. ActionResult infoToId(String id, String tenantId, Map<String, String> map, String token, String appId, String invokType, Pagination pagination, Map<String,Object> showMap);
  134. /**
  135. * 按sourceType替换数据接口参数
  136. * @param listJson
  137. * @param map
  138. */
  139. void paramSourceTypeReplaceValue(List<DataInterfaceModel> listJson, Map<String,String> map);
  140. /**
  141. * 获取系统参数值
  142. * @param templateJson
  143. * @param systemFieldValue
  144. * @return
  145. */
  146. String getSystemFieldValue(DataInterfaceModel templateJson, Map<String, String> systemFieldValue);
  147. /**
  148. * 处理系统参数
  149. *
  150. * @param sql
  151. * @return
  152. */
  153. Map<Double, DataInterfaceMarkModel> systemParameterOne(String sql, UserInfo userInfo);
  154. /**
  155. * 自定义参数替换
  156. *
  157. * @param parameterJson 参数配置
  158. * @param sql sql
  159. * @param map 参数
  160. * @param systemParameter 参数集合
  161. */
  162. String customizationParameter(String parameterJson, String sql, Map<String, Object> map,
  163. Map<Double, DataInterfaceMarkModel> systemParameter);
  164. String getHandleArraysSql(String sql, List<Object> values, Map<Double, DataInterfaceMarkModel> systemParameter);
  165. }