com.atlassian.jira.plugins.ha.container

Interface Container

All Known Implementing Classes:

TomcatContainer

public interface Container

A single webapp container that can hold a running instance of JIRA.

Method Summary

Modifier and Type	Method and Description
void	generateThreadDump() Generate a thread dump of this process to the logs.
ClusterNodeProperties	getClusterProperties()
Path	getLocalHome()
Map<String,String>	getSystemProperties()
void	installJira(JiraType warType) Installs a predefined JIRA WAR into this container.
void	installWar(Path warFile, String context) Installs a WAR file intothis container.
JiraCluster.Node	jiraNode()
void	start() Start the instance.
void	stop() Cleanly stop the instance.
void	waitForContainerToDie() Wait until container will die
void	waitForLogMessage(org.hamcrest.Matcher<String> message, java.time.Duration timeout) Waits for a log message that matches the pattern

Method Detail

start

void start()

Start the instance.

stop

void stop()

Cleanly stop the instance.

jiraNode

JiraCluster.Node jiraNode()

Returns:

the JIRA cluster node the instance is running. Use this for accessing REST endpoints, etc.

installWar

void installWar(Path warFile,
                String context)

Installs a WAR file intothis container.

Parameters:

warFile - the WAR file to install.

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

installJira

void installJira(JiraType warType)

Installs a predefined JIRA WAR into this container.

Parameters:

warType - the JIRA version to install.

getLocalHome

Path getLocalHome()

Returns:

a path to the local home directory of JIRA

getClusterProperties

ClusterNodeProperties getClusterProperties()

Returns:

The wrapped property file for this node (cluster.properties from jirahome).

waitForLogMessage

void waitForLogMessage(org.hamcrest.Matcher<String> message,
                       java.time.Duration timeout)

Waits for a log message that matches the pattern

getSystemProperties

Map<String,String> getSystemProperties()

Returns:

the system properties for the container. Can be modified.

Since:

7.3.5

generateThreadDump

void generateThreadDump()

Generate a thread dump of this process to the logs.

Since:

7.3.5

waitForContainerToDie

void waitForContainerToDie()
                    throws TimeoutException

Wait until container will die

Throws:

TimeoutException - if container will not die

Since:

8.11