DefaultPluginOperator (springboot-plugin-framework 2.2.1-RELEASE API)

java.lang.Object
- com.gitee.starblues.integration.operator.DefaultPluginOperator

所有已实现的接口:

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

版本:

2.2.0

作者:

zhangzhuo

字段概要

字段
限定符和类型	字段和说明
`protected IntegrationConfiguration`	`integrationConfiguration`
`protected org.pf4j.PluginDescriptorFinder`	`pluginDescriptorFinder`
`protected PluginFactory`	`pluginFactory`
`protected PluginInitializerListenerFactory`	`pluginInitializerListenerFactory`
`protected org.pf4j.PluginManager`	`pluginManager`
`protected PluginLegalVerify`	`uploadPluginVerify`

构造器概要

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`backupPlugin(Path path, String sign)` 通过路径备份文件。
`boolean`	`backupPlugin(String pluginId, String sign)` 通过插件id备份插件。
`Set<String>`	`getPluginFilePaths()` 得到插件文件的路径 [适用于生产环境]
`List<PluginInfo>`	`getPluginInfo()` 获取插件信息 [适用于生产环境、开发环境]
`PluginInfo`	`getPluginInfo(String pluginId)` 根据插件id获取插件信息 [适用于生产环境、开发环境]
`List<org.pf4j.PluginWrapper>`	`getPluginWrapper()` 得到所有插件的包装类 [适用于生产环境、开发环境]
`org.pf4j.PluginWrapper`	`getPluginWrapper(String pluginId)` 通过插件id得到插件的包装类 [适用于生产环境、开发环境]
`boolean`	`initPlugins(PluginInitializerListener pluginInitializerListener)` 初始化插件。
`boolean`	`install(Path path)` 通过路径安装插件(会启用), 该插件文件必须存在于服务器 [适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。
`boolean`	`installConfigFile(Path path)` 通过路径安装插件的配置文件。
`boolean`	`start(String pluginId)` 启用插件 [适用于生产环境、开发环境]
`boolean`	`stop(String pluginId)` 停止插件 [适用于生产环境、开发环境]
`boolean`	`uninstall(String pluginId, boolean isBackup)` 卸载插件 [适用于生产环境]
`boolean`	`uploadConfigFile(org.springframework.web.multipart.MultipartFile configFile)` 上传配置文件。
`boolean`	`uploadPluginAndStart(org.springframework.web.multipart.MultipartFile pluginFile)` 上传插件并启用插件。

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

- 字段详细资料
  - integrationConfiguration
```
protected final IntegrationConfiguration integrationConfiguration
```
  - pluginManager
```
protected final org.pf4j.PluginManager pluginManager
```
  - pluginFactory
```
protected final PluginFactory pluginFactory
```
  - pluginInitializerListenerFactory
```
protected final PluginInitializerListenerFactory pluginInitializerListenerFactory
```
  - pluginDescriptorFinder
```
protected final org.pf4j.PluginDescriptorFinder pluginDescriptorFinder
```
  - uploadPluginVerify
```
protected final PluginLegalVerify uploadPluginVerify
```
- 构造器详细资料
  - DefaultPluginOperator
```
public DefaultPluginOperator(org.springframework.context.ApplicationContext applicationContext,
                             IntegrationConfiguration integrationConfiguration,
                             org.pf4j.PluginManager pluginManager,
                             PluginListenerFactory pluginListenerFactory)
```
- 方法详细资料
  - initPlugins
```
public boolean initPlugins(PluginInitializerListener pluginInitializerListener)
                    throws Exception
```
    从接口复制的说明: PluginOperator
    
    初始化插件。该方法只能执行一次。
    
    指定者:
    
    initPlugins 在接口中 PluginOperator
    
    参数:
    
    pluginInitializerListener - 插件初始化监听者
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - install
```
public boolean install(Path path)
                throws Exception
```
    从接口复制的说明: PluginOperator
    
    通过路径安装插件(会启用), 该插件文件必须存在于服务器 [适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。备份文件命名规则为；[install-backup][时间]_原jar名.jar
    
    指定者:
    
    install 在接口中 PluginOperator
    
    参数:
    
    path - 插件路径
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - uninstall
```
public boolean uninstall(String pluginId,
                         boolean isBackup)
                  throws Exception
```
    从接口复制的说明: PluginOperator
    
    卸载插件 [适用于生产环境]
    
    指定者:
    
    uninstall 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    isBackup - 是否备份原来的插件。备份文件命名规则为；[uninstall][时间]_原jar名.jar
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - start
```
public boolean start(String pluginId)
              throws Exception
```
    从接口复制的说明: PluginOperator
    
    启用插件 [适用于生产环境、开发环境]
    
    指定者:
    
    start 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - stop
```
public boolean stop(String pluginId)
             throws Exception
```
    从接口复制的说明: PluginOperator
    
    停止插件 [适用于生产环境、开发环境]
    
    指定者:
    
    stop 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - uploadPluginAndStart
```
public boolean uploadPluginAndStart(org.springframework.web.multipart.MultipartFile pluginFile)
                             throws Exception
```
    从接口复制的说明: PluginOperator
    
    上传插件并启用插件。[适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。备份文件命名规则为；[install-backup][时间]_原jar名.jar
    
    指定者:
    
    uploadPluginAndStart 在接口中 PluginOperator
    
    参数:
    
    pluginFile - 配置文件
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - installConfigFile
```
public boolean installConfigFile(Path path)
                          throws Exception
```
    从接口复制的说明: PluginOperator
    
    通过路径安装插件的配置文件。该文件必须存在于服务器。[适用于生产环境] 如果配置文件目录存在同名的配置文件, 系统会自动备份该配置文件。备份文件命名规则为；[install-config-backup][时间]_原jar名.jar
    
    指定者:
    
    installConfigFile 在接口中 PluginOperator
    
    参数:
    
    path - 配置文件路径。
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 安装异常
  - uploadConfigFile
```
public boolean uploadConfigFile(org.springframework.web.multipart.MultipartFile configFile)
                         throws Exception
```
    从接口复制的说明: PluginOperator
    
    上传配置文件。[适用于生产环境] 如果配置文件目录存在同名的配置文件, 系统会自动备份该配置文件。备份文件命名规则为；[upload-config-backup][时间]_原jar名.jar
    
    指定者:
    
    uploadConfigFile 在接口中 PluginOperator
    
    参数:
    
    configFile - 配置文件
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - backupPlugin
```
public boolean backupPlugin(Path path,
                            String sign)
                     throws Exception
```
    从接口复制的说明: PluginOperator
    
    通过路径备份文件。可备份插件和插件的配置文件。[适用于生产环境]
    
    指定者:
    
    backupPlugin 在接口中 PluginOperator
    
    参数:
    
    path - 路径
    
    sign - 备份文件的自定义标识
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - backupPlugin
```
public boolean backupPlugin(String pluginId,
                            String sign)
                     throws Exception
```
    从接口复制的说明: PluginOperator
    
    通过插件id备份插件。[适用于生产环境]
    
    指定者:
    
    backupPlugin 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    sign - 备份文件的自定义标识
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - 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()
                               throws Exception
```
    从接口复制的说明: PluginOperator
    
    得到插件文件的路径 [适用于生产环境]
    
    指定者:
    
    getPluginFilePaths 在接口中 PluginOperator
    
    返回:
    
    返回插件路径列表
    
    抛出:
    
    Exception - 异常信息
  - getPluginWrapper
```
public List<org.pf4j.PluginWrapper> getPluginWrapper()
```
    从接口复制的说明: PluginOperator
    
    得到所有插件的包装类 [适用于生产环境、开发环境]
    
    指定者:
    
    getPluginWrapper 在接口中 PluginOperator
    
    返回:
    
    返回插件包装类集合
  - getPluginWrapper
```
public org.pf4j.PluginWrapper getPluginWrapper(String pluginId)
```
    从接口复制的说明: PluginOperator
    
    通过插件id得到插件的包装类 [适用于生产环境、开发环境]
    
    指定者:
    
    getPluginWrapper 在接口中 PluginOperator
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    返回插件包装类集合

类 DefaultPluginOperator

字段概要

构造器概要

方法概要

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

字段详细资料

integrationConfiguration

pluginManager

pluginFactory

pluginInitializerListenerFactory

pluginDescriptorFinder

uploadPluginVerify

构造器详细资料

DefaultPluginOperator

方法详细资料

initPlugins

install

uninstall

start

stop

uploadPluginAndStart

installConfigFile

uploadConfigFile

backupPlugin

backupPlugin

getPluginInfo

getPluginInfo

getPluginFilePaths

getPluginWrapper

getPluginWrapper