DefaultMagicAPIService (magic-api 1.7.2 API)

java.lang.Object
- org.ssssssss.magicapi.provider.impl.DefaultMagicAPIService

所有已实现的接口:: MagicModule, JsonCodeConstants, MagicAPIService

public class DefaultMagicAPIService
extends Object
implements MagicAPIService, JsonCodeConstants

默认接口实现

作者:: mxd

字段概要
- 从接口继承的字段 org.ssssssss.magicapi.model.JsonCodeConstants
  API_ALREADY_EXISTS, API_NAME_REQUIRED, API_NOT_FOUND, API_SAVE_FAILURE, BODY_INVALID, DATASOURCE_KEY_EXISTS, DATASOURCE_KEY_INVALID, DATASOURCE_KEY_REQUIRED, DATASOURCE_NOT_FOUND, DATASOURCE_TYPE_NOT_FOUND, DATASOURCE_TYPE_NOT_SET, FILE_IS_REQUIRED, FUNCTION_ALREADY_EXISTS, FUNCTION_NAME_REQUIRED, FUNCTION_NOT_FOUND, FUNCTION_PATH_CONFLICT, FUNCTION_PATH_REQUIRED, FUNCTION_SAVE_FAILURE, GROUP_CONFLICT, GROUP_NAME_REQUIRED, GROUP_NOT_FOUND, GROUP_SAVE_FAILURE, GROUP_TYPE_REQUIRED, HEADER_INVALID, IS_READ_ONLY, NAME_CONFLICT, NAME_INVALID, PARAMETER_INVALID, PATH_VARIABLE_INVALID, PERMISSION_INVALID, REQUEST_METHOD_REQUIRED, REQUEST_PATH_CONFLICT, REQUEST_PATH_REQUIRED, RESOURCE_LOCKED, SCRIPT_REQUIRED, SECRET_KEY_IS_REQUIRED, SIGN_IS_INVALID, SUCCESS, TARGET_IS_REQUIRED, UPLOAD_PATH_CONFLICT

构造器概要

构造器
构造器和说明
DefaultMagicAPIService(MappingHandlerMapping mappingHandlerMapping, ApiServiceProvider apiServiceProvider, FunctionServiceProvider functionServiceProvider, GroupServiceProvider groupServiceProvider, ResultProvider resultProvider, MagicDynamicDataSource magicDynamicDataSource, MagicFunctionManager magicFunctionManager, MagicNotifyService magicNotifyService, String instanceId, Resource workspace, MagicBackupService backupService, DataSourceEncryptProvider dataSourceEncryptProvider, boolean throwException)

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`List<ApiInfo>`	`apiList()` 获取接口列表
`<T> T`	`call(String method, String path, Map<String,Object> context)` 执行MagicAPI中的接口,带code和message信息
`String`	`copyGroup(String srcId, String target)` 复制分组
`String`	`createGroup(Group group)` 创建分组
`List<DataSourceInfo>`	`datasourceList()` 数据源列表
`boolean`	`deleteApi(String id)` 删除接口
`boolean`	`deleteDataSource(String id)` 删除数据源
`boolean`	`deleteFunction(String id)` 删除函数
`boolean`	`deleteGroup(String groupId)` 删除分组
`void`	`download(String groupId, List<SelectedResource> resources, OutputStream os)` 下载
`<T> T`	`execute(String method, String path, Map<String,Object> context)` 执行MagicAPI中的接口,原始内容，不包含code以及message信息
`List<FunctionInfo>`	`functionList()` 获取函数列表
`ApiInfo`	`getApiInfo(String id)` 获取接口详情
`DataSourceInfo`	`getDataSource(String id)` 获取数据源详情
`FunctionInfo`	`getFunctionInfo(String id)` 获取函数详情
`Group`	`getGroup(String id)` 查询分组详情
`String`	`getModuleName()` 获取模块名
`List<Group>`	`groupList(String type)` 查询分组列表
`<T> T`	`invoke(String path, Map<String,Object> context)` 执行MagicAPI中的函数
`boolean`	`lockApi(String id)` 锁定接口
`boolean`	`lockFunction(String id)` 锁定函数
`boolean`	`moveApi(String id, String groupId)` 移动接口
`boolean`	`moveFunction(String id, String groupId)` 移动函数
`boolean`	`processNotify(MagicNotify magicNotify)` 处理刷新通知
`JsonBean<?>`	`push(String target, String secretKey, String mode, List<SelectedResource> resources)` 远程推送
`void`	`registerAllDataSource()` 注册数据源
`String`	`saveApi(ApiInfo info)` 保存接口
`String`	`saveDataSource(DataSourceInfo properties)` 保存数据源
`String`	`saveFunction(FunctionInfo functionInfo)` 保存函数
`String`	`testDataSource(DataSourceInfo properties)` 测试数据源
`boolean`	`unlockApi(String id)` 解锁接口
`boolean`	`unlockFunction(String id)` 解锁函数
`boolean`	`updateGroup(Group group)` 修改分组信息
`void`	`upload(InputStream inputStream, String mode)` 上传

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.ssssssss.magicapi.model.JsonCodeConstants
isTrue, notBlank, notNull

- 构造器详细资料
  - DefaultMagicAPIService
```
public DefaultMagicAPIService(MappingHandlerMapping mappingHandlerMapping,
                              ApiServiceProvider apiServiceProvider,
                              FunctionServiceProvider functionServiceProvider,
                              GroupServiceProvider groupServiceProvider,
                              ResultProvider resultProvider,
                              MagicDynamicDataSource magicDynamicDataSource,
                              MagicFunctionManager magicFunctionManager,
                              MagicNotifyService magicNotifyService,
                              String instanceId,
                              Resource workspace,
                              MagicBackupService backupService,
                              DataSourceEncryptProvider dataSourceEncryptProvider,
                              boolean throwException)
```
- 方法详细资料
  - execute
```
public <T> T execute(String method,
                     String path,
                     Map<String,Object> context)
```
    从接口复制的说明: MagicAPIService
    
    执行MagicAPI中的接口,原始内容，不包含code以及message信息
    
    指定者:
    
    execute 在接口中 MagicAPIService
    
    参数:
    
    method - 请求方法
    
    path - 请求路径
    
    context - 变量信息
    
    返回:
    
    返回执行结果
  - call
```
public <T> T call(String method,
                  String path,
                  Map<String,Object> context)
```
    从接口复制的说明: MagicAPIService
    
    执行MagicAPI中的接口,带code和message信息
    
    指定者:
    
    call 在接口中 MagicAPIService
    
    参数:
    
    method - 请求方法
    
    path - 请求路径
    
    context - 变量信息
    
    返回:
    
    返回执行结果，包装JsonBena处理
  - invoke
```
public <T> T invoke(String path,
                    Map<String,Object> context)
```
    从接口复制的说明: MagicAPIService
    
    执行MagicAPI中的函数
    
    指定者:
    
    invoke 在接口中 MagicAPIService
    
    参数:
    
    path - 函数路径
    
    context - 变量信息
    
    返回:
    
    返回函数执行结果
  - saveApi
```
public String saveApi(ApiInfo info)
```
    从接口复制的说明: MagicAPIService
    
    保存接口
    
    指定者:
    
    saveApi 在接口中 MagicAPIService
    
    参数:
    
    info - 接口信息
    
    返回:
    
    保存成功后，返回Id
  - lockApi
```
public boolean lockApi(String id)
```
    从接口复制的说明: MagicAPIService
    
    锁定接口
    
    指定者:
    
    lockApi 在接口中 MagicAPIService
    
    参数:
    
    id - 接口ID
    
    返回:
    
    是否锁定成功
  - unlockApi
```
public boolean unlockApi(String id)
```
    从接口复制的说明: MagicAPIService
    
    解锁接口
    
    指定者:
    
    unlockApi 在接口中 MagicAPIService
    
    参数:
    
    id - 接口ID
    
    返回:
    
    是否解锁成功
  - lockFunction
```
public boolean lockFunction(String id)
```
    从接口复制的说明: MagicAPIService
    
    锁定函数
    
    指定者:
    
    lockFunction 在接口中 MagicAPIService
    
    参数:
    
    id - 函数ID
    
    返回:
    
    是否锁定成功
  - unlockFunction
```
public boolean unlockFunction(String id)
```
    从接口复制的说明: MagicAPIService
    
    解锁函数
    
    指定者:
    
    unlockFunction 在接口中 MagicAPIService
    
    参数:
    
    id - 接口ID
    
    返回:
    
    是否解锁成功
  - getApiInfo
```
public ApiInfo getApiInfo(String id)
```
    从接口复制的说明: MagicAPIService
    
    获取接口详情
    
    指定者:
    
    getApiInfo 在接口中 MagicAPIService
    
    参数:
    
    id - 接口id
    
    返回:
    
    返回接口信息
  - apiList
```
public List<ApiInfo> apiList()
```
    从接口复制的说明: MagicAPIService
    
    获取接口列表
    
    指定者:
    
    apiList 在接口中 MagicAPIService
    
    返回:
    
    返回接口信息列表
  - deleteApi
```
public boolean deleteApi(String id)
```
    从接口复制的说明: MagicAPIService
    
    删除接口
    
    指定者:
    
    deleteApi 在接口中 MagicAPIService
    
    参数:
    
    id - 接口id
    
    返回:
    
    是否删除成功
  - moveApi
```
public boolean moveApi(String id,
                       String groupId)
```
    从接口复制的说明: MagicAPIService
    
    移动接口
    
    指定者:
    
    moveApi 在接口中 MagicAPIService
    
    参数:
    
    id - 接口id
    
    groupId - 分组id
    
    返回:
    
    是否移动成功
  - saveFunction
```
public String saveFunction(FunctionInfo functionInfo)
```
    从接口复制的说明: MagicAPIService
    
    保存函数
    
    指定者:
    
    saveFunction 在接口中 MagicAPIService
    
    参数:
    
    functionInfo - 函数信息
    
    返回:
    
    保存成功后，返回Id
  - getFunctionInfo
```
public FunctionInfo getFunctionInfo(String id)
```
    从接口复制的说明: MagicAPIService
    
    获取函数详情
    
    指定者:
    
    getFunctionInfo 在接口中 MagicAPIService
    
    参数:
    
    id - 函数id
    
    返回:
    
    返回函数信息
  - functionList
```
public List<FunctionInfo> functionList()
```
    从接口复制的说明: MagicAPIService
    
    获取函数列表
    
    指定者:
    
    functionList 在接口中 MagicAPIService
    
    返回:
    
    返回函数信息列表
  - deleteFunction
```
public boolean deleteFunction(String id)
```
    从接口复制的说明: MagicAPIService
    
    删除函数
    
    指定者:
    
    deleteFunction 在接口中 MagicAPIService
    
    参数:
    
    id - 函数id
    
    返回:
    
    是否删除成功
  - moveFunction
```
public boolean moveFunction(String id,
                            String groupId)
```
    从接口复制的说明: MagicAPIService
    
    移动函数
    
    指定者:
    
    moveFunction 在接口中 MagicAPIService
    
    参数:
    
    id - 函数id
    
    groupId - 分组id
    
    返回:
    
    是否移动成功
  - createGroup
```
public String createGroup(Group group)
```
    从接口复制的说明: MagicAPIService
    
    创建分组
    
    指定者:
    
    createGroup 在接口中 MagicAPIService
    
    参数:
    
    group - 分组信息
    
    返回:
    
    创建成功后返回分组id
  - updateGroup
```
public boolean updateGroup(Group group)
```
    从接口复制的说明: MagicAPIService
    
    修改分组信息
    
    指定者:
    
    updateGroup 在接口中 MagicAPIService
    
    参数:
    
    group - 分组信息
    
    返回:
    
    是否修改成功
  - deleteGroup
```
public boolean deleteGroup(String groupId)
```
    从接口复制的说明: MagicAPIService
    
    删除分组
    
    指定者:
    
    deleteGroup 在接口中 MagicAPIService
    
    参数:
    
    groupId - 分组id
    
    返回:
    
    是否删除成功
  - groupList
```
public List<Group> groupList(String type)
```
    从接口复制的说明: MagicAPIService
    
    查询分组列表
    
    指定者:
    
    groupList 在接口中 MagicAPIService
    
    参数:
    
    type - 分组类型，1 接口分组，2 函数分组
    
    返回:
    
    返回分组信息列表
  - getGroup
```
public Group getGroup(String id)
```
    从接口复制的说明: MagicAPIService
    
    查询分组详情
    
    指定者:
    
    getGroup 在接口中 MagicAPIService
    
    参数:
    
    id - 分组ID
    
    返回:
    
    返回分组对象
  - registerAllDataSource
```
public void registerAllDataSource()
```
    从接口复制的说明: MagicAPIService
    
    注册数据源
    
    指定者:
    
    registerAllDataSource 在接口中 MagicAPIService
  - getDataSource
```
public DataSourceInfo getDataSource(String id)
```
    从接口复制的说明: MagicAPIService
    
    获取数据源详情
    
    指定者:
    
    getDataSource 在接口中 MagicAPIService
    
    参数:
    
    id - 数据源id
    
    返回:
    
    返回数据源信息
  - datasourceList
```
public List<DataSourceInfo> datasourceList()
```
    从接口复制的说明: MagicAPIService
    
    数据源列表
    
    指定者:
    
    datasourceList 在接口中 MagicAPIService
    
    返回:
    
    返回数据源信息列表
  - testDataSource
```
public String testDataSource(DataSourceInfo properties)
```
    从接口复制的说明: MagicAPIService
    
    测试数据源
    
    指定者:
    
    testDataSource 在接口中 MagicAPIService
    
    参数:
    
    properties - 数据源属性
    
    返回:
    
    返回错误说明，连接正常返回 null
  - saveDataSource
```
public String saveDataSource(DataSourceInfo properties)
```
    从接口复制的说明: MagicAPIService
    
    保存数据源
    
    指定者:
    
    saveDataSource 在接口中 MagicAPIService
    
    参数:
    
    properties - 数据源属性
    
    返回:
    
    返回数据源ID
  - deleteDataSource
```
public boolean deleteDataSource(String id)
```
    从接口复制的说明: MagicAPIService
    
    删除数据源
    
    指定者:
    
    deleteDataSource 在接口中 MagicAPIService
    
    参数:
    
    id - 数据源id
    
    返回:
    
    是否删除成功
  - upload
```
public void upload(InputStream inputStream,
                   String mode)
            throws IOException
```
    从接口复制的说明: MagicAPIService
    
    上传
    
    指定者:
    
    upload 在接口中 MagicAPIService
    
    参数:
    
    inputStream - 输入流
    
    mode - 模式，全量和增量
    
    抛出:
    
    IOException - 读取失败抛出的异常
  - download
```
public void download(String groupId,
                     List<SelectedResource> resources,
                     OutputStream os)
              throws IOException
```
    从接口复制的说明: MagicAPIService
    
    下载
    
    指定者:
    
    download 在接口中 MagicAPIService
    
    参数:
    
    groupId - 分组ID
    
    resources - 选择的资源对象
    
    os - 输出流
    
    抛出:
    
    IOException - 下载失败时抛出的异常
  - push
```
public JsonBean<?> push(String target,
                        String secretKey,
                        String mode,
                        List<SelectedResource> resources)
```
    从接口复制的说明: MagicAPIService
    
    远程推送
    
    指定者:
    
    push 在接口中 MagicAPIService
    
    参数:
    
    target - 推送目标
    
    secretKey - 秘钥
    
    mode - 推送模式
    
    resources - 选择的资源
    
    返回:
    
    推送结果
  - processNotify
```
public boolean processNotify(MagicNotify magicNotify)
```
    从接口复制的说明: MagicAPIService
    
    处理刷新通知
    
    指定者:
    
    processNotify 在接口中 MagicAPIService
    
    参数:
    
    magicNotify - 通知对象
    
    返回:
    
    是否处理成功
  - copyGroup
```
public String copyGroup(String srcId,
                        String target)
```
    从接口复制的说明: MagicAPIService
    
    复制分组
    
    指定者:
    
    copyGroup 在接口中 MagicAPIService
    
    参数:
    
    srcId - 源分组ID
    
    target - 目标分组ID
    
    返回:
    
    新分组的ID
  - getModuleName
```
public String getModuleName()
```
    从接口复制的说明: MagicModule
    
    获取模块名
    
    指定者:
    
    getModuleName 在接口中 MagicModule
    
    返回:
    
    返回模块名称

类 DefaultMagicAPIService

字段概要

从接口继承的字段 org.ssssssss.magicapi.model.JsonCodeConstants

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.ssssssss.magicapi.model.JsonCodeConstants

构造器详细资料

DefaultMagicAPIService

方法详细资料

execute

call

invoke

saveApi

lockApi

unlockApi

lockFunction

unlockFunction

getApiInfo

apiList

deleteApi

moveApi

saveFunction

getFunctionInfo

functionList

deleteFunction

moveFunction

createGroup

updateGroup

deleteGroup

groupList

getGroup

registerAllDataSource

getDataSource

datasourceList

testDataSource

saveDataSource

deleteDataSource

upload

download

push

processNotify

copyGroup

getModuleName