com.marklogic.hub.step.StepRunner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-data-hub Show documentation
Library for Creating an Operational Data Hub on MarkLogic
There is a newer version: 6.1.1
/*
 * Copyright (c) 2021 MarkLogic Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.marklogic.hub.step;

import com.marklogic.hub.flow.Flow;

import java.util.Collection;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

/**
 * Executes a step with options
 */
public interface StepRunner {

    /**
     * Sets the flow to be used with the step runner
     * @param flow the flow object to be used
     * @return the step runner object
     */
    StepRunner withFlow(Flow flow);

    /**
     * Sets the batch size for the step runner
     * @param batchSize - the size of the batch in integer form
     * @return the step runner object
     */
    StepRunner withBatchSize(int batchSize);

    /**
     * Sets the batch size for the step runner
     * @param step - the step to be run in the flow
     * @return the step runner object
     */

    StepRunner withStep(String step) ;

    /**
     * Sets the batch size for the step runner
     * @param jobId - the id of the job
     * @return the step runner object
     */

    StepRunner withJobId(String jobId) ;

    /**
     * Sets the thread count for the flowrunner
     * @param threadCount - the number of threads for the step runner to use
     * @return the step runner object
     */
    StepRunner withThreadCount(int threadCount);

    /**
     * Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
     * @param options - the object map of options as string/object pair
     * @return the step runner object
     */
    StepRunner withRuntimeOptions(Map options);


    /**
     * Sets the config to be used in orchestrating the step.
     * @param stepConfig - the object map of configurations for the step to execute as string/object pair
     * @return the step runner object
     */
    StepRunner withStepConfig(Map stepConfig);

    /**
     * Sets if this will stop the job on a failure, or if it will continue on
     * @param stopOnFailure - true to stop the job if a failure happens
     * @return the step runner object
     */
    StepRunner withStopOnFailure(boolean stopOnFailure);

    /**
     * Sets a listener on each item completing
     * @param listener the listen object to set
     * @return the step runner object
     */
    StepRunner onItemComplete(StepItemCompleteListener listener);

    /**
     * Sets the failure listener for each item in the flow
     * @param listener the listener for the failures in the flow
     * @return the step runner object
     */
    StepRunner onItemFailed(StepItemFailureListener listener);

    /**
     * Sets the status change listener on the flowrunner object
     * @param listener - the listener for when the status changes
     * @return the step runner object
     */
    StepRunner onStatusChanged(StepStatusListener listener);

    /**
     * Blocks until the step execution is complete.
     */
    void awaitCompletion();

    /**
     * Blocks until the step execution is complete.
     *
     * @param timeout the maximum time to wait
     * @param unit the time unit of the timeout argument
     *
     * @throws InterruptedException if interrupted while waiting
     * @throws TimeoutException if times out
     */
    void awaitCompletion(long timeout, TimeUnit unit) throws InterruptedException, TimeoutException;

    /**
     * Runs the flow and creates the job
     * @return RunStepResponse object for the flow that is run
     */
    RunStepResponse run();

    /**
     * Runs the flow and creates the job. This bypasses the collector
     *
     * @param uris the ids to pass to the harmonization flow
     *
     * @return RunStepResponse object for the flow that is run
     */
    RunStepResponse run(Collection uris);

    /**
     * Stops the step run
     *
     */
     void stop();

    /**
     * Returns the batch size
     * @return batch size for step runner
     */
     int getBatchSize();

}