com.github.cafdataprocessing.utilities.initialization

Class WorkflowInitializer

java.lang.Object

com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer

public class WorkflowInitializer
extends Object

Responsible for creation of a data processing workflow using defined base data.

Constructor Summary

Constructors

Constructor and Description
WorkflowInitializer(String processingApiUrl, BoilerplateNameResolver boilerplateNameResolver, ActionTypeNameResolver actionTypeNameResolver, ClassificationWorkflowNameResolver classificationWorkflowNameResolver) Create instance of WorkflowInitializer with provided parameters.

Method Summary

Modifier and Type	Method and Description
long	createWorkflow(WorkflowJson workflow, WorkflowJson workflowOverlay, String projectId) Creates a processing workflow derived from the information in the workflow object.
long	createWorkflow(WorkflowJson workflow, WorkflowJson workflowOverlay, String projectId, boolean overwriteExisting) Creates a processing workflow derived from the information in the workflow object.
static WorkflowInitializer	createWorkflowInitializer(String processingApiUrl, String boilerplateApiUrl, String classificationApiUrl)
static WorkflowInitializer	createWorkflowOnlyInitializer(String processingApiUrl)
long	initializeWorkflowBaseData(InputStream workflowBaseDataStream, InputStream workflowOverlayStream, String projectId) Creates a processing workflow derived from the information in the input file provided.
long	initializeWorkflowBaseData(String inputFileName, String projectId) Creates a processing workflow derived from the information in the input file provided.
long	initializeWorkflowBaseData(String inputFileName, String overlayFile, String projectId) Creates a processing workflow derived from the information in the input file provided.
long	initializeWorkflowBaseData(WorkflowInitializationParams initializationParams) Creates a processing workflow derived from the information in the initializationParams object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowInitializer

public WorkflowInitializer(String processingApiUrl,
                           BoilerplateNameResolver boilerplateNameResolver,
                           ActionTypeNameResolver actionTypeNameResolver,
                           ClassificationWorkflowNameResolver classificationWorkflowNameResolver)

Create instance of WorkflowInitializer with provided parameters.

Parameters:

processingApiUrl - URL of processing API to contact during initialization.

boilerplateNameResolver - for use in resolving expression/tag names to IDs in workflow.

actionTypeNameResolver - for use in resolving action type names to IDs in workflow.

classificationWorkflowNameResolver - for use in resolving classification workflow names to IDs in processing workflow.

Method Detail

createWorkflowInitializer

public static WorkflowInitializer createWorkflowInitializer(String processingApiUrl,
                                                            String boilerplateApiUrl,
                                                            String classificationApiUrl)

createWorkflowOnlyInitializer

public static WorkflowInitializer createWorkflowOnlyInitializer(String processingApiUrl)

initializeWorkflowBaseData

public long initializeWorkflowBaseData(String inputFileName,
                                       String projectId)
                                throws IOException,
                                       com.github.cafdataprocessing.processing.service.client.ApiException

Creates a processing workflow derived from the information in the input file provided.

Parameters:

inputFileName - File containing workflow in JSON format that should be created.

projectId - ProjectId to create workflow under.

Returns:

ID of created workflow.

Throws:

IOException - If unable to read the workflow input file.

com.github.cafdataprocessing.processing.service.client.ApiException - Thrown if there is an error communicating with the API or if error response received from API.

initializeWorkflowBaseData

public long initializeWorkflowBaseData(String inputFileName,
                                       String overlayFile,
                                       String projectId)
                                throws IOException,
                                       com.github.cafdataprocessing.processing.service.client.ApiException

Creates a processing workflow derived from the information in the input file provided.

Parameters:

inputFileName - File containing workflow in JSON format that should be created.

overlayFile - Optional file containing extensions / overrides to merge with the base workflow specified in inputFileName. Pass null if you do not want any overrides to be applied.

projectId - ProjectId to create workflow under.

Returns:

ID of created workflow.

Throws:

IOException - If unable to read the workflow input file.

com.github.cafdataprocessing.processing.service.client.ApiException - Thrown if there is an error communicating with the API or if error response received from API.

initializeWorkflowBaseData

public long initializeWorkflowBaseData(InputStream workflowBaseDataStream,
                                       InputStream workflowOverlayStream,
                                       String projectId)
                                throws IOException,
                                       com.github.cafdataprocessing.processing.service.client.ApiException

Creates a processing workflow derived from the information in the input file provided.

Parameters:

workflowBaseDataStream - Input stream containing workflow in JSON format that should be created.

workflowOverlayStream - Optional input stream containing extensions / overrides to merge with the base workflow specified in inputFileName. Pass null if you do not want any overrides to be applied.

projectId - ProjectId to create workflow under.

Returns:

ID of created workflow.

Throws:

IOException - If unable to read the workflow input file.

com.github.cafdataprocessing.processing.service.client.ApiException - Thrown if there is an error communicating with the API or if error response received from API.

initializeWorkflowBaseData

public long initializeWorkflowBaseData(WorkflowInitializationParams initializationParams)
                                throws IOException,
                                       com.github.cafdataprocessing.processing.service.client.ApiException

Creates a processing workflow derived from the information in the initializationParams object. Optional extensions or overrides can be provided in the workflowOverlay parameter of the initializationParams parameter. See WorkflowCombiner for more information on merging of two WorkflowJson objects.

Parameters:

initializationParams - Defines properties to use in workflow creation.

Returns:

Newly created workflow id.

Throws:

IOException - If unable to read the workflow.

com.github.cafdataprocessing.processing.service.client.ApiException - in case of a failure to create a workflow.

createWorkflow

public long createWorkflow(WorkflowJson workflow,
                           WorkflowJson workflowOverlay,
                           String projectId)
                    throws com.github.cafdataprocessing.processing.service.client.ApiException

Creates a processing workflow derived from the information in the workflow object. Optional extensions or overrides can be provided in the workflowOverlay parameter. See WorkflowCombiner for more information on merging of two WorkflowJson objects. This will remove any existing workflows with the same workflow name as the definition from the workflow parameter for the specified projectId.

Parameters:

workflow - An object describing workflow to be created.

workflowOverlay - An optional object describing extensions or overrides to the workflow parameter.

projectId - A project id to create workflow under.

Returns:

Newly created workflow id.

Throws:

com.github.cafdataprocessing.processing.service.client.ApiException - in case of a failure to create a workflow.

createWorkflow

public long createWorkflow(WorkflowJson workflow,
                           WorkflowJson workflowOverlay,
                           String projectId,
                           boolean overwriteExisting)
                    throws com.github.cafdataprocessing.processing.service.client.ApiException

Creates a processing workflow derived from the information in the workflow object. Optional extensions or overrides can be provided in the workflowOverlay parameter. See WorkflowCombiner for more information on merging of two WorkflowJson objects.

Parameters:

workflow - An object describing workflow to be created.

workflowOverlay - An optional object describing extensions or overrides to the workflow parameter.

projectId - A project id to create workflow under.

overwriteExisting - Whether existing workflows under this projectId with the same name as the provided workflow should be removed.

Returns:

Newly created workflow id.

Throws:

com.github.cafdataprocessing.processing.service.client.ApiException - in case of a failure to create a workflow.