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

所有已知实现类:

DefaultPluginOperator
```
public interface PluginOperator
```
操作插件的接口

版本:

2.2.0

作者:

zhangzhuo

另请参阅:

DefaultPluginOperator

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`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)` 上传插件并启用插件。

- 方法详细资料
  - initPlugins
```
boolean initPlugins(PluginInitializerListener pluginInitializerListener)
             throws Exception
```
    初始化插件。该方法只能执行一次。
    
    参数:
    
    pluginInitializerListener - 插件初始化监听者
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - install
```
boolean install(Path path)
         throws Exception
```
    通过路径安装插件(会启用), 该插件文件必须存在于服务器 [适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。备份文件命名规则为；[install-backup][时间]_原jar名.jar
    
    参数:
    
    path - 插件路径
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - uninstall
```
boolean uninstall(String pluginId,
                  boolean isBackup)
           throws Exception
```
    卸载插件 [适用于生产环境]
    
    参数:
    
    pluginId - 插件id
    
    isBackup - 是否备份原来的插件。备份文件命名规则为；[uninstall][时间]_原jar名.jar
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - start
```
boolean start(String pluginId)
       throws Exception
```
    启用插件 [适用于生产环境、开发环境]
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - stop
```
boolean stop(String pluginId)
      throws Exception
```
    停止插件 [适用于生产环境、开发环境]
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    成功返回true.不成功抛出异常或者返回false
    
    抛出:
    
    Exception - 异常信息
  - uploadPluginAndStart
```
boolean uploadPluginAndStart(org.springframework.web.multipart.MultipartFile pluginFile)
                      throws Exception
```
    上传插件并启用插件。[适用于生产环境] 如果在插件目录存在同名的插件包, 系统会自动备份该插件包。备份文件命名规则为；[install-backup][时间]_原jar名.jar
    
    参数:
    
    pluginFile - 配置文件
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - installConfigFile
```
boolean installConfigFile(Path path)
                   throws Exception
```
    通过路径安装插件的配置文件。该文件必须存在于服务器。[适用于生产环境] 如果配置文件目录存在同名的配置文件, 系统会自动备份该配置文件。备份文件命名规则为；[install-config-backup][时间]_原jar名.jar
    
    参数:
    
    path - 配置文件路径。
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 安装异常
  - uploadConfigFile
```
boolean uploadConfigFile(org.springframework.web.multipart.MultipartFile configFile)
                  throws Exception
```
    上传配置文件。[适用于生产环境] 如果配置文件目录存在同名的配置文件, 系统会自动备份该配置文件。备份文件命名规则为；[upload-config-backup][时间]_原jar名.jar
    
    参数:
    
    configFile - 配置文件
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - backupPlugin
```
boolean backupPlugin(Path path,
                     String sign)
              throws Exception
```
    通过路径备份文件。可备份插件和插件的配置文件。[适用于生产环境]
    
    参数:
    
    path - 路径
    
    sign - 备份文件的自定义标识
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - backupPlugin
```
boolean backupPlugin(String pluginId,
                     String sign)
              throws Exception
```
    通过插件id备份插件。[适用于生产环境]
    
    参数:
    
    pluginId - 插件id
    
    sign - 备份文件的自定义标识
    
    返回:
    
    成功返回true.不成功返回false, 或者抛出异常
    
    抛出:
    
    Exception - 异常信息
  - getPluginInfo
```
List<PluginInfo> getPluginInfo()
```
    获取插件信息 [适用于生产环境、开发环境]
    
    返回:
    
    返回插件信息列表
  - getPluginInfo
```
PluginInfo getPluginInfo(String pluginId)
```
    根据插件id获取插件信息 [适用于生产环境、开发环境]
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    插件信息
  - getPluginFilePaths
```
Set<String> getPluginFilePaths()
                        throws Exception
```
    得到插件文件的路径 [适用于生产环境]
    
    返回:
    
    返回插件路径列表
    
    抛出:
    
    Exception - 异常信息
  - getPluginWrapper
```
List<org.pf4j.PluginWrapper> getPluginWrapper()
```
    得到所有插件的包装类 [适用于生产环境、开发环境]
    
    返回:
    
    返回插件包装类集合
  - getPluginWrapper
```
org.pf4j.PluginWrapper getPluginWrapper(String pluginId)
```
    通过插件id得到插件的包装类 [适用于生产环境、开发环境]
    
    参数:
    
    pluginId - 插件id
    
    返回:
    
    返回插件包装类集合

接口 PluginOperator

方法概要

方法详细资料

initPlugins

install

uninstall

start

stop

uploadPluginAndStart

installConfigFile

uploadConfigFile

backupPlugin

backupPlugin

getPluginInfo

getPluginInfo

getPluginFilePaths

getPluginWrapper

getPluginWrapper