io.jenkins.tools.warpackager.lib.config

Class Config

java.lang.Object

io.jenkins.tools.warpackager.lib.config.Config

public class Config
extends Object

Since:

TODO

Author:

Oleg Nenashev

Field Summary

Fields

Modifier and Type	Field and Description
BuildSettings	buildSettings
PackageInfo	bundle
Collection<GroovyHookInfo>	groovyHooks
Collection<DependencyInfo>	libExcludes
Collection<DependencyInfo>	libPatches
Collection<DependencyInfo>	plugins
Map<String,String>	systemProperties
DependencyInfo	war

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
DependencyInfo	findPlugin(String artifactId)
GroovyHookInfo	getHookById(String id)
File	getOutputBOM()
File	getOutputWar()
static Config	loadConfig(File configPath) Loads configuration file.
static Config	loadDemoConfig()
void	overrideByBOM(BOM bom, String environmentName)

Methods inherited from class java.lang.Object

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

Field Detail

buildSettings

public BuildSettings buildSettings

bundle

public PackageInfo bundle

war

public DependencyInfo war

plugins

@CheckForNull
public Collection<DependencyInfo> plugins

libPatches

@CheckForNull
public Collection<DependencyInfo> libPatches

libExcludes

@CheckForNull
public Collection<DependencyInfo> libExcludes

systemProperties

@CheckForNull
public Map<String,String> systemProperties

groovyHooks

@CheckForNull
public Collection<GroovyHookInfo> groovyHooks

Constructor Detail

Config

public Config()

Method Detail

loadDemoConfig

public static Config loadDemoConfig()
                             throws IOException

Throws:

IOException

loadConfig

public static Config loadConfig(@Nonnull
                                File configPath)
                         throws IOException

Loads configuration file. Both standard and essentials.yml formats are supported. The format is determined by the name.

Parameters:

configPath - Path to the configuration file.

Returns:

Loaded configuration

Throws:

IOException - Loading error

getOutputWar

public File getOutputWar()

getOutputBOM

public File getOutputBOM()

getHookById

@CheckForNull
public GroovyHookInfo getHookById(@Nonnull
                                                String id)

findPlugin

@CheckForNull
public DependencyInfo findPlugin(@Nonnull
                                               String artifactId)

overrideByBOM

public void overrideByBOM(@Nonnull
                          BOM bom,
                          @CheckForNull
                          String environmentName)
                   throws IOException

Throws:

IOException