# 系统配置
# com.eos.foundation.eoscommon.ConfigurationUtil
# 构件包说明
本工具类实现了对构件包及系统配置信息的操作。
# 运算逻辑构件使用说明
该构件包包含以下构件：
| 序号 | 方法 | 功能描述 |
|---|---|---|
| 序号 | 方法 | 功能描述 |
| 1 | getContributionConfig(String ctrName, String module, String group, String key) | 获取指定contribution属性中一个配置参数值 |
| 2 | getContributionConfigBatch(String ctrName, String... params) | 获取指定contribution属性中一组配置参数值 |
| 3 | getSysConfigMultiValue(String... params) | 获取sys-config.xml文件中的多个配置参数值 |
| 4 | getSysConfigSingleValue(String module, String group, String key) | 获取sys-config.xml文件中的一个配置参数值 |
| 5 | getUserConfigMultiValue(String... params) | 获取user-config.xml文件中的多个配置参数值 |
| 6 | getUserConfigSingleValue(String module, String group, String key) | 获取user-config.xml文件中的一个配置参数值 |
| 7 | getUserLocalConfigMultiValue(String... params) | 获取user-local-config.xml文件中的多个配置参数值 |
| 8 | getUserLocalConfigSingleValue(String module, String group, String key) | 获取user-local-config.xml文件中的一个配置参数值 |
# getContributionConfig：获取指定contribution属性中一个配置参数值
# 【功能说明】
获取指定构件包（即contribution）配置信息中配置参数的值。
构件包配置信息可以在Studio在构件包属性窗口中修改，也可以在资源管理视图中构件包目录下的src\META-INF\contribution.eosinf文件中修改。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getContributionConfig，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | ctrName | String | 构件包（即contribution）名称，默认为当前构件包名称 |
| 参数 | module | String | 模块名（对应xpath为contribution/module/@name） |
| 参数 | group | String | 组名（对应xpath为contribution/module/group/@name） |
| 参数 | key | String | 键（对应xpath为contribution/module/group/configValue/@key） |
| 返回值 | out0 | String | 配置信息节点值 |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取构件包的一个属性值。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | ctrName | String | com.primeton.eos.foundation.example | 常量 | 传引用 |
| 参数 | module | String | DataSource | 常量 | 传引用 |
| 参数 | group | String | Reference | 常量 | 传引用 |
| 参数 | key | String | ds1 | 常量 | 传引用 |
| 返回值 | out0 | String | result | 变量 | 传引用 |
参数描述 无。
其他说明 src\META-INF\contribution.eosinf文件内容如下：
<?xml version="1.0" encoding="UTF-8"?>
<contribution xmlns="http://www.primeton.com/xmlns/eos/1.0">
<!-- datasource config -->
<module name="DataSource">
<group name="Reference">
<configValue key="default">default</configValue>
<configValue key="ds1">test1</configValue>
</group>
</module>
...
</contribution>
- 调用前的bizContext
<bizContext>
<__root __id="0" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __type="java:java.lang.String">test1</result>
</__root>
</bizContext>
# getContributionConfigBatch：获取指定contribution属性中一组配置参数值
# 【功能说明】
获取指定构件包（即contribution）属性中一组配置参数的值。
构件包配置信息可以在Studio在构件包属性窗口中修改，也可以在资源管理视图中构件包目录下的src\META-INF\contribution.eosinf文件中修改。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ContributionConfigUtil.getContributionConfigBatch，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | ctrName | String | 构件包（即contribution）名称，默认为当前构件包名称 |
| 参数 | params | String... | 该参数为变长参数，允许三个为一组，成组增加，每组参数的1、2、3分别表示module、group、key，次序不能变 |
| 返回值 | out0 | DataObject | 配置信息节点值 |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取构件包的一组属性值。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | ctrName | String | com.primeton.eos.foundation.example | 常量 | 传引用 |
| 参数 | params | String... | DataSource | 常量 | 传引用 |
| 参数 | param1 | String... | Reference | 常量 | 传引用 |
| 参数 | param2 | String... | ds1 | 常量 | 传引用 |
| 参数 | param3 | String... | Mbean | 常量 | 传引用 |
| 参数 | param4 | String... | DatasourceMBean | 常量 | 传引用 |
| 参数 | param5 | String... | ConfigFileType | 常量 | 传引用 |
| 返回值 | out0 | DataObject | result | 变量 | 传引用 |
参数描述 无。
其他说明 src\META-INF\contribution.eosinf文件内容如下：
<?xml version="1.0" encoding="UTF-8"?>
<contribution xmlns="http://www.primeton.com/xmlns/eos/1.0">
<!-- MBean config -->
<module name="Mbean">
<!-- DataSourceMBean config -->
<group name="DatasourceMBean">
<configValue key="Type">config</configValue>
<configValue key="Class">com.eos.system.management.config.mbean.Config</configValue>
<configValue key="Handler">
com.eos.common.connection.mbean.ContributionDataSourceConfigHandler</configValue>
<configValue key="ConfigFileType">config</configValue>
</group>
<group name="ContributionLoggerMBean">
<configValue key="Type">config</configValue>
<configValue key="Class">com.eos.system.management.config.mbean.Config</configValue>
<configValue key="Handler">com.eos.common.logging.mbean.LogConfigHandler</configValue>
<configValue key="ConfigFileType">log</configValue>
</group>
</module>
<!-- datasource config -->
<module name="DataSource">
<group name="Reference">
<configValue key="default">default</configValue>
<configValue key="ds1">test1</configValue>
</group>
</module>
</contribution>
- 调用前的bizContext
<bizContext>
<__root __id="0" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __id="1" __type="sdo:com.primeton.das.datatype.AnyType">
<ds1 __type="java:java.lang.String">test1</ds1>
<ConfigFileType __type="java:java.lang.String">config</ConfigFileType>
</result>
</__root>
</bizContext>
# getSysConfigMultiValue：获取sys-config.xml文件中的多个配置参数值
# 【功能说明】
获取系统配置文件sys-config.xml中的多个配置参数值。
修改了sys-config.xml配置，需要重启后才生效。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getSysConfigMultiValue，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | params | java.lang.String... | 该参数为变长参数，允许三个为一组，成组增加。每组参数的1、2、3个分别表示module、group、key |
| 返回值 | commonj.sdo.DataObject | 保存参数值的DataObject，DataObject中的属性名称是key |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取系统配置"用于存放Lob的临时目录"和Das的PoolSize。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | params | java.lang.String | Das | 常量 | 传引用 |
| 参数 | param1 | java.lang.String | Lob | 常量 | 传引用 |
| 参数 | param2 | java.lang.String | TempDir | 常量 | 传引用 |
| 参数 | param3 | java.lang.String | Das | 常量 | 传引用 |
| 参数 | param4 | java.lang.String | PoolSize | 常量 | 传引用 |
| 参数 | param5 | java.lang.String | PoolSize | 常量 | 传引用 |
| 返回值 | out0 | commonj.sdo.DataObject | result | 变量 | 传引用 |
参数描述 无。
其他说明 "用于存放Lob的临时目录"在sys-config.xml中的配置如下：
<module name="Das">
<group name="PoolSize">
<configValue key="PoolSize">100</configValue>
</group>
<group name="Lob">
<configValue key="TempDir">lob_temp</configValue>
</group>
</module>
因此：
它们对应的moudle为Das、对应的group为Lob、对应的key为TempDir
它们对应的moudle为Das、对应的group为PoolSize、对应的key为PoolSize
调用前的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __isNullOrEmpty="null"/>
</__root>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __id="1" __type="sdo:com.primeton.das.datatype.AnyType">
<TempDir __type="java:java.lang.String">lob_temp</TempDir>
<PoolSize __type="java:java.lang.String">20</PoolSize>
</result>
</__root>
</bizContext>
# getSysConfigSingleValue：获取sys-config.xml文件中的一个配置参数值
# 【功能说明】
获取系统配置文件sys-config.xml中的一个配置参数值。
修改了sys-config.xml配置，需要重启后才生效。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getSysConfigSingleValue，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | module | java.lang.String | 模块 |
| 参数 | group | java.lang.String | 组名 |
| 参数 | key | java.lang.String | 键名 |
| 返回值 | java.lang.String | 配置值 |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取系统配置"用于存放Lob的临时目录"。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | module | java.lang.String | Das | 常量 | 传引用 |
| 参数 | group | java.lang.String | Lob | 常量 | 传引用 |
| 参数 | key | java.lang.String | TempDir | 常量 | 传引用 |
| 返回值 | out0 | java.lang.String | result | 变量 | 传引用 |
参数描述 无。
其他说明 "用于存放Lob的临时目录"在sys-config.xml中的配置如下：
<module name="Das">
<group name="Lob">
<configValue key="TempDir">lob_temp</configValue>
</group>
</module>
因此，它对应的moudle为Das、对应的group为Lob、对应的key为TempDir。
- 调用前的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __isNullOrEmpty="null"/>
</__root>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __type="java:java.lang.String">lob_temp</result>
</__root>
</bizContext>
# getUserConfigMultiValue：获取user-config.xml文件中的多个配置参数值
# 【功能说明】
获取用户配置文件user-config.xml中的多个配置参数值。
修改了user-config.xml配置，需要重启后才生效。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getUserConfigMultiValue，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | params | java.lang.String... | 该参数为变长参数，允许三个为一组，成组增加。每组参数的1、2、3个分别表示module、group、key |
| 返回值 | commonj.sdo.DataObject | 保存参数值的DataObject，DataObject中的属性名称是key |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取用户配置"系统默认Email的host、用户"。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | params | java.lang.String | 常量 | 传引用 | |
| 参数 | param1 | java.lang.String | Default | 常量 | 传引用 |
| 参数 | param2 | java.lang.String | Host | 常量 | 传引用 |
| 参数 | param3 | java.lang.String | 常量 | 传引用 | |
| 参数 | param4 | java.lang.String | Default | 常量 | 传引用 |
| 参数 | param5 | java.lang.String | UserName | 常量 | 传引用 |
| 返回值 | out0 | commonj.sdo.DataObject | result | 变量 | 传引用 |
参数描述 无。
其他说明 "系统默认Email的host、用户"在user-config.xml中的配置如下：
<module name="Email">
<group name="Default">
<configValue key="Host">mail.primeton.com</configValue>
<configValue key="UserName">test</configValue>
<configValue key="Password">test</configValue>
</group>
</module>
因此：
它们对应的moudle为Email、对应的group为Default、对应的key为Host
它们对应的moudle为Email、对应的group为Default、对应的key为UserName
调用前的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __isNullOrEmpty="null"/>
</__root>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __id="1" __type="sdo:com.primeton.das.datatype.AnyType">
<Host __type="java:java.lang.String">mail.primeton.com</Host>
<UserName __type="java:java.lang.String">test</UserName>
</result>
</__root>
</bizContext>
# getUserConfigSingleValue：获取user-config.xml文件中的一个配置参数值
# 【功能说明】
获取用户配置文件user-config.xml中的一个配置参数值。
修改了user-config.xml配置，需要重启后才生效。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getUserConfigSingleValue，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | module | java.lang.String | 模块 |
| 参数 | group | java.lang.String | 组名 |
| 参数 | key | java.lang.String | 键名 |
| 返回值 | java.lang.String | 配置值 |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取用户配置"系统默认Email的host"。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | module | java.lang.String | 常量 | 传引用 | |
| 参数 | group | java.lang.String | Default | 常量 | 传引用 |
| 参数 | key | java.lang.String | Host | 常量 | 传引用 |
| 返回值 | out0 | java.lang.String | result | 变量 | 传引用 |
参数描述 无。
其他说明 "系统默认Email的host"在user-config.xml中的配置如下：
<module name="Email">
<group name="Default">
<configValue key="Host">mail.primeton.com</configValue>
<configValue key="UserName">test</configValue>
<configValue key="Password">test</configValue>
</group>
</module>
因此，它对应的moudle为Email、对应的group为Default、对应的key为Host。
- 调用前的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __isNullOrEmpty="null"/>
</__root>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __type="java:java.lang.String">mail.primeton.com</result>
</__root>
</bizContext>
# getUserLocalConfigMultiValue：获取user-local-config.xml文件中的多个配置参数值
# 【功能说明】
获取本地用户配置文件user-local-config.xml中的多个配置参数值。
修改了user-local-config.xml配置，需要重启后才生效。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getUserLocalConfigMultiValue，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | params | java.lang.String... | 该参数为变长参数，允许三个为一组，成组增加。每组参数的1、2、3个分别表示module、group、key |
| 返回值 | commonj.sdo.DataObject | 保存参数值的DataObject，DataObject中的属性名称是key |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取用户配置"流程引擎代码生成后的存放目录、ClassPath"。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | params | java.lang.String | Engine | 常量 | 传引用 |
| 参数 | param1 | java.lang.String | Runtime-Java-Build | 常量 | 传引用 |
| 参数 | param2 | java.lang.String | Class-Path | 常量 | 传引用 |
| 参数 | param3 | java.lang.String | Engine | 常量 | 传引用 |
| 参数 | param4 | java.lang.String | Runtime-Java-Build | 常量 | 传引用 |
| 参数 | param5 | java.lang.String | Source-Path | 常量 | 传引用 |
| 返回值 | out0 | commonj.sdo.DataObject | result | 变量 | 传引用 |
参数描述 无。
其他说明 "流程引擎代码生成后的存放目录、ClassPath"在user-local-config.xml中的配置如下：
<module name="Engine">
<group name="Runtime-Java-Build">
<configValue key="Class-Path"/>
<configValue key="Source-Path">temp</configValue>
</group>
</module>
因此：
它们对应的moudle为Engine、对应的group为Runtime-Java-Build、对应的key为Class-Path
它们对应的moudle为Engine、对应的group为Runtime-Java-Build、对应的key为Source-Path
调用前的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __isNullOrEmpty="null"/>
</__root>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __id="1" __type="sdo:com.primeton.das.datatype.AnyType">
<Class-Path __isNullOrEmpty="empty" __type="java:java.lang.String"/>
<Source-Path __type="java:java.lang.String">temp</Source-Path>
</result>
</__root>
</bizContext>
# getUserLocalConfigSingleValue：获取user-local-config.xml文件中的一个配置参数值
# 【功能说明】
获取本地用户配置文件user-local-config.xml中的一个配置参数值。
修改了user-local-config.xml配置，需要重启后才生效。
# 【版本说明】
从EOS 6.0开始提供。
# 【引用路径】
- 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.ConfigurationUtil.getUserLocalConfigSingleValue，包含在com.eos.foundation.jar中。
- 运算逻辑定义在构件包com.eos.foundation中。
# 【使用说明】
- 参数说明
| 类型 | 名称 | 数据类型 | 参数描述 |
|---|---|---|---|
| 参数 | module | java.lang.String | 模块 |
| 参数 | group | java.lang.String | 组名 |
| 参数 | key | java.lang.String | 键名 |
| 返回值 | java.lang.String | 配置值 |
抛出异常说明 无。
规则说明 无。
# 【参考案例】
示例：获取本地用户配置"流程引擎代码生成后的存放目录"。
场景描述 无。
参数设置
| 类型 | 名称 | 数据类型 | 值 | 值类别 | 传递方式 |
|---|---|---|---|---|---|
| 参数 | module | java.lang.String | Engine | 常量 | 传引用 |
| 参数 | group | java.lang.String | Runtime-Java-Build | 常量 | 传引用 |
| 参数 | key | java.lang.String | Source-Path | 常量 | 传引用 |
| 返回值 | out0 | java.lang.String | result | 变量 | 传引用 |
参数描述 无。
其他说明 "流程引擎代码生成后的存放目录"在user-local-config.xml中的配置如下：
<module name="Engine">
<group name="Runtime-Java-Build">
<configValue key="Source-Path">temp</configValue>
</group>
</module>
因此，它对应的moudle为Engine、对应的group为Runtime-Java-Build、对应的key为Source-Path。
- 调用前的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __isNullOrEmpty="null"/>
</__root>
</bizContext>
- 调用后的bizContext
<bizContext>
<__root __id="0" __type="java:java.util.HashMap">
<result __type="java:java.lang.String">temp</result>
</__root>
</bizContext>