Interface BatchCreator


  • @Role
    public interface BatchCreator
    API for creating a batch.
    Since:
    1.31.1
    Version:
    $Id$
    • Method Detail

      • createBatch

        Map<String,​List<String>> createBatch​(String batchName,
                                                   List<String> sources,
                                                   String inputProperties,
                                                   String outputProperties,
                                                   Map<String,​String> extraParams)
                                            throws com.fasterxml.jackson.core.JsonProcessingException,
                                                   com.xpn.xwiki.XWikiException
        Creates the batch and all its migrations.
        Parameters:
        batchName - The name of the batch.
        sources - The sources of the migration packages.
        inputProperties - The input properties of the migration.
        outputProperties - The output properties of the migration.
        extraParams - A map containing extra parameters for custom implementations that may require additional data.
        Returns:
        A map containing logs of the creation process.
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - If an error occurs during JSON processing.
        com.xpn.xwiki.XWikiException - If an XWiki-related error occurs.