com.gitee.starblues.integration

类 ConfigurationBuilder

java.lang.Object

com.gitee.starblues.integration.DefaultIntegrationConfiguration

com.gitee.starblues.integration.ConfigurationBuilder

所有已实现的接口:

IntegrationConfiguration

public class ConfigurationBuilder
extends DefaultIntegrationConfiguration

通过构造者进行配置插件初始化配置

版本:

2.2.0

作者:

zhangzhuo

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ConfigurationBuilder.Builder

构造器概要

构造器

构造器和说明
ConfigurationBuilder(ConfigurationBuilder.Builder builder)

方法概要

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

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ConfigurationBuilder

public ConfigurationBuilder(ConfigurationBuilder.Builder builder)

方法详细资料

toBuilder

public static ConfigurationBuilder.Builder toBuilder()

environment

public org.pf4j.RuntimeMode environment()

从接口复制的说明: IntegrationConfiguration

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

返回:

RuntimeMode.DEVELOPMENT、RuntimeMode.DEPLOYMENT

pluginPath

public String pluginPath()

从接口复制的说明: IntegrationConfiguration

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

返回:

插件的路径

pluginConfigFilePath

public String pluginConfigFilePath()

从接口复制的说明: IntegrationConfiguration

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

返回:

插件文件的配置路径

uploadTempPath

public String uploadTempPath()

从接口复制的说明: IntegrationConfiguration

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

指定者:

uploadTempPath 在接口中 IntegrationConfiguration

覆盖:

uploadTempPath 在类中 DefaultIntegrationConfiguration

返回:

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

backupPath

public String backupPath()

从接口复制的说明: IntegrationConfiguration

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

指定者:

backupPath 在接口中 IntegrationConfiguration

覆盖:

backupPath 在类中 DefaultIntegrationConfiguration

返回:

插件备份路径。

pluginRestControllerPathPrefix

public String pluginRestControllerPathPrefix()

从接口复制的说明: IntegrationConfiguration

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

指定者:

pluginRestControllerPathPrefix 在接口中 IntegrationConfiguration

覆盖:

pluginRestControllerPathPrefix 在类中 DefaultIntegrationConfiguration

返回:

path

enablePluginIdRestControllerPathPrefix

public boolean enablePluginIdRestControllerPathPrefix()

从接口复制的说明: IntegrationConfiguration

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

指定者:

enablePluginIdRestControllerPathPrefix 在接口中 IntegrationConfiguration

覆盖:

enablePluginIdRestControllerPathPrefix 在类中 DefaultIntegrationConfiguration

返回:

boolean