Skip to content

Latest commit

 

History

History
109 lines (83 loc) · 2.83 KB

README.asciidoc

File metadata and controls

109 lines (83 loc) · 2.83 KB
Raw

configuration

This addon provides standalone functionality. The configuration addon enables storing and retrieving of persistent properties per user or project.

Tip
 Every write operation in the Configuration object will automatically flush to the associated configuration file.

Depends on

Addon Exported Optional

projects

yes

yes

ui

yes

yes

org.jboss.forge.furnace.container:cdi

no

no

Setup

This Addon requires the following installation steps.

Add configuration to pom.xml

To use this addon, you must add it as a dependency in the pom.xml of your forge-addon classified artifact:

<dependency>
   <groupId>org.jboss.forge.addon</groupId>
   <artifactId>configuration</artifactId>
   <classifier>forge-addon</classifier>
   <version>${version}</version>
</dependency>

Features

User-scoped Configuration

The Configuration object associated to a user is the default option when injected or retrieved from the AddonRegistry. It stores properties in a XML format in <USER_HOME>/.forge/config.xml.

@Inject private Configuration configuration;

configuration.setString("foo","value");
String foo = configuration.getString("foo");
// foo == "value"
Tip

You may also inject a subset of your configuration. Use the @Subset annotation for this:

@Inject
@Subset("jira")
private Configuration configuration;
Tip

If your addon uses a container that does not support "@Inject" annotations, services such as the Configuration may also be accessed via the AddonRegistry:

Imported<Configuration> imported = addonRegistry.getServices(Configuration.class);
Configuration configuration = imported.get();
Project-scoped Configuration

Project-scoped configuration is provided by accessing the ConfigurationFacet installed by default in any project. It stores the properties in an XML format in a file named .forge_settings inside the project. It is important to note, however, that this file is only created if a configuration property is explicitly set for the first time.

Project project = ...
ConfigurationFacet facet = project.getFacet(ConfigurationFacet.class);
Configuration config = facet.getConfiguration();
Tip
 Project-scoped configuration properties no longer falls back to the user-scoped configuration properties as in Forge 1.x.
Configuration Factory

If a specific file is meant to be used as a configuration file, you can use the ConfigurationFactory to handle it as a Configuration object

@Inject
private ConfigurationFactory configurationFactory;

FileResource<?> resource= ...// Fetch the FileResource representation of a file
Configuration config = configurationFactory.getConfiguration(resource)