|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataImportService
Performs an XML import used both during setup and xml restore. XML import is an action only system administrators can perform.
This service is responsible for performing some basic validation of the input as well as more advanced validation of the actual data provided. An import consists of the following steps:validateImport(com.atlassian.crowd.embedded.api.User, DataImportParams)
Nested Class Summary | |
---|---|
static class |
DataImportService.ImportError
Returned by the DataImportService.ImportResult from a call to doImport(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.bc.dataimport.DataImportService.ImportValidationResult, TaskProgressSink) |
static class |
DataImportService.ImportResult
Represents the result of performing an import. |
static class |
DataImportService.ImportValidationResult
An import validation result returned by the validateImport(com.atlassian.crowd.embedded.api.User,
DataImportParams) method. |
Method Summary | |
---|---|
DataImportService.ImportResult |
doImport(com.atlassian.crowd.embedded.api.User loggedInUser,
DataImportService.ImportValidationResult result,
TaskProgressSink taskProgressSink)
Performs the actual import given a valid validation result. |
DataImportService.ImportValidationResult |
validateImport(com.atlassian.crowd.embedded.api.User loggedInUser,
DataImportParams params)
Given the currently loggedInUser and import params this method does some basic validation of the input. |
Method Detail |
---|
DataImportService.ImportValidationResult validateImport(com.atlassian.crowd.embedded.api.User loggedInUser, DataImportParams params)
loggedInUser
- The currently logged in user (may be null during setup)params
- The DataImportParams
contain information provided by the user during import or setup
DataImportService.ImportResult doImport(com.atlassian.crowd.embedded.api.User loggedInUser, DataImportService.ImportValidationResult result, TaskProgressSink taskProgressSink)
loggedInUser
- The currently logged in user (may be null during setup)result
- A valid validation result containing the DataImportParams
providedtaskProgressSink
- A task progress counter that can be used to indicate how much longer the import has to go.
if no progress needs to be recorded simply provide a TaskProgressSink.NULL_SINK
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |