DefaultPluginOperator (springboot-plugin-framework 1.0.3.RELEASE API)

java.lang.Object
- com.github.codingdebugallday.integration.operator.DefaultPluginOperator

所有已实现的接口:

PluginOperator
```
public class DefaultPluginOperator
extends Object
implements PluginOperator
```
默认的插件操作者

从以下版本开始:

1.0

作者:

isaac 2020/6/16 15:42

字段概要

字段
限定符和类型	字段和说明
`protected IntegrationConfiguration`	`integrationConfiguration`
`protected org.slf4j.Logger`	`log`
`protected PluginFactory`	`pluginFactory`
`protected PluginInitializerListenerFactory`	`pluginInitializerListenerFactory`
`protected PluginLegalVerify`	`pluginLegalVerify`
`protected org.pf4j.PluginManager`	`pluginManager`

构造器概要

构造器
构造器和说明
`DefaultPluginOperator(org.springframework.context.ApplicationContext applicationContext, IntegrationConfiguration integrationConfiguration, org.pf4j.PluginManager pluginManager, PluginListenerFactory pluginListenerFactory)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected boolean`	`backup(Path sourcePath, String sign, int type)` 备份
`boolean`	`backupPlugin(Path path, String sign)` 通过路径备份文件。
`boolean`	`backupPlugin(String pluginId, String sign)` 通过插件id备份插件。
`protected String`	`getNowTimeByFormat()` 获取现在的时间
`Set<String>`	`getPluginFilePaths()` 得到插件文件的路径 [适用于生产环境]
`List<PluginInfo>`	`getPluginInfo()` 获取插件信息 [适用于生产环境、开发环境]
`PluginInfo`	`getPluginInfo(String pluginId)` 根据插件id获取插件信息 [适用于生产环境、开发环境]
`List<org.pf4j.PluginWrapper>`	`getPluginWrapper()` 得到所有插件的包装类 [适用于生产环境、开发环境]
`org.pf4j.PluginWrapper`	`getPluginWrapper(String pluginId)` 通过插件id得到插件的包装类 [适用于生产环境、开发环境]
`protected org.pf4j.PluginWrapper`	`getPluginWrapper(String pluginId, String errorMsg)` 得到插件包装类
`void`	`initPlugins(PluginInitializerListener pluginInitializerListener)` 初始化插件。
`boolean`	`install(Path path)` 通过路径安装插件(会启用), 该插件文件必须存在于服务器 [适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。
`boolean`	`installConfigFile(Path path)` 通过路径安装插件的配置文件。
`protected boolean`	`isDev()` 是否是开发环境
`void`	`setUploadPluginVerify(PluginLegalVerify uploadPluginVerify)` 设置插件校验器
`boolean`	`start(String pluginId)` 启用插件 [适用于生产环境、开发环境]
`boolean`	`stop(String pluginId)` 停止插件 [适用于生产环境、开发环境]
`boolean`	`uninstall(String pluginId, boolean isBackup)` 卸载插件 [适用于生产环境]
`boolean`	`uploadConfigFile(org.springframework.web.multipart.MultipartFile configFile)` 上传配置文件。
`protected Path`	`uploadPlugin(org.springframework.web.multipart.MultipartFile pluginFile)` 上传插件
`boolean`	`uploadPluginAndStart(org.springframework.web.multipart.MultipartFile pluginFile)` 上传插件并启用插件。
`protected void`	`verifyFailureDelete(Path tempPluginFile, Exception e)` 校验文件失败后, 删除临时文件

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

- 字段详细资料
  - log
```
protected final org.slf4j.Logger log
```
  - integrationConfiguration
```
protected final IntegrationConfiguration integrationConfiguration
```
  - pluginManager
```
protected final org.pf4j.PluginManager pluginManager
```
  - pluginFactory
```
protected final PluginFactory pluginFactory
```
  - pluginInitializerListenerFactory
```
protected final PluginInitializerListenerFactory pluginInitializerListenerFactory
```
  - pluginLegalVerify
```
protected PluginLegalVerify pluginLegalVerify
```
- 构造器详细资料
  - DefaultPluginOperator
```
public DefaultPluginOperator(org.springframework.context.ApplicationContext applicationContext,
                             IntegrationConfiguration integrationConfiguration,
                             org.pf4j.PluginManager pluginManager,
                             PluginListenerFactory pluginListenerFactory)
```
- 方法详细资料
  - setUploadPluginVerify
```
public void setUploadPluginVerify(PluginLegalVerify uploadPluginVerify)
```
    设置插件校验器
    
    参数:
    
    uploadPluginVerify - uploadPluginVerify
  - initPlugins
```
public void initPlugins(PluginInitializerListener pluginInitializerListener)
```
    从接口复制的说明: PluginOperator
    
    初始化插件。该方法只能执行一次。
    
    指定者:
    
    initPlugins 在接口中 PluginOperator
    
    参数:
    
    pluginInitializerListener - 插件初始化监听者
  - install
```
public boolean install(Path path)
```
    从接口复制的说明: PluginOperator
    
    通过路径安装插件(会启用), 该插件文件必须存在于服务器 [适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。备份文件命名规则为；[install-backup][时间]_原jar名.jar
    
    指定者:
    
    install 在接口中 PluginOperator
    
    参数:
    
    path - 插件路径
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
  - uninstall
```
public boolean uninstall(String pluginId,
                         boolean isBackup)
```
    从接口复制的说明: PluginOperator
    
    卸载插件 [适用于生产环境]
    
    指定者:
    
    uninstall 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    isBackup - 是否备份原来的插件。备份文件命名规则为；[uninstall][时间]_原jar名.jar
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
  - start
```
public boolean start(String pluginId)
```
    从接口复制的说明: PluginOperator
    
    启用插件 [适用于生产环境、开发环境]
    
    指定者:
    
    start 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
  - stop
```
public boolean stop(String pluginId)
```
    从接口复制的说明: PluginOperator
    
    停止插件 [适用于生产环境、开发环境]
    
    指定者:
    
    stop 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
  - uploadPluginAndStart
```
public boolean uploadPluginAndStart(org.springframework.web.multipart.MultipartFile pluginFile)
```
    从接口复制的说明: PluginOperator
    
    上传插件并启用插件。[适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。备份文件命名规则为；[install-backup][时间]_原jar名.jar
    
    指定者:
    
    uploadPluginAndStart 在接口中 PluginOperator
    
    参数:
    
    pluginFile - 配置文件
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
  - installConfigFile
```
public boolean installConfigFile(Path path)
```
    从接口复制的说明: PluginOperator
    
    通过路径安装插件的配置文件。该文件必须存在于服务器。[适用于生产环境] 如果配置文件目录存在同名的配置文件, 系统会自动备份该配置文件。备份文件命名规则为；[install-config-backup][时间]_原jar名.jar
    
    指定者:
    
    installConfigFile 在接口中 PluginOperator
    
    参数:
    
    path - 配置文件路径。
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
  - uploadConfigFile
```
public boolean uploadConfigFile(org.springframework.web.multipart.MultipartFile configFile)
```
    从接口复制的说明: PluginOperator
    
    上传配置文件。[适用于生产环境] 如果配置文件目录存在同名的配置文件, 系统会自动备份该配置文件。备份文件命名规则为；[upload-config-backup][时间]_原jar名.jar
    
    指定者:
    
    uploadConfigFile 在接口中 PluginOperator
    
    参数:
    
    configFile - 配置文件
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
  - backupPlugin
```
public boolean backupPlugin(Path path,
                            String sign)
```
    从接口复制的说明: PluginOperator
    
    通过路径备份文件。可备份插件和插件的配置文件。[适用于生产环境]
    
    指定者:
    
    backupPlugin 在接口中 PluginOperator
    
    参数:
    
    path - 路径
    
    sign - 备份文件的自定义标识
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
  - backupPlugin
```
public boolean backupPlugin(String pluginId,
                            String sign)
```
    从接口复制的说明: PluginOperator
    
    通过插件id备份插件。[适用于生产环境]
    
    指定者:
    
    backupPlugin 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    sign - 备份文件的自定义标识
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
  - getPluginInfo
```
public List<PluginInfo> getPluginInfo()
```
    从接口复制的说明: PluginOperator
    
    获取插件信息 [适用于生产环境、开发环境]
    
    指定者:
    
    getPluginInfo 在接口中 PluginOperator
    
    返回:
    
    返回插件信息列表
  - getPluginInfo
```
public PluginInfo getPluginInfo(String pluginId)
```
    从接口复制的说明: PluginOperator
    
    根据插件id获取插件信息 [适用于生产环境、开发环境]
    
    指定者:
    
    getPluginInfo 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    插件信息
  - getPluginFilePaths
```
public Set<String> getPluginFilePaths()
```
    从接口复制的说明: PluginOperator
    
    得到插件文件的路径 [适用于生产环境]
    
    指定者:
    
    getPluginFilePaths 在接口中 PluginOperator
    
    返回:
    
    返回插件路径列表
  - getPluginWrapper
```
public List<org.pf4j.PluginWrapper> getPluginWrapper()
```
    从接口复制的说明: PluginOperator
    
    得到所有插件的包装类 [适用于生产环境、开发环境]
    
    指定者:
    
    getPluginWrapper 在接口中 PluginOperator
    
    返回:
    
    返回插件包装类集合
  - getPluginWrapper
```
public org.pf4j.PluginWrapper getPluginWrapper(String pluginId)
```
    从接口复制的说明: PluginOperator
    
    通过插件id得到插件的包装类 [适用于生产环境、开发环境]
    
    指定者:
    
    getPluginWrapper 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    返回插件包装类集合
  - uploadPlugin
```
protected Path uploadPlugin(org.springframework.web.multipart.MultipartFile pluginFile)
```
    上传插件
    
    参数:
    
    pluginFile - 插件文件
    
    返回:
    
    返回上传的插件路径
  - getPluginWrapper
```
protected org.pf4j.PluginWrapper getPluginWrapper(String pluginId,
                                                  String errorMsg)
```
    得到插件包装类
    
    参数:
    
    pluginId - 插件id
    
    errorMsg - 错误信息
    
    返回:
    
    PluginWrapper
  - verifyFailureDelete
```
protected void verifyFailureDelete(Path tempPluginFile,
                                   Exception e)
```
    校验文件失败后, 删除临时文件
    
    参数:
    
    tempPluginFile - 临时文件路径
    
    e - 异常信息
  - backup
```
protected boolean backup(Path sourcePath,
                         String sign,
                         int type)
```
    备份
    
    参数:
    
    sourcePath - 源文件的路径
    
    sign - 文件标志
    
    type - 类型 1移动 2拷贝
    
    返回:
    
    结果
  - getNowTimeByFormat
```
protected String getNowTimeByFormat()
```
    获取现在的时间
    
    返回:
    
    String
  - isDev
```
protected boolean isDev()
```
    是否是开发环境
    
    返回:
    
    boolean

类 DefaultPluginOperator

字段概要

构造器概要

方法概要

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

字段详细资料

log

integrationConfiguration

pluginManager

pluginFactory

pluginInitializerListenerFactory

pluginLegalVerify

构造器详细资料

DefaultPluginOperator

方法详细资料

setUploadPluginVerify

initPlugins

install

uninstall

start

stop

uploadPluginAndStart

installConfigFile

uploadConfigFile

backupPlugin

backupPlugin

getPluginInfo

getPluginInfo

getPluginFilePaths

getPluginWrapper

getPluginWrapper

uploadPlugin

getPluginWrapper

verifyFailureDelete

backup

getNowTimeByFormat

isDev