Gears properties manager for confluence为了能够对全局性的参数进行统一管理,并方便管理人进行维护,比如管理员需要写入多个与第三方系统进行对接的参数,那么他可以将这些参数进行分组;
因此,对全局性分组,在此插件中将以前缀来进行区别;那么在对参数进行管理的时候,首先需要确定此参数应当归属哪一个前缀。
前缀信息
前缀信息是对全局性参数进行分组的一个定义,因此需要进行前缀的管理。
可以转到前缀信息中,对前缀进行增加管理。保存后将显示系统中已定义的前缀信息。
键值信息
键值信息是提供给业务使用的有效信息,允许在相应前缀中增加一个键值对,以便在系统中通过全键获取信息。
可以选择系统中定义的前缀查询此前缀中包括的所有键值对,当然对某一个键值对也可以进行修改操作。
如果需要在一个前缀中新增加一个键值对,那么可以新增一个,此时我们点击“新增”,即可弹出新增界面进行填写。
键值对使用
当对键值对进行定义新增加之后,那么可以在需要的地方获得它的信息,以便开展业务上的处理。
使用时,如查使用如下代码来获得需要获得的参数信息。
String fullkey = "HKTXPROPERTIESKEY.seven.name"; ConfluenceBandanaContext context = new ConfluenceBandanaContext(); String value = (String)bandanaManager.getValue(context,fullkey);
## 注意fullkey是指在键值信息列表中显示在第一列中的全键信息,而不是在新增的时候填写的key值
全键信息包括插件定义的统一大前缀+前缀+键值
REST API
获得一个前缀所有的参数信息
- 接口
/rest/gearsproperties/1.0/properties/prefix/{prefixkey}
- 方法
get
- 示例
/rest/gearsproperties/1.0/properties/prefix/ITDESK
{ "fullkey": "HKTXPROPERTIESKEY.ITDESK.StaffId", "prefix": "ITDESK", "key": "StaffId", "value": "1123" }, { "fullkey": "HKTXPROPERTIESKEY.ITDESK.key1", "prefix": "ITDESK", "key": "key1", "value": "value11" }, { "fullkey": "HKTXPROPERTIESKEY.ITDESK.key2", "prefix": "ITDESK", "key": "key2", "value": "value22" } ]
获得一个全Key参数信息
- 接口
/rest/gearsproperties/1.0/properties/fullkey/{fullkey}
- 方法
get
- 示例
/rest/gearsproperties/1.0/properties/fullkey/HKTXPROPERTIESKEY.ITDESK.StaffId
[
{ "fullkey": "HKTXPROPERTIESKEY.ITDESK.StaffId", "value": "1123" }
产品下载