com.atlassian.jira.bc.dataimport

Class DataImportParams

java.lang.Object

com.atlassian.jira.bc.dataimport.DataImportParams

public final class DataImportParams
extends Object

Provides all the parameters required to perform a data import in JIRA. Specifically this includes: Required

• filename - Path of the file to be imported. Only compulsory if unsafeJiraBackup has not be specified.
• unsafeJiraBackup - Path of the file to be imported. Only compulsory if filename has not be specified. JIRA will use the file for import no matter where it is located (i.e. it does not need to be JIRA_HOME).

Optional

• licenseString - A license string to override the license from the XML data file
• quickImport - If this is set to true the plugins system will *not* be restarted. (false by default)
• useDefaultPaths - Whether default paths in JIRA home should be used for indexing & attachments (true by default)
• isSetup - true if this import is being performed during JIRA's setup (false by default)
• disableOutgoingEmail - true if outgoing email should be disabled after importing the xml data file.
• unsafeAOBackup - the path to the AO backup. JIRA will use the file for import no matter where it is located (i.e. it does not need to be JIRA_HOME).

Clients should use the provided DataImportParams.Builder to construct an instance of this class.

Since:

v4.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataImportParams.Builder

Method Summary

Methods

Modifier and Type	Method and Description
String	getFilename()
String	getLicenseString()
File	getUnsafeAOBackup()
File	getUnsafeJiraBackup()
boolean	isAllowDowngrade()
boolean	isNoLicenseCheck()
boolean	isQuickImport()
boolean	isSafeMode() Deprecated. SafeMode has been removed as there is no longer a DangerMode. To be removed in 7.0.
boolean	isSetup()
boolean	isStartupDataOnly()
boolean	isUseDefaultPaths()
boolean	outgoingMail()
boolean	shouldChangeOutgoingMail()

Methods inherited from class java.lang.Object

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

Method Detail

getFilename

public String getFilename()

getLicenseString

public String getLicenseString()

isQuickImport

public boolean isQuickImport()

isUseDefaultPaths

public boolean isUseDefaultPaths()

isAllowDowngrade

public boolean isAllowDowngrade()

isSetup

public boolean isSetup()

getUnsafeJiraBackup

public File getUnsafeJiraBackup()

getUnsafeAOBackup

public File getUnsafeAOBackup()

outgoingMail

public boolean outgoingMail()

shouldChangeOutgoingMail

public boolean shouldChangeOutgoingMail()

isSafeMode

@Deprecated
public boolean isSafeMode()

Deprecated. SafeMode has been removed as there is no longer a DangerMode. To be removed in 7.0.

This method always returns true.

Returns:

always returns true.

isNoLicenseCheck

public boolean isNoLicenseCheck()

isStartupDataOnly

public boolean isStartupDataOnly()