Package com.mooltiverse.oss.nyx.configuration

Class Configuration

java.lang.Object

com.mooltiverse.oss.nyx.configuration.Configuration

All Implemented Interfaces:

ConfigurationRoot

public class Configuration
extends Object
implements ConfigurationRoot

The Nyx configuration. The configuration is a live object that resolves each option lazily, only when required. This not only improves the overall performances but is also safer as in case of malformed configuration options, only those actually needed are resolved.
This means that even if the configuration sources don't change throughout a release process, the state of the configuration may change every time a not yet resolved option is requested and evaluated.
The configuration is layered, where each layer represents a source of configuration options. There is a clear definition of priorities among different layers so there is a clear precedence of options coming from one layer or another. Thanks to this, each option can be overridden by other layer with higher priority.
There must be only one instance of this class for every execution and it's retrieved by Nyx.configuration().

Constructor Summary

Constructors

Constructor	Description
Configuration()	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getBump()	Returns the version identifier to bump as it's defined by this configuration.
ChangelogConfiguration	getChangelog()	Returns the changelog configuration section.
CommitMessageConventions	getCommitMessageConventions()	Returns the commit message convention configuration section.
String	getConfigurationFile()	Returns the path to a custom configuration file as it's defined by this configuration.
String	getDirectory()	Returns the directory to use as the working directory as it's defined by this configuration.
Boolean	getDryRun()	Returns the value of the dry run flag as it's defined by this configuration.
GitConfiguration	getGit()	Returns the Git configuration section.
String	getInitialVersion()	Returns the initial version defined by this configuration to use when no past version is available in the commit history.
String	getPreset()	Returns selected preset configuration as it's defined by this configuration.
Map<String,Attachment>	getReleaseAssets()	Returns the release assets configuration section.
Boolean	getReleaseLenient()	Returns the flag that enables tolerance in reading release names with arbitrary prefixes or extra non critical characters as it's defined by this configuration.
String	getReleasePrefix()	Returns the prefix to use in release name generation as it's defined by this configuration.
ReleaseTypes	getReleaseTypes()	Returns the release types configuration section.
Boolean	getResume()	Returns the value of the resume flag as it's defined by this configuration.
Scheme	getScheme()	Returns the versioning scheme to use as it's defined by this configuration.
Map<String,ServiceConfiguration>	getServices()	Returns the services configuration section.
String	getSharedConfigurationFile()	Returns the path to a custom shared configuration file as it's defined by this configuration.
String	getStateFile()	Returns the path to the file where the Nyx State must be saved as it's defined by this configuration.
Substitutions	getSubstitutions()	Returns the substitutions configuration section.
Boolean	getSummary()	Returns the value of the summary flag as it's defined by this configuration.
String	getSummaryFile()	Returns the path to the file where the Nyx summary must be saved as it's defined by this configuration.
Verbosity	getVerbosity()	Returns the logging verbosity level as it's defined by this configuration.
String	getVersion()	Returns the version defined by this configuration.
static void	setDefaultDirectory(File directory)	This method allows to override the default directory that will be returned by getDirectory().
Configuration	withCommandLineConfiguration(ConfigurationLayer layer)	Adds, replaces or removes the layer at the LayerPriority.COMMAND_LINE level.
Configuration	withPluginConfiguration(ConfigurationLayer layer)	Adds, replaces or removes the layer at the LayerPriority.PLUGIN level.
Configuration	withRuntimeConfiguration(ConfigurationLayer layer)	Adds, replaces or removes the layer at the LayerPriority.RUNTIME level, which is the one that can override all other layers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Configuration

public Configuration()
              throws DataAccessException,
IllegalPropertyException

Default constructor. Returns a new configuration object at its initial state. Instances of this class are created using the Nyx.configuration() method so this constructor should never be used alone. See Nyx.configuration()

Throws:

DataAccessException - in case data cannot be read or accessed.

IllegalPropertyException - in case some option has been defined but has incorrect values or it can't be resolved.

Method Details

withCommandLineConfiguration

public Configuration withCommandLineConfiguration(ConfigurationLayer layer)
                                           throws DataAccessException,
IllegalPropertyException

Adds, replaces or removes the layer at the LayerPriority.COMMAND_LINE level.

Parameters:

layer - the configuration layer to set at the LayerPriority.COMMAND_LINE level. If null any existing configuration layer at the same level is removed (if any).

Returns:

a reference to this same object.

Throws:

DataAccessException - in case data cannot be read or accessed.

IllegalPropertyException - in case some option has been defined but has incorrect values or it can't be resolved.

withPluginConfiguration

public Configuration withPluginConfiguration(ConfigurationLayer layer)
                                      throws DataAccessException,
IllegalPropertyException

Adds, replaces or removes the layer at the LayerPriority.PLUGIN level.

Parameters:

layer - the configuration layer to set at the LayerPriority.PLUGIN level. If null any existing configuration layer at the same level is removed (if any).

Returns:

a reference to this same object.

Throws:

DataAccessException - in case data cannot be read or accessed.

IllegalPropertyException - in case some option has been defined but has incorrect values or it can't be resolved.

withRuntimeConfiguration

public Configuration withRuntimeConfiguration(ConfigurationLayer layer)
                                       throws DataAccessException,
IllegalPropertyException

Adds, replaces or removes the layer at the LayerPriority.RUNTIME level, which is the one that can override all other layers.

Parameters:

layer - the configuration layer to set at the LayerPriority.RUNTIME level. If null any existing configuration layer at the same level is removed (if any).

Returns:

a reference to this same object.

Throws:

DataAccessException - in case data cannot be read or accessed.

IllegalPropertyException - in case some option has been defined but has incorrect values or it can't be resolved.

getBump

public String getBump()
               throws DataAccessException,
IllegalPropertyException

Returns the version identifier to bump as it's defined by this configuration.

Specified by:

getBump in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getChangelog

public ChangelogConfiguration getChangelog()
                                    throws DataAccessException,
IllegalPropertyException

Returns the changelog configuration section.

Specified by:

getChangelog in interface ConfigurationRoot

Returns:

the changelog configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getCommitMessageConventions

public CommitMessageConventions getCommitMessageConventions()
                                                     throws DataAccessException,
IllegalPropertyException

Returns the commit message convention configuration section.

Specified by:

getCommitMessageConventions in interface ConfigurationRoot

Returns:

the commit message convention configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getConfigurationFile

public String getConfigurationFile()
                            throws DataAccessException,
IllegalPropertyException

Returns the path to a custom configuration file as it's defined by this configuration.

Specified by:

getConfigurationFile in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getDirectory

public String getDirectory()
                    throws DataAccessException,
IllegalPropertyException

Returns the directory to use as the working directory as it's defined by this configuration.

Specified by:

getDirectory in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

See Also:

• State.getDirectory()

setDefaultDirectory

public static void setDefaultDirectory(File directory)

This method allows to override the default directory that will be returned by getDirectory(). This method must be invoked before instances of Nyx or other classes are created or the given value may be ignored.

Parameters:

directory - the new default directory. If null then the standard default directory will be used.

getDryRun

public Boolean getDryRun()
                  throws DataAccessException,
IllegalPropertyException

Returns the value of the dry run flag as it's defined by this configuration.

Specified by:

getDryRun in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getGit

public GitConfiguration getGit()
                        throws DataAccessException,
IllegalPropertyException

Returns the Git configuration section.

Specified by:

getGit in interface ConfigurationRoot

Returns:

the Git configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getInitialVersion

public String getInitialVersion()
                         throws DataAccessException,
IllegalPropertyException

Returns the initial version defined by this configuration to use when no past version is available in the commit history.

Specified by:

getInitialVersion in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getPreset

public String getPreset()
                 throws DataAccessException,
IllegalPropertyException

Returns selected preset configuration as it's defined by this configuration.

Specified by:

getPreset in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleaseAssets

public Map<String,Attachment> getReleaseAssets()
                                        throws DataAccessException,
IllegalPropertyException

Returns the release assets configuration section.

Specified by:

getReleaseAssets in interface ConfigurationRoot

Returns:

the release assets configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleaseLenient

public Boolean getReleaseLenient()
                          throws DataAccessException,
IllegalPropertyException

Returns the flag that enables tolerance in reading release names with arbitrary prefixes or extra non critical characters as it's defined by this configuration.

Specified by:

getReleaseLenient in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleasePrefix

public String getReleasePrefix()
                        throws DataAccessException,
IllegalPropertyException

Returns the prefix to use in release name generation as it's defined by this configuration.

Specified by:

getReleasePrefix in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleaseTypes

public ReleaseTypes getReleaseTypes()
                             throws DataAccessException,
IllegalPropertyException

Returns the release types configuration section.

Specified by:

getReleaseTypes in interface ConfigurationRoot

Returns:

the release types configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getResume

public Boolean getResume()
                  throws DataAccessException,
IllegalPropertyException

Returns the value of the resume flag as it's defined by this configuration.

Specified by:

getResume in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getScheme

public Scheme getScheme()
                 throws DataAccessException,
IllegalPropertyException

Returns the versioning scheme to use as it's defined by this configuration.

Specified by:

getScheme in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getServices

public Map<String,ServiceConfiguration> getServices()
                                             throws DataAccessException,
IllegalPropertyException

Returns the services configuration section.

Specified by:

getServices in interface ConfigurationRoot

Returns:

the services configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSharedConfigurationFile

public String getSharedConfigurationFile()
                                  throws DataAccessException,
IllegalPropertyException

Returns the path to a custom shared configuration file as it's defined by this configuration.

Specified by:

getSharedConfigurationFile in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getStateFile

public String getStateFile()
                    throws DataAccessException,
IllegalPropertyException

Returns the path to the file where the Nyx State must be saved as it's defined by this configuration.

Specified by:

getStateFile in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSubstitutions

public Substitutions getSubstitutions()
                               throws DataAccessException,
IllegalPropertyException

Returns the substitutions configuration section.

Specified by:

getSubstitutions in interface ConfigurationRoot

Returns:

the substitutions configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSummary

public Boolean getSummary()
                   throws DataAccessException,
IllegalPropertyException

Returns the value of the summary flag as it's defined by this configuration.

Specified by:

getSummary in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSummaryFile

public String getSummaryFile()
                      throws DataAccessException,
IllegalPropertyException

Returns the path to the file where the Nyx summary must be saved as it's defined by this configuration.

Specified by:

getSummaryFile in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getVerbosity

public Verbosity getVerbosity()
                       throws DataAccessException,
IllegalPropertyException

Returns the logging verbosity level as it's defined by this configuration. Please note that the verbosity option is actually ignored in this library implementation as the event filtering based on the verbosity needs to be configured outside this library, depending on the logging framework deployed along with SLF4J. See here for more.

Specified by:

getVerbosity in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getVersion

public String getVersion()
                  throws DataAccessException,
IllegalPropertyException

Returns the version defined by this configuration.

Specified by:

getVersion in interface ConfigurationRoot

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.