com.atlassian.jira.plugins.ha.container.warhack

Class WarHacker

java.lang.Object

com.atlassian.jira.plugins.ha.container.warhack.WarHacker

public class WarHacker
extends Object

Write modified JIRA WAR files for testing purposes. Original WAR files are not modified.

Constructor Summary

Constructors

Constructor and Description
WarHacker(Path warFile) Creates a WAR Hacker with a base JIRA WAR file.

Method Summary

Modifier and Type	Method and Description
void	addOperation(WarOperation operation)
void	addUpgradeTask(Class<? extends UpgradeTask> upgradeTaskClass) Adds an upgrade task to the WAR and configures it with the next build number.
void	excludeLibs(String... fileNames) Exclude JAR files from WEB-INF/lib in the target WAR by name.
void	incrementBuildNumber() Registers a change to increment JIRA's build number by one.
void	incrementVersionString() Registers a change to increment JIRA's version by one.
void	overrideBuildNumber(java.util.function.Function<String,String> buildNumberTransform) Registers a change to modify the build number of JIRA.
void	overrideVersion(java.util.function.Function<String,String> versionTransform) Registers a change to modify the build number of JIRA.
void	writeWarFile(Path destinationFile) Write a new WAR file with all registered modifications.

Methods inherited from class java.lang.Object

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

Constructor Detail

WarHacker

public WarHacker(Path warFile)

Creates a WAR Hacker with a base JIRA WAR file.

Parameters:

warFile - the JIRA WAR file to use as the base.

Method Detail

addOperation

public void addOperation(WarOperation operation)

overrideBuildNumber

public void overrideBuildNumber(java.util.function.Function<String,String> buildNumberTransform)

Registers a change to modify the build number of JIRA.

Parameters:

buildNumberTransform - how to generate new build number from the old one.

overrideVersion

public void overrideVersion(java.util.function.Function<String,String> versionTransform)

Registers a change to modify the build number of JIRA.

Parameters:

versionTransform - how to generate new build number from the old one.

incrementBuildNumber

public void incrementBuildNumber()

Registers a change to increment JIRA's build number by one.

incrementVersionString

public void incrementVersionString()

Registers a change to increment JIRA's version by one.

excludeLibs

public void excludeLibs(String... fileNames)

Exclude JAR files from WEB-INF/lib in the target WAR by name.

Parameters:

fileNames - the names of the files in WEB-INF/lib to exclude. Do not include path.

addUpgradeTask

public void addUpgradeTask(Class<? extends UpgradeTask> upgradeTaskClass)

Adds an upgrade task to the WAR and configures it with the next build number.

Parameters:

upgradeTaskClass - the upgrade task class.

writeWarFile

public void writeWarFile(Path destinationFile)
                  throws IOException

Write a new WAR file with all registered modifications.

Parameters:

destinationFile - the new WAR file to generate.

Throws:

IOException - if an I/O error occurs reading the original WAR or writing the modified WAR.