使用PluginSettings的Jira SAL

Question

我寻找一种方法来存储特定于我的插件的项目配置。在第一步中，我只想存储一个简单的字符串，比如"Hello“。

所以，我发现的是萨尔和PluginSettings。https://developer.atlassian.com/docs/atlassian-platform-common-components/shared-access-layer/sal-services

这看起来很容易使用，但是我不知道如何将它实现到我的代码中。我使用了项目管理部分中发生的WebWork：

@Override
public String doDefault() throws Exception {
    Project project = getProjectManager().getProjectObjByKey(_projectKey);
    HttpServletRequest request = ExecutingHttpRequest.get();
    request.setAttribute((new StringBuilder()).append("com.atlassian.jira.projectconfig.util.ServletRequestProjectConfigRequestCache").append(":project").toString(), project);
    return INPUT;
}

@Override
protected String doExecute() throws Exception {
    Project project = getProjectManager().getProjectObjByKey(_projectKey);
    HttpServletRequest request = ExecutingHttpRequest.get();
    request.setAttribute((new StringBuilder()).append("com.atlassian.jira.projectconfig.util.ServletRequestProjectConfigRequestCache").append(":project").toString(), project);
    String param = request.getParameter("param");
    return SUCCESS;
}

public void setProjectKey(String projectKey) {
    _projectKey = projectKey;
    }

public String getProjectKey() {
    return _projectKey;
}

public String getBaseUrl() {
    return ComponentAccessor.getApplicationProperties().getString(APKeys.JIRA_BASEURL);
}

正如SAL所说，我实现了一个Settings-Class：

public CustomProjectSettings(
        final PluginSettingsFactory pluginSettingsFactory,
        final String projectKey) {
    this.pluginSettingsFactory = pluginSettingsFactory;
    this.projectKey = projectKey;
}

public void setValue(final String key, final String value) {
    final PluginSettings settings = pluginSettingsFactory
            .createSettingsForKey(projectKey);
    settings.put(key, value);
}

public Object getValue(final String key) {
    final PluginSettings settings = pluginSettingsFactory
            .createSettingsForKey(projectKey);
    return settings.get(key);
}

我在xml中添加了组件：

<component-import key="pluginSettingsFactory" interface="com.atlassian.sal.api.pluginsettings.PluginSettingsFactory" />

那么，我如何将这些连接并实现到我的网络工作中呢？

protected String doExecute() throws Exception{
    [...]
    pluginSettings.setValue("Key", param);
    [...]
}

Answer 1

比我想象的要容易。我只需将设置作为WebWork的依赖项注入：

public WebWorkAction(CustomProjectSettings settings){
    this.settings = settings
}

设置-类自动由

<component-import key="pluginSettingsFactory" 
interface="com.atlassian.sal.api.pluginsettings.PluginSettingsFactory" />

并通过添加

<component key="settingsComponent"
      class="com.xxx.CustomProjectSettings">
</component>