com.atlassian.jira.plugins.ha.container

Interface ContainerSet<T extends Container>

Type Parameters:

T - the container type.

All Known Subinterfaces:

ContainerRule<T>

All Known Implementing Classes:

TomcatContainerSet

public interface ContainerSet<T extends Container>

A set of webapp containers that can potentially run a JIRA cluster.

Method Summary

Modifier and Type	Method and Description
JiraCluster	cluster() Access an object that can perform operations on the JIRA cluster.
List<? extends T>	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	resetClusterState() Reset the tables related to cluster communication & upgrade-tasks in the database of the instance, returning them to their initial state.
void	resetDatabase() Deprecated.
void	setLicenseOnDatabase(String licence) sets licence on database (should be run before container(s) start)
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)

Method Detail

startAll

void startAll()

Start all containers in the set.

stopAll

void stopAll()

Cleanly stop all containers in the set.

getContainers

List<? extends T> getContainers()

Returns:

all containers in the set.

cluster

JiraCluster cluster()

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

Returns:

object that can perform JIRA cluster operations.

installJira

void installJira(JiraType warType)

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

Parameters:

warType - the JIRA version to install.

jiraWarFile

Path jiraWarFile(JiraType warType)

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

Parameters:

warType - JIRA version.

Returns:

the path of the WAR file.

testingPluginFile

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

Return the path to the plugin JAR file.

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

void installWar(Path warFile,
                String context)

Installs a WAR file into all containers in the set.

Parameters:

warFile - the WAR file to install.

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

installTestingPlugins

void installTestingPlugins(JiraType jiraType)

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

Parameters:

jiraType - JIRA version to target.

installSharedPlugin

void installSharedPlugin(Path pluginFile)

Installs a plugin into shared home.

Parameters:

pluginFile - the plugin JAR/OBR file to install.

resetClusterState

void resetClusterState()

Reset the tables related to cluster communication & upgrade-tasks in the database of the instance, returning them to their initial state.

resetDatabase

@Deprecated
void resetDatabase()

Deprecated.

This method will be removed in favor of resetClusterState() starting in 8.2

setLicenseOnDatabase

void setLicenseOnDatabase(String licence)

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

getSharedHome

Path getSharedHome()

waitForUpgradeState

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

waitForStartupOfActiveContainers

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.

Parameters:

timeout - the maximum amount of time to wait.

waitForStartupOfActiveContainers

void waitForStartupOfActiveContainers()

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