public class AdministrationImpl extends Object implements Administration
Administration
Administration.Link, Administration.OutgoingMailSettings, Administration.Utilities
Modifier and Type | Field and Description |
---|---|
static String |
LEGACY_PROJECT_PERMISSIONS_PAGE_DARK_FEATURE |
ENTERPRISE, PROFESSIONAL, STANDARD
Constructor and Description |
---|
AdministrationImpl(net.sourceforge.jwebunit.WebTester tester,
JIRAEnvironmentData environmentData,
Navigation navigation,
Assertions assertions)
Note: if you need to construct this for an old-style
JIRAWebTest , you may
want to consider using FuncTestHelperFactory instead. |
Modifier and Type | Method and Description |
---|---|
void |
activateSubTasks() |
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)
Add a group to a Global permission
Ends up on the Global Permissions page.
|
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.
all new tests with the Single Page Permission Schemes page should be written in a web
driver test using EditPermissionsSinglePage. For backdoor based PermissionSchemes control use
Backdoor.permissionSchemes() |
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 permissionKey,
String group)
Remove a group from a given Global Permission.
|
void |
removeGlobalPermission(int permission,
String group)
Remove a group from a given Global Permission.
|
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 the jira instance to one with no issues.
|
void |
restoreBlankInstanceWithLicense(License license)
Restores a JIRA to a well known blank instance with the supplied licence.
|
void |
restoreData(String fileName)
Same as
Administration.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 |
restoreData(String path,
String fileName) |
void |
restoreData(String path,
String fileName,
boolean useDefaultPath) |
void |
restoreDataAndLogin(String fileName,
String username)
same as
Administration.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
Administration.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
Administration.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
Administration.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
Administration.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
Administration.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
Administration.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 restoreNotSetupInstance
|
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
|
public static final String LEGACY_PROJECT_PERMISSIONS_PAGE_DARK_FEATURE
@Inject public AdministrationImpl(net.sourceforge.jwebunit.WebTester tester, JIRAEnvironmentData environmentData, Navigation navigation, Assertions assertions)
JIRAWebTest
, you may
want to consider using FuncTestHelperFactory
instead.tester
- the testerenvironmentData
- the environment datanavigation
- the navigationassertions
- the assertionsFuncTestHelperFactory.getAdministration()
public void reIndex()
Administration
reIndex
in interface Administration
public void setProfiling(boolean on)
Administration
setProfiling
in interface Administration
on
- or offpublic void restoreBlankInstance()
restoreBlankInstance
in interface Administration
public void restoreBlankInstanceWithLicense(License license)
Administration
restoreBlankInstanceWithLicense
in interface Administration
license
- the license to be installedpublic void restoreNotSetupInstance()
Administration
restoreNotSetupInstance
in interface Administration
public void restoreNotSetupInstance(String licenseKey)
Administration
restoreNotSetupInstance
in interface Administration
licenseKey
- the license key to be used for restore@Deprecated public void restoreNotSetupRenaissanceInstance(String licenseKey)
restoreNotSetupRenaissanceInstance
in interface Administration
licenseKey
- the license key to be used for restorepublic void copyFileToJiraImportDirectory(File file)
Administration
copyFileToJiraImportDirectory
in interface Administration
file
- the file to copy to JIRA_HOME/importpublic File replaceTokensInFile(String originalXmlFileName, Map<String,String> replacements) throws IOException
Administration
replaceTokensInFile
in interface Administration
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 filespublic void restoreDataWithReplacedTokens(String originalXmlFileName, Map<String,String> replacements) throws IOException
Administration
Administration.restoreDataWithReplacedTokens(String, java.util.Map, boolean)
, except with useDefaultPaths set to false.restoreDataWithReplacedTokens
in interface Administration
IOException
public void restoreDataWithReplacedTokens(String originalXmlFileName, Map<String,String> replacements, boolean useDefaultPaths) throws IOException
Administration
DateUtil
classrestoreDataWithReplacedTokens
in interface Administration
originalXmlFileName
- 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 filespublic void restoreData(String fileName)
Administration
Administration.restoreData(String, boolean)
, but with useDefaultPaths set to false.restoreData
in interface Administration
public void restoreData(String fileName, boolean useDefaultPaths)
Administration
restoreData
in interface Administration
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 steadpublic void restoreData(String fileName, Administration.OutgoingMailSettings outgoingMailSetting)
restoreData
in interface Administration
public Administration.Link link()
Administration
link
in interface Administration
public void restoreDataAndLogin(String fileName, String username)
Administration
Administration.restoreDataAndLogin(String, String, boolean)
but with userDefaultPaths parameter set to false.restoreDataAndLogin
in interface Administration
public void restoreDataAndLogin(String fileName, String username, boolean useDefaultPaths)
Administration
restoreDataAndLogin
in interface Administration
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 steadpublic void restoreDataSlowOldWayAndLogin(String fileName, String username)
Administration
Administration.restoreDataSlowOldWayAndLogin(String, String, boolean)
but with useDefaultPath set to false.restoreDataSlowOldWayAndLogin
in interface Administration
public void restoreDataSlowOldWayAndLogin(String fileName, String username, boolean useDefaultPath)
Administration
restoreDataSlowOldWayAndLogin
in interface Administration
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.public void restoreDataSlowOldWay(String fileName)
Administration
Administration.restoreDataSlowOldWay(String, boolean)
, except with useDefaultPaths set to false.restoreDataSlowOldWay
in interface Administration
public void restoreDataSlowOldWay(String fileName, boolean useDefaultPaths)
Administration
restoreDataSlowOldWay
in interface Administration
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.public void restoreDataWithPluginsReload(String fileName)
Administration
Administration.restoreDataWithPluginsReload(String, boolean)
, except with useDefaultPaths set to false.restoreDataWithPluginsReload
in interface Administration
public void restoreDataWithPluginsReload(String fileName, boolean useDefaultPaths)
Administration
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.
restoreDataWithPluginsReload
in interface Administration
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.public void restoreDataSlowOldWay(String path, String fileName)
Administration
Administration.restoreDataSlowOldWay(String, String, boolean)
, but with useDefaultPath set to false;restoreDataSlowOldWay
in interface Administration
public void restoreDataSlowOldWay(String path, String fileName, boolean useDefaultPath)
Administration
restoreDataSlowOldWay
in interface Administration
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 insteadpublic void restoreDataWithLicense(String fileName, String licenseKey, boolean useDefaultPaths)
Administration
restoreDataWithLicense
in interface Administration
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 insteadpublic void restoreDataWithLicense(String fileName, String licenseKey)
Administration
Administration.restoreDataWithLicense(String, String, boolean)
, except with useDefaultPaths set to false.restoreDataWithLicense
in interface Administration
public void restoreI18nData(String fileName)
Administration
restoreI18nData
in interface Administration
fileName
- the fiel conatining the JIRA datapublic void restoreDataWithBuildNumber(String fileName, int expectedBuilderNumber)
Administration
restoreDataWithBuildNumber
in interface Administration
fileName
- the path of the backup.expectedBuilderNumber
- the build number the data should have.public File exportDataToFile(String fileName)
Administration
exportDataToFile
in interface Administration
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.public String getCurrentAttachmentPath()
Administration
getCurrentAttachmentPath
in interface Administration
public void activateSubTasks()
activateSubTasks
in interface Administration
public void addSubTaskType(String name)
addSubTaskType
in interface Administration
public GeneralConfiguration generalConfiguration()
Administration
generalConfiguration
in interface Administration
public Backdoor backdoor()
Administration
backdoor
in interface Administration
public Project project()
Administration
project
in interface Administration
public UsersAndGroups usersAndGroups()
Administration
usersAndGroups
in interface Administration
public Roles roles()
Administration
roles
in interface Administration
public CustomFields customFields()
Administration
customFields
in interface Administration
@Deprecated public PermissionSchemes permissionSchemes()
Backdoor.permissionSchemes()
Administration
permissionSchemes
in interface Administration
public IssueSecuritySchemes issueSecuritySchemes()
Administration
issueSecuritySchemes
in interface Administration
public FieldConfigurations fieldConfigurations()
Administration
fieldConfigurations
in interface Administration
public FieldConfigurationSchemes fieldConfigurationSchemes()
Administration
fieldConfigurationSchemes
in interface Administration
public ProjectImport projectImport()
Administration
projectImport
in interface Administration
public Plugins plugins()
Administration
plugins
in interface Administration
public void removeGlobalPermission(GlobalPermissionKey permissionKey, String group)
Administration
removeGlobalPermission
in interface Administration
permissionKey
- The permission to remove the group fromgroup
- the group to removepublic void removeGlobalPermission(int permission, String group)
Administration
removeGlobalPermission
in interface Administration
permission
- The permission to remove teh group fromgroup
- the group to removepublic void addGlobalPermission(GlobalPermissionKey permission, String group)
Administration
addGlobalPermission
in interface Administration
permission
- the permission to add the group togroup
- The group to addpublic void addGlobalPermission(int permission, String group)
Administration
addGlobalPermission
in interface Administration
permission
- the permission to add the group togroup
- The group to addpublic void switchToLicense(License license)
Administration
switchToLicense
in interface Administration
license
- license to switch topublic void switchToLicense(String license, String description)
Administration
switchToLicense
in interface Administration
license
- license to switch todescription
- license descriptionpublic void switchToPersonalLicense()
Administration
switchToPersonalLicense
in interface Administration
public void switchToStarterLicense()
Administration
switchToStarterLicense
in interface Administration
public String getJiraHomeDirectory()
Administration
getJiraHomeDirectory
in interface Administration
public String getSystemTenantHomeDirectory()
Administration
getSystemTenantHomeDirectory
in interface Administration
public MailServerAdministration mailServers()
Administration
mailServers
in interface Administration
public SharedFiltersAdministration sharedFilters()
Administration
sharedFilters
in interface Administration
public SharedDashboardsAdministration sharedDashboards()
sharedDashboards
in interface Administration
public SendBulkMail sendBulkMail()
Administration
sendBulkMail
in interface Administration
public AdminTabs tabs()
Administration
tabs
in interface Administration
public AdvancedApplicationProperties advancedApplicationProperties()
Administration
advancedApplicationProperties
in interface Administration
public Statuses statuses()
Administration
statuses
in interface Administration
public Subtasks subtasks()
subtasks
in interface Administration
public IssueLinking issueLinking()
Administration
issueLinking
in interface Administration
public TimeTracking timeTracking()
Administration
timeTracking
in interface Administration
public Resolutions resolutions()
resolutions
in interface Administration
public ViewServices services()
Administration
services
in interface Administration
public String getEdition()
Administration
getEdition
in interface Administration
Administration.ENTERPRISE
,
Administration.PROFESSIONAL
,
Administration.STANDARD
public long getBuildNumber()
Administration
RuntimeException
will be thrown if we can't find the build number.getBuildNumber
in interface Administration
public void enableAccessLogging()
Administration
enableAccessLogging
in interface Administration
public Attachments attachments()
attachments
in interface Administration
public ViewFieldScreens viewFieldScreens()
Administration
viewFieldScreens
in interface Administration
public Administration.Utilities utilities()
utilities
in interface Administration
public ViewWorkflows workflows()
Administration
workflows
in interface Administration
ViewWorkflows
instancepublic NotificationSchemes notificationSchemes()
Administration
notificationSchemes
in interface Administration
NotificationSchemes
instancepublic void waitForRestore()
Administration
waitForRestore
in interface Administration
Copyright © 2002-2018 Atlassian. All Rights Reserved.