public interface Administration
Modifier and Type | Interface and Description |
---|---|
static interface |
Administration.Link
Represents the administration home link in the JIRA Header.
|
static class |
Administration.OutgoingMailSettings |
static interface |
Administration.Utilities
Sub interface that contains...
|
Modifier and Type | Field and Description |
---|---|
static String |
ENTERPRISE |
static String |
PROFESSIONAL
Deprecated.
since 7.0.1
|
static String |
STANDARD
Deprecated.
since 7.0.1
|
Modifier and Type | Method and Description |
---|---|
void |
activateSubTasks()
Deprecated.
use
Subtasks.enable() instead. |
void |
addGlobalPermission(GlobalPermissionKey permission,
String group)
Add a group to a Global permission
Ends up on the Global Permissions page.
|
void |
addGlobalPermission(int permission,
String group)
Deprecated.
Use
addGlobalPermission(com.atlassian.jira.permission.GlobalPermissionKey, String) instead. Since v6.2.5. |
void |
addSubTaskType(String name) |
AdvancedApplicationProperties |
advancedApplicationProperties()
Gets an instance of the AdvancedApplicationProperties Page Object.
|
Attachments |
attachments() |
Backdoor |
backdoor()
Allows you to perform backdoor actions
|
void |
copyFileToJiraImportDirectory(File file)
Copies a file to the JIRA import directory, presumably with the intention of testing imports directly.
|
CustomFields |
customFields()
Allows you to perform custom field actions.
|
void |
enableAccessLogging()
enable http access logging
|
File |
exportDataToFile(String fileName)
Exports the current running data to the specified absolute path
|
FieldConfigurations |
fieldConfigurations()
Allows you to modify field configurations.
|
FieldConfigurationSchemes |
fieldConfigurationSchemes()
Allows you to modify field configuration schemes.
|
GeneralConfiguration |
generalConfiguration()
Allows you to perform generalConfiguration actions.
|
long |
getBuildNumber()
Returns ths current build number.
|
String |
getCurrentAttachmentPath()
Obtains the current attachment path configured for JIRA.
|
String |
getEdition()
Returns the current edition name.
|
String |
getJiraHomeDirectory()
Returns the JIRA home directory as reported in the System Info section
|
String |
getSystemTenantHomeDirectory()
Get the system tenant home directory.
|
IssueLinking |
issueLinking()
TGo to issue linking administration section.
|
IssueSecuritySchemes |
issueSecuritySchemes()
Allows you to modify issue security schemes.
|
Administration.Link |
link()
Retrieves the administration home link in the JIRA Header.
|
MailServerAdministration |
mailServers()
Gets an instance of the Mail Server Administration page.
|
NotificationSchemes |
notificationSchemes()
'Notification Schemes' administration section
|
PermissionSchemes |
permissionSchemes()
Deprecated.
|
Plugins |
plugins()
Utility function to allow you some basic plugins control
|
Project |
project()
Allows you to perform project actions.
|
ProjectImport |
projectImport()
Allows you to perform project imports.
|
void |
reIndex()
Reindex JIRA, waiting for JIRA to complete the task, in the default index directory.
|
void |
removeGlobalPermission(GlobalPermissionKey permission,
String group)
Remove a group from a given Global Permission.
|
void |
removeGlobalPermission(int permission,
String group)
Deprecated.
Use
removeGlobalPermission(com.atlassian.jira.permission.GlobalPermissionKey, String) instead. Since v6.2.5. |
File |
replaceTokensInFile(String originalXmlFileName,
Map<String,String> replacements)
Reads in an XML file and performs token replacements on it, writes the data to a temp file which is the return value
|
Resolutions |
resolutions() |
void |
restoreBlankInstance()
Restores a JIRA to a well known blank instance
|
void |
restoreBlankInstanceWithLicense(License license)
Restores a JIRA to a well known blank instance with the supplied licence.
|
void |
restoreData(String fileName)
Same as
restoreData(String, boolean) , but with useDefaultPaths set to false. |
void |
restoreData(String fileName,
Administration.OutgoingMailSettings outgoingMailSetting) |
void |
restoreData(String fileName,
boolean useDefaultPaths)
Restores the specified fileName as JIRA data.
|
void |
restoreDataAndLogin(String fileName,
String username)
same as
restoreDataAndLogin(String, String, boolean) but with userDefaultPaths parameter set to false. |
void |
restoreDataAndLogin(String fileName,
String username,
boolean useDefaultPaths)
Restore the specified file and login to JIRA using the passed username.
|
void |
restoreDataSlowOldWay(String fileName)
Same as
restoreDataSlowOldWay(String, boolean) , except with useDefaultPaths set to false. |
void |
restoreDataSlowOldWay(String fileName,
boolean useDefaultPaths)
Restores the specified fileName as JIRA data NOT using the clear cache mechanism.
|
void |
restoreDataSlowOldWay(String path,
String fileName)
Same as
restoreDataSlowOldWay(String, String, boolean) , but with useDefaultPath set to false; |
void |
restoreDataSlowOldWay(String path,
String fileName,
boolean useDefaultPath)
Restores the XML file from the specified directory NOT using the clear cache mechanism.
|
void |
restoreDataSlowOldWayAndLogin(String fileName,
String username)
Same as
restoreDataSlowOldWayAndLogin(String, String, boolean) but with useDefaultPath set to false. |
void |
restoreDataSlowOldWayAndLogin(String fileName,
String username,
boolean useDefaultPath)
Restore the specified file data NOT using the clear cache mechanism and login to JIRA using the passed username.
|
void |
restoreDataWithBuildNumber(String fileName,
int expectedBuilderNumber)
Basically check the passed backup to ensure that it matches the passed build number and then restore
the data.
|
void |
restoreDataWithLicense(String fileName,
String licenseKey)
same as
restoreDataWithLicense(String, String, boolean) , except with useDefaultPaths set to false. |
void |
restoreDataWithLicense(String fileName,
String licenseKey,
boolean useDefaultPaths)
Restores the specified fileName as JIRA data, using the specified License key on import.
|
void |
restoreDataWithPluginsReload(String fileName)
Same as
restoreDataWithPluginsReload(String, boolean) , except with useDefaultPaths set to false. |
void |
restoreDataWithPluginsReload(String fileName,
boolean useDefaultPaths)
Restores the specified fileName as JIRA data NOT using the clear cache mechanism.
|
void |
restoreDataWithReplacedTokens(String originalXmlFileName,
Map<String,String> replacements)
Same as
restoreDataWithReplacedTokens(String, java.util.Map, boolean) , except with useDefaultPaths set to false. |
void |
restoreDataWithReplacedTokens(String originalXmlFileName,
Map<String,String> replacements,
boolean useDefaultPaths)
Reads in an XML file and performs token replacements on it, writes the data to a temp file, then imports that into JIRA.
|
void |
restoreI18nData(String fileName)
Restores the specified fileName as JIRA data.
|
void |
restoreNotSetupInstance()
Restores a backup file with JIRA in an not setup state.
|
void |
restoreNotSetupInstance(String licenseKey)
Restores a backup file with JIRA in an not setup state.
|
void |
restoreNotSetupRenaissanceInstance(String licenseKey)
Deprecated.
since 7.0.1. use
Administration#restoreNotSetupInstance(License) instead |
Roles |
roles()
Allows you to perform role actions
|
SendBulkMail |
sendBulkMail()
Gets an instance of the Send Bulk Mail Page.
|
ViewServices |
services()
Returns the ViewServices object which allows you to run operations on the ViewServices page.
|
void |
setProfiling(boolean on)
Set JIRA's profiling on or off.
|
SharedDashboardsAdministration |
sharedDashboards() |
SharedFiltersAdministration |
sharedFilters()
Gets an instance of the Shared Filters Administration page.
|
Statuses |
statuses()
Gets the instance of the Statuses page
|
Subtasks |
subtasks() |
void |
switchToLicense(License license)
Changes JIRA's lincense to a given license object
|
void |
switchToLicense(String license,
String description)
Changes JIRA's lincense to a given license and asserts that the description then appears on the view license
|
void |
switchToPersonalLicense()
Switches the license to a personal license.
|
void |
switchToStarterLicense()
Switches the license to a starter license.
|
AdminTabs |
tabs()
Gets an instance of the AdminTabs Page Object.
|
TimeTracking |
timeTracking()
Get time tracking administration section util.
|
UsersAndGroups |
usersAndGroups()
Allows you to perform user and group actions.
|
Administration.Utilities |
utilities() |
ViewFieldScreens |
viewFieldScreens()
Field screens config.
|
void |
waitForRestore()
Waits for the data import progress to complete.
|
ViewWorkflows |
workflows()
Manage the 'Workflows' administration page
|
static final String ENTERPRISE
@Deprecated static final String PROFESSIONAL
@Deprecated static final String STANDARD
void reIndex()
void setProfiling(boolean on)
on
- or offvoid restoreI18nData(String fileName)
fileName
- the fiel conatining the JIRA datavoid restoreDataWithBuildNumber(String fileName, int expectedBuilderNumber)
fileName
- the path of the backup.expectedBuilderNumber
- the build number the data should have.void restoreData(String fileName)
restoreData(String, boolean)
, but with useDefaultPaths set to false.void restoreData(String fileName, boolean useDefaultPaths)
fileName
- the XML file inside the standard backup file directory containing the JIRA datauseDefaultPaths
- if set to true, the xml backup's paths (e.g., index, attachment etc) will be ignored, and the
default for those used in steadvoid restoreDataAndLogin(String fileName, String username)
restoreDataAndLogin(String, String, boolean)
but with userDefaultPaths parameter set to false.void restoreDataAndLogin(String fileName, String username, boolean useDefaultPaths)
fileName
- the name of the xml file to restore.username
- the username used to login to JIRA after the restore. The username and the password are assumed to
be the same.useDefaultPaths
- if set to true, the xml backup's paths (e.g., index, attachment etc) will be ignored, and the
default for those used in steadvoid restoreDataSlowOldWayAndLogin(String fileName, String username)
restoreDataSlowOldWayAndLogin(String, String, boolean)
but with useDefaultPath set to false.void restoreDataSlowOldWayAndLogin(String fileName, String username, boolean useDefaultPath)
fileName
- the name of the xml file to restore.username
- the username used to login to JIRA after the restore. The username and the password are assumed to be
the same.useDefaultPath
- if set to true, the paths in the xml backup (e.g., index, and attachment) will be ignored, and their
default paths used instead.void restoreDataSlowOldWay(String fileName)
restoreDataSlowOldWay(String, boolean)
, except with useDefaultPaths set to false.void restoreDataSlowOldWay(String fileName, boolean useDefaultPaths)
fileName
- the XML file inside the standard backup file directory containing the JIRA datauseDefaultPaths
- if set to true, the paths in the xml backup (e.g., index, and attachment) will be ignored, and their
default paths used instead.void restoreDataWithPluginsReload(String fileName)
restoreDataWithPluginsReload(String, boolean)
, except with useDefaultPaths set to false.void restoreDataWithPluginsReload(String fileName, boolean useDefaultPaths)
Restores the specified fileName as JIRA data NOT using the clear cache mechanism. The plugins system is restarted.
This restore uses the full Pico refresh the same as in Production. ie it does not do a "Quick Import".
This is much slower than using the default methods and should only be used if there is a real reason for it.
fileName
- the XML file inside the standard backup file directory containing the JIRA datauseDefaultPaths
- if set to true, the paths in the xml backup (e.g., index, and attachment) will be ignored, and their
default paths used instead.void restoreDataSlowOldWay(String path, String fileName)
restoreDataSlowOldWay(String, String, boolean)
, but with useDefaultPath set to false;void restoreDataSlowOldWay(String path, String fileName, boolean useDefaultPath)
path
- the directory in which the XML file is locatedfileName
- the name of the XML fileuseDefaultPath
- if set to true, the paths (e.g., attachment, index) in the xml backup will be ignored, and the
default used insteadvoid restoreDataWithReplacedTokens(String originalXmlFileName, Map<String,String> replacements) throws IOException
restoreDataWithReplacedTokens(String, java.util.Map, boolean)
, except with useDefaultPaths set to false.IOException
void restoreDataWithReplacedTokens(String originalXmlFileName, Map<String,String> replacements, boolean useDefaultPaths) throws IOException
DateUtil
classoriginalXmlFileName
- the name of the XML file to read in; must be located in the standard XML file directoryreplacements
- a map of token replacementsuseDefaultPaths
- if set to true, the paths (e.g., attachment, index) in the xml backup will be ignored, and the
default used instead. If the token being replaced is part of the default paths, it is still
replaced prior to restore.IOException
- if there is a problem reading/writing the filesFile replaceTokensInFile(String originalXmlFileName, Map<String,String> replacements) throws IOException
originalXmlFileName
- the name of the XML file to read in; must be located in the standard XML file directoryreplacements
- a map of token replacementsIOException
- if there is a problem reading/writing the filesvoid restoreDataWithLicense(String fileName, String licenseKey)
restoreDataWithLicense(String, String, boolean)
, except with useDefaultPaths set to false.void restoreDataWithLicense(String fileName, String licenseKey, boolean useDefaultPaths)
fileName
- the file conatining the JIRA datalicenseKey
- the license key to be installeduseDefaultPaths
- if set to true, the paths (e.g., attachment, index) in the xml backup will be ignored, and the
default used insteadFile exportDataToFile(String fileName)
fileName
- to backup to. This should just be a filename because JIRA always appends ${JIRA.HOME}/export
to it before doing the export. Passing a directory may make it fail on windows.void restoreBlankInstance()
void restoreBlankInstanceWithLicense(License license)
license
- the license to be installedvoid restoreNotSetupInstance()
void restoreNotSetupInstance(String licenseKey)
licenseKey
- the license key to be used for restore@Deprecated void restoreNotSetupRenaissanceInstance(String licenseKey)
Administration#restoreNotSetupInstance(License)
insteadlicenseKey
- the license key to be used for restoreString getCurrentAttachmentPath()
@Deprecated void activateSubTasks()
Subtasks.enable()
instead.void addSubTaskType(String name)
void removeGlobalPermission(int permission, String group)
removeGlobalPermission(com.atlassian.jira.permission.GlobalPermissionKey, String)
instead. Since v6.2.5.permission
- The permission to remove teh group fromgroup
- the group to removevoid removeGlobalPermission(GlobalPermissionKey permission, String group)
permission
- The permission to remove the group fromgroup
- the group to removevoid addGlobalPermission(int permission, String group)
addGlobalPermission(com.atlassian.jira.permission.GlobalPermissionKey, String)
instead. Since v6.2.5.permission
- the permission to add the group togroup
- The group to addvoid addGlobalPermission(GlobalPermissionKey permission, String group)
permission
- the permission to add the group togroup
- The group to addvoid switchToLicense(License license)
license
- license to switch tovoid switchToLicense(String license, String description)
license
- license to switch todescription
- license descriptionvoid switchToPersonalLicense()
void switchToStarterLicense()
String getJiraHomeDirectory()
void copyFileToJiraImportDirectory(File file)
file
- the file to copy to JIRA_HOME/importString getEdition()
ENTERPRISE
,
PROFESSIONAL
,
STANDARD
long getBuildNumber()
RuntimeException
will be thrown if we can't find the build number.GeneralConfiguration generalConfiguration()
Backdoor backdoor()
Project project()
UsersAndGroups usersAndGroups()
Roles roles()
CustomFields customFields()
PermissionSchemes permissionSchemes()
Backdoor.permissionSchemes()
IssueSecuritySchemes issueSecuritySchemes()
FieldConfigurations fieldConfigurations()
FieldConfigurationSchemes fieldConfigurationSchemes()
ProjectImport projectImport()
Plugins plugins()
void enableAccessLogging()
Attachments attachments()
Administration.Utilities utilities()
Subtasks subtasks()
IssueLinking issueLinking()
TimeTracking timeTracking()
Resolutions resolutions()
ViewServices services()
ViewFieldScreens viewFieldScreens()
ViewWorkflows workflows()
ViewWorkflows
instanceNotificationSchemes notificationSchemes()
NotificationSchemes
instanceString getSystemTenantHomeDirectory()
MailServerAdministration mailServers()
SharedFiltersAdministration sharedFilters()
SendBulkMail sendBulkMail()
AdminTabs tabs()
AdvancedApplicationProperties advancedApplicationProperties()
Statuses statuses()
void waitForRestore()
SharedDashboardsAdministration sharedDashboards()
void restoreData(String fileName, Administration.OutgoingMailSettings outgoingMailSetting)
Administration.Link link()
Copyright © 2002-2022 Atlassian. All Rights Reserved.