Page tree
Skip to end of metadata
Go to start of metadata

插件作用

Gears properties manage for confluence 主要目标是管理系统级别的全局性的参数;

在一些开发能力较强的企业中,对于在各个插件中使用一些全局性的变量很不方便,经常需要定义一些全局的变更由业务系统进行调整,比如需要与其它系统 集成时需要填写的一些信息,包括如URL,账户名和密码等参数,当这些参数写的较多的时候,对于如要修改接口的URL地址,变更密码,那么修改这些参数值还需要重新进行编码,,或者需要为每一套应用都开发参数管理模块。

此插件的使用是定义全局性的参数,可以将之引用到所需要的任何地址,只需要记住其变更的键值,那么将会产生一处修改,全部修改的效果,同时也可以为所有的应用模块提供参数,而不用为每一个应用进行参数管理的模块开发。

同时,因为对这些参数进行了全局性的可视化管理,在运营和运维中更加方便,只需要在系统中进行查询,而不用再问具体的开发人员是如何定义的。

使用场景

比如需要将第三方的账户名和密码,通过调用第三方地址。

在使用ScriptRunner for confluence的进行调用的时候需要在各地获得相应的参数,

使用此插件可以进行这些参数的统一管理 ,并进行可视化的修改,

本页内容



参数管理

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"
}


产品下载

  File Modified
Java Archive properties-manager-1.0.1.jar Nov 05, 2021 by 红旗公



  • No labels