com.atlassian.jira.plugins.ha.container

Class TomcatContainerSet

java.lang.Object

com.atlassian.jira.plugins.ha.container.TomcatContainerSet

All Implemented Interfaces:

ContainerSet<TomcatContainer>

public class TomcatContainerSet
extends Object
implements ContainerSet<TomcatContainer>

Method Summary

Modifier and Type	Method and Description
void	cleanDatabase() Remove all Jira tables.
JiraCluster	cluster() Access an object that can perform operations on the JIRA cluster.
List<? extends TomcatContainer>	getContainers()
Path	getSharedHome()
void	installJira(JiraType warType) Installs a predefined JIRA WAR into all containers in the set.
void	installSharedPlugin(Path pluginFile) Installs a plugin into shared home.
void	installTestingPlugins(JiraType jiraType) Installs any plugins to shared home that are required for testing.
void	installWar(Path warFile, String context) Installs a WAR file into all containers in the set.
Path	jiraWarFile(JiraType warType) Return the path of a predefined JIRA WAR file.
void	reinitialiseDatabase() Reinsert the basic Jira tables, so that Jira is initialised, licensed, but without any issues.
void	resetClusterState() Deprecated.
void	resetDatabase() Deprecated.
void	setLicenseOnDatabase(String license) Sets licence on database (should be run before container(s) start).
void	setSharedHome(Path path) Sets path to shared home.
void	startAll() Start all containers in the set.
void	stopAll() Cleanly stop all containers in the set.
Optional<Path>	testingPluginFile(String name, JiraType jarType) Return the path to the plugin JAR file.
void	waitForStartupOfActiveContainers() Waits for a default maximum amount of time for all containers that are starting to complete startup and join the cluster.
void	waitForStartupOfActiveContainers(java.time.Duration timeout) Waits at most the specified amount of time for all containers to finish starting up and join the cluster.
void	waitForUpgradeState(ZeroDowntimeControl.UpgradeState targetState, java.time.Duration timeout)

Methods inherited from class java.lang.Object

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

Method Detail

getContainers

public List<? extends TomcatContainer> getContainers()

Specified by:

getContainers in interface ContainerSet<TomcatContainer>

Returns:

all containers in the set.

startAll

public void startAll()

Description copied from interface: ContainerSet

Start all containers in the set.

Specified by:

startAll in interface ContainerSet<TomcatContainer>

stopAll

public void stopAll()

Description copied from interface: ContainerSet

Cleanly stop all containers in the set.

Specified by:

stopAll in interface ContainerSet<TomcatContainer>

cluster

public JiraCluster cluster()

Description copied from interface: ContainerSet

Access an object that can perform operations on the JIRA cluster. Access REST endpoints through this.

Specified by:

cluster in interface ContainerSet<TomcatContainer>

Returns:

object that can perform JIRA cluster operations.

installJira

public void installJira(JiraType warType)

Description copied from interface: ContainerSet

Installs a predefined JIRA WAR into all containers in the set.

Specified by:

installJira in interface ContainerSet<TomcatContainer>

Parameters:

warType - the JIRA version to install.

jiraWarFile

public Path jiraWarFile(JiraType warType)

Description copied from interface: ContainerSet

Return the path of a predefined JIRA WAR file. File may not actually exist.

Specified by:

jiraWarFile in interface ContainerSet<TomcatContainer>

Parameters:

warType - JIRA version.

Returns:

the path of the WAR file.

testingPluginFile

public Optional<Path> testingPluginFile(String name,
                                        JiraType jarType)

Description copied from interface: ContainerSet

Return the path to the plugin JAR file.

Specified by:

testingPluginFile in interface ContainerSet<TomcatContainer>

Parameters:

name - the name of the plugin. For example, "jira-ha-plugin" will search for a file called "jira-ha-plugin-.*.jar".

jarType - JIRA version.

Returns:

the path of the JAR file.

installWar

public void installWar(Path warFile,
                       String context)

Description copied from interface: ContainerSet

Installs a WAR file into all containers in the set.

Specified by:

installWar in interface ContainerSet<TomcatContainer>

Parameters:

warFile - the WAR file to install.

context - the context path. Do not include any leading or trailing '/' characters.

installTestingPlugins

public void installTestingPlugins(JiraType jiraType)

Description copied from interface: ContainerSet

Installs any plugins to shared home that are required for testing. These plugins are the func-test plugin, ha plugin, etc.

Specified by:

installTestingPlugins in interface ContainerSet<TomcatContainer>

Parameters:

jiraType - JIRA version to target.

installSharedPlugin

public void installSharedPlugin(Path pluginFile)

Description copied from interface: ContainerSet

Installs a plugin into shared home.

Specified by:

installSharedPlugin in interface ContainerSet<TomcatContainer>

Parameters:

pluginFile - the plugin JAR/OBR file to install.

resetClusterState

@Deprecated
public void resetClusterState()

Deprecated.

Description copied from interface: ContainerSet

No-op. This empty method is left not to break 8.13 -> 8.14 merge.

Specified by:

resetClusterState in interface ContainerSet<TomcatContainer>

cleanDatabase

public void cleanDatabase()

Description copied from interface: ContainerSet

Remove all Jira tables. We're doing this rather than dropping the whole DB, because database drop requires superuser permissions.

Specified by:

cleanDatabase in interface ContainerSet<TomcatContainer>

reinitialiseDatabase

public void reinitialiseDatabase()

Description copied from interface: ContainerSet

Reinsert the basic Jira tables, so that Jira is initialised, licensed, but without any issues.

Specified by:

reinitialiseDatabase in interface ContainerSet<TomcatContainer>

resetDatabase

@Deprecated
public void resetDatabase()

Deprecated.

Description copied from interface: ContainerSet

No-op. This empty method is left not to break 8.13 -> 8.14 merge.

Specified by:

resetDatabase in interface ContainerSet<TomcatContainer>

setLicenseOnDatabase

public void setLicenseOnDatabase(String license)

Description copied from interface: ContainerSet

Sets licence on database (should be run before container(s) start).

Specified by:

setLicenseOnDatabase in interface ContainerSet<TomcatContainer>

getSharedHome

public Path getSharedHome()

Specified by:

getSharedHome in interface ContainerSet<TomcatContainer>

setSharedHome

public void setSharedHome(Path path)

Description copied from interface: ContainerSet

Sets path to shared home.

Specified by:

setSharedHome in interface ContainerSet<TomcatContainer>

Parameters:

path - shared home path.

waitForUpgradeState

public void waitForUpgradeState(ZeroDowntimeControl.UpgradeState targetState,
                                java.time.Duration timeout)

Specified by:

waitForUpgradeState in interface ContainerSet<TomcatContainer>

waitForStartupOfActiveContainers

public void waitForStartupOfActiveContainers(java.time.Duration timeout)

Description copied from interface: ContainerSet

Waits at most the specified amount of time for all containers to finish starting up and join the cluster.

Specified by:

waitForStartupOfActiveContainers in interface ContainerSet<TomcatContainer>

Parameters:

timeout - the maximum amount of time to wait.

waitForStartupOfActiveContainers

public void waitForStartupOfActiveContainers()

Description copied from interface: ContainerSet

Waits for a default maximum amount of time for all containers that are starting to complete startup and join the cluster.

Specified by:

waitForStartupOfActiveContainers in interface ContainerSet<TomcatContainer>