com.gitee.starblues.integration

接口 IntegrationConfiguration

所有已知实现类:

ConfigurationBuilder, DefaultIntegrationConfiguration

public interface IntegrationConfiguration

插件集成时的配置接口。插件集成的配置接口

版本:

1.0

作者:

zhangzhuo

方法概要

限定符和类型	方法和说明
String	backupPath() 插件备份路径。
boolean	enablePluginIdRestControllerPathPrefix() 启用插件id作为RestController的路径前缀。
org.pf4j.RuntimeMode	environment() 运行环境。
String	pluginConfigFilePath() 插件文件的配置路径。
String	pluginPath() 插件的路径。
String	pluginRestControllerPathPrefix() 插件 RestController 统一请求的路径前缀。
String	uploadTempPath() 上传插件包存储的临时路径。

方法详细资料

environment

org.pf4j.RuntimeMode environment()

运行环境。运行项目时的模式。分为开发环境(DEVELOPMENT)、生产环境(DEPLOYMENT)

返回:

RuntimeMode.DEVELOPMENT、RuntimeMode.DEPLOYMENT

pluginPath

String pluginPath()

插件的路径。开发环境建议直接配置为插件模块的父级目录。例如: plugins。如果启动主程序时, 插件为加载, 请检查该配置是否正确。

返回:

插件的路径

pluginConfigFilePath

String pluginConfigFilePath()

插件文件的配置路径。在生产环境下, 插件的配置文件路径。 在生产环境下， 请将所有插件使用到的配置文件统一放到该路径下管理。 在开发环境下，配置为空串。程序会自动从 resources 获取配置文件， 所以请确保编译后的target 下存在该配置文件

返回:

插件文件的配置路径

uploadTempPath

String uploadTempPath()

上传插件包存储的临时路径。默认 temp(相对于主程序jar路径)。

返回:

上传插件的临时保存路径。

backupPath

String backupPath()

插件备份路径。默认 backupPlugin (相对于主程序jar路径)。

返回:

插件备份路径。

pluginRestControllerPathPrefix

String pluginRestControllerPathPrefix()

插件 RestController 统一请求的路径前缀。只有 pluginRestControllerPathPrefix

返回:

path

enablePluginIdRestControllerPathPrefix

boolean enablePluginIdRestControllerPathPrefix()

启用插件id作为RestController的路径前缀。 如果启用。则路径前缀为 pluginRestControllerPathPrefix() 返回的路径拼接插件id, 即为: /pathPrefix/pluginId/**

返回:

boolean