Package de.tracetronic.jenkins.plugins.ecutest.report.atx.pipeline

Class ATXServer

java.lang.Object

de.tracetronic.jenkins.plugins.ecutest.report.atx.pipeline.ATXServer

All Implemented Interfaces:

Serializable

public class ATXServer
extends Object
implements Serializable

Class holding ATX server specific settings in order to publish ATX reports.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ATXServer(ATXInstallation installation)	Instantiates a new ATXServer.

Method Summary

Modifier and Type	Method	Description
ATXCustomSetting	getCustomSetting(String settingName)	Gets a single ATX custom setting by name.
ATXInstallation	getInstallation()
ATXSetting<?>	getSetting(String settingName)	Gets a single ATX setting by name.
Map<String,Object>	getSettings()	Gets all ATX settings as map.
void	overrideSetting(String settingName, Object settingValue)	Overrides an existing ATX setting with the specified value.
void	overrideSettings(Map<String,Object> settings)	Override multiple ATX settings via named arguments map.
void	publish()	Publishes ATX reports with default archiving settings.
void	publish(boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll)	Publishes ATX reports with given archiving settings.
void	publish(Map<String,Object> settings)	Publishes ATX reports with given archiving settings as named arguments map.
void	setScript(org.jenkinsci.plugins.workflow.cps.CpsScript script)	Sets the pipeline script.

Methods inherited from class java.lang.Object

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

Constructor Detail

ATXServer

public ATXServer(ATXInstallation installation)

Instantiates a new ATXServer.

Parameters:

installation - the ATX installation

Method Detail

getInstallation

public ATXInstallation getInstallation()

setScript

public void setScript(org.jenkinsci.plugins.workflow.cps.CpsScript script)

Sets the pipeline script.

Parameters:

script - the pipeline script

publish

public void publish()

Publishes ATX reports with default archiving settings.

publish

public void publish(boolean allowMissing,
                    boolean runOnFailed,
                    boolean archiving,
                    boolean keepAll)

Publishes ATX reports with given archiving settings.

Parameters:

allowMissing - specifies whether missing reports are allowed

runOnFailed - specifies whether this publisher even runs on a failed build

archiving - specifies whether archiving artifacts is enabled

keepAll - specifies whether artifacts are archived for all successful builds, otherwise only the most recent

publish

public void publish(Map<String,Object> settings)

Publishes ATX reports with given archiving settings as named arguments map.

Parameters:

settings - the settings map

getSetting

public ATXSetting<?> getSetting(String settingName)

Gets a single ATX setting by name.

Parameters:

settingName - the setting name

Returns:

the setting

getCustomSetting

public ATXCustomSetting getCustomSetting(String settingName)

Gets a single ATX custom setting by name.

Parameters:

settingName - the custom setting name

Returns:

the custom setting

getSettings

public Map<String,Object> getSettings()

Gets all ATX settings as map.

Returns:

the settings map

overrideSetting

public void overrideSetting(String settingName,
                            Object settingValue)

Overrides an existing ATX setting with the specified value.

Parameters:

settingName - the setting name

settingValue - the setting value as String or Boolean

overrideSettings

public void overrideSettings(Map<String,Object> settings)

Override multiple ATX settings via named arguments map.

Parameters:

settings - the settings map