public class AdministrationImpl extends Object implements Administration
AdministrationAdministration.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()
AdministrationreIndex in interface Administrationpublic void setProfiling(boolean on)
AdministrationsetProfiling in interface Administrationon - or offpublic void restoreBlankInstance()
restoreBlankInstance in interface Administrationpublic void restoreBlankInstanceWithLicense(License license)
AdministrationrestoreBlankInstanceWithLicense in interface Administrationlicense - the license to be installedpublic void restoreNotSetupInstance()
AdministrationrestoreNotSetupInstance in interface Administrationpublic void restoreNotSetupInstance(String licenseKey)
AdministrationrestoreNotSetupInstance in interface AdministrationlicenseKey - the license key to be used for restore@Deprecated public void restoreNotSetupRenaissanceInstance(String licenseKey)
restoreNotSetupRenaissanceInstance in interface AdministrationlicenseKey - the license key to be used for restorepublic void copyFileToJiraImportDirectory(File file)
AdministrationcopyFileToJiraImportDirectory in interface Administrationfile - the file to copy to JIRA_HOME/importpublic File replaceTokensInFile(String originalXmlFileName, Map<String,String> replacements) throws IOException
AdministrationreplaceTokensInFile in interface AdministrationoriginalXmlFileName - 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
AdministrationAdministration.restoreDataWithReplacedTokens(String, java.util.Map, boolean), except with useDefaultPaths set to false.restoreDataWithReplacedTokens in interface AdministrationIOExceptionpublic void restoreDataWithReplacedTokens(String originalXmlFileName, Map<String,String> replacements, boolean useDefaultPaths) throws IOException
AdministrationDateUtil
classrestoreDataWithReplacedTokens in interface AdministrationoriginalXmlFileName - 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)
AdministrationAdministration.restoreData(String, boolean), but with useDefaultPaths set to false.restoreData in interface Administrationpublic void restoreData(String fileName, boolean useDefaultPaths)
AdministrationrestoreData in interface AdministrationfileName - 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 Administrationpublic Administration.Link link()
Administrationlink in interface Administrationpublic void restoreDataAndLogin(String fileName, String username)
AdministrationAdministration.restoreDataAndLogin(String, String, boolean) but with userDefaultPaths parameter set to false.restoreDataAndLogin in interface Administrationpublic void restoreDataAndLogin(String fileName, String username, boolean useDefaultPaths)
AdministrationrestoreDataAndLogin in interface AdministrationfileName - 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)
AdministrationAdministration.restoreDataSlowOldWayAndLogin(String, String, boolean) but with useDefaultPath set to false.restoreDataSlowOldWayAndLogin in interface Administrationpublic void restoreDataSlowOldWayAndLogin(String fileName, String username, boolean useDefaultPath)
AdministrationrestoreDataSlowOldWayAndLogin in interface AdministrationfileName - 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)
AdministrationAdministration.restoreDataSlowOldWay(String, boolean), except with useDefaultPaths set to false.restoreDataSlowOldWay in interface Administrationpublic void restoreDataSlowOldWay(String fileName, boolean useDefaultPaths)
AdministrationrestoreDataSlowOldWay in interface AdministrationfileName - 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)
AdministrationAdministration.restoreDataWithPluginsReload(String, boolean), except with useDefaultPaths set to false.restoreDataWithPluginsReload in interface Administrationpublic void restoreDataWithPluginsReload(String fileName, boolean useDefaultPaths)
AdministrationRestores 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 AdministrationfileName - 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)
AdministrationAdministration.restoreDataSlowOldWay(String, String, boolean), but with useDefaultPath set to false;restoreDataSlowOldWay in interface Administrationpublic void restoreDataSlowOldWay(String path, String fileName, boolean useDefaultPath)
AdministrationrestoreDataSlowOldWay in interface Administrationpath - 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)
AdministrationrestoreDataWithLicense in interface AdministrationfileName - 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)
AdministrationAdministration.restoreDataWithLicense(String, String, boolean), except with useDefaultPaths set to false.restoreDataWithLicense in interface Administrationpublic void restoreI18nData(String fileName)
AdministrationrestoreI18nData in interface AdministrationfileName - the fiel conatining the JIRA datapublic void restoreDataWithBuildNumber(String fileName, int expectedBuilderNumber)
AdministrationrestoreDataWithBuildNumber in interface AdministrationfileName - the path of the backup.expectedBuilderNumber - the build number the data should have.public File exportDataToFile(String fileName)
AdministrationexportDataToFile in interface AdministrationfileName - 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()
AdministrationgetCurrentAttachmentPath in interface Administrationpublic void activateSubTasks()
activateSubTasks in interface Administrationpublic void addSubTaskType(String name)
addSubTaskType in interface Administrationpublic GeneralConfiguration generalConfiguration()
AdministrationgeneralConfiguration in interface Administrationpublic Backdoor backdoor()
Administrationbackdoor in interface Administrationpublic Project project()
Administrationproject in interface Administrationpublic UsersAndGroups usersAndGroups()
AdministrationusersAndGroups in interface Administrationpublic Roles roles()
Administrationroles in interface Administrationpublic CustomFields customFields()
AdministrationcustomFields in interface Administration@Deprecated public PermissionSchemes permissionSchemes()
Backdoor.permissionSchemes()AdministrationpermissionSchemes in interface Administrationpublic IssueSecuritySchemes issueSecuritySchemes()
AdministrationissueSecuritySchemes in interface Administrationpublic FieldConfigurations fieldConfigurations()
AdministrationfieldConfigurations in interface Administrationpublic FieldConfigurationSchemes fieldConfigurationSchemes()
AdministrationfieldConfigurationSchemes in interface Administrationpublic ProjectImport projectImport()
AdministrationprojectImport in interface Administrationpublic Plugins plugins()
Administrationplugins in interface Administrationpublic void removeGlobalPermission(GlobalPermissionKey permissionKey, String group)
AdministrationremoveGlobalPermission in interface AdministrationpermissionKey - The permission to remove the group fromgroup - the group to removepublic void removeGlobalPermission(int permission,
String group)
AdministrationremoveGlobalPermission in interface Administrationpermission - The permission to remove teh group fromgroup - the group to removepublic void addGlobalPermission(GlobalPermissionKey permission, String group)
AdministrationaddGlobalPermission in interface Administrationpermission - the permission to add the group togroup - The group to addpublic void addGlobalPermission(int permission,
String group)
AdministrationaddGlobalPermission in interface Administrationpermission - the permission to add the group togroup - The group to addpublic void switchToLicense(License license)
AdministrationswitchToLicense in interface Administrationlicense - license to switch topublic void switchToLicense(String license, String description)
AdministrationswitchToLicense in interface Administrationlicense - license to switch todescription - license descriptionpublic void switchToPersonalLicense()
AdministrationswitchToPersonalLicense in interface Administrationpublic void switchToStarterLicense()
AdministrationswitchToStarterLicense in interface Administrationpublic String getJiraHomeDirectory()
AdministrationgetJiraHomeDirectory in interface Administrationpublic String getSystemTenantHomeDirectory()
AdministrationgetSystemTenantHomeDirectory in interface Administrationpublic MailServerAdministration mailServers()
AdministrationmailServers in interface Administrationpublic SharedFiltersAdministration sharedFilters()
AdministrationsharedFilters in interface Administrationpublic SharedDashboardsAdministration sharedDashboards()
sharedDashboards in interface Administrationpublic SendBulkMail sendBulkMail()
AdministrationsendBulkMail in interface Administrationpublic AdminTabs tabs()
Administrationtabs in interface Administrationpublic AdvancedApplicationProperties advancedApplicationProperties()
AdministrationadvancedApplicationProperties in interface Administrationpublic Statuses statuses()
Administrationstatuses in interface Administrationpublic Subtasks subtasks()
subtasks in interface Administrationpublic IssueLinking issueLinking()
AdministrationissueLinking in interface Administrationpublic TimeTracking timeTracking()
AdministrationtimeTracking in interface Administrationpublic Resolutions resolutions()
resolutions in interface Administrationpublic ViewServices services()
Administrationservices in interface Administrationpublic String getEdition()
AdministrationgetEdition in interface AdministrationAdministration.ENTERPRISE,
Administration.PROFESSIONAL,
Administration.STANDARDpublic long getBuildNumber()
AdministrationRuntimeException will be thrown if we can't find the build number.getBuildNumber in interface Administrationpublic void enableAccessLogging()
AdministrationenableAccessLogging in interface Administrationpublic Attachments attachments()
attachments in interface Administrationpublic ViewFieldScreens viewFieldScreens()
AdministrationviewFieldScreens in interface Administrationpublic Administration.Utilities utilities()
utilities in interface Administrationpublic ViewWorkflows workflows()
Administrationworkflows in interface AdministrationViewWorkflows instancepublic NotificationSchemes notificationSchemes()
AdministrationnotificationSchemes in interface AdministrationNotificationSchemes instancepublic void waitForRestore()
AdministrationwaitForRestore in interface AdministrationCopyright © 2002-2017 Atlassian. All Rights Reserved.