com.marklogic.hub.FlowManager 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;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.marklogic.hub.flow.Flow;
import com.marklogic.hub.step.impl.Step;

import java.util.List;
import java.util.Map;

/**
 * Manages CRUD operations for flows
 */
public interface FlowManager {

    /**
     * String value for the flow file extension
     */
    String FLOW_FILE_EXTENSION = ".flow.json";

    /**
     * Returns the HubConfig set
     *
     * @return a hubConfig object
     */
    HubConfig getHubConfig();

    /**
     * Set the HubConfig
     *
     * @param hubConfig - the hubConfig to use
     */
    void setHubConfig(HubConfig hubConfig);
    /**
     * Retrieves a named flow on the MarkLogic server
     *
     * @param flowName - name of the flow
     * @return a flow object
     */
    Flow getFlow(String flowName);

    /**
     * Retrieves a named flow from the Data Hub project
     *
     * @param flowName - name of the flow
     * @return a flow object from the local Data Hub project
     */
    Flow getLocalFlow(String flowName);

    /**
     * Retrieves the expanded flow document with properties from artifact and settings
     *
     * @param flowName - name of the flow
     * @return a flow object to be used by FlowRunner
     */
    Flow getFullFlow(String flowName);

    /**
     * Returns a flow based on the provided name as JSON string
     *
     * @param flowName - name of the flow
     * @return string json representation of the flow object
     */
    String getFlowAsJSON(String flowName);

    /**
     * Retrieves a list of flows installed on the MarkLogic server
     *
     * @return - a list of all flows on the MarkLogic server
     */
    List getFlows();

    /**
     * Retrieves a list of flows in a Data Hub project
     *
     * @return - a list of all flows in a project
     */
    List getLocalFlows();

    /**
     * Retrieves a list of flows in a Data Hub project
     *
     * @return - a list of all flows in a project as JSON
     */
    List getLocalFlowsAsJSON();

    /**
     * Retrieves a list of names of flows in the local project
     *
     * @return - a list of names of all flows
     */
    List getLocalFlowNames();

    /**
     * Retrieves a list of names of flows installed on the MarkLogic server
     *
     * @return - a list of names of all flows
     */
    List getFlowNames();

    /**
     * Creates a flow
     *
     * @param flowName - name of the flow
     * @return a Flow object
     */
    Flow createFlow(String flowName);

    /**
     * Creates a flow from a given JSON string
     *
     * @param json - string representation of the flow
     * @return - a Flow object
     */
    Flow createFlowFromJSON(String json);

    /**
     * Creates a flow from a given JsonNode
     *
     * @param json - JsonNode representation of the flow
     * @return - a Flow object
     */
    Flow createFlowFromJSON(JsonNode json);

    /**
     * Deletes a flow
     *
     * @param flowName - name of the flow
     */
    void deleteFlow(String flowName);

    /**
     * Saves a flow to project structure
     *
     * @param flow - the flow object to be saved
     */
    void saveLocalFlow(Flow flow);

    /**
     * Saves a flow to project structure and MarkLogic instance
     *
     * @param flow - the flow object to be saved
     */
    void saveFlow(Flow flow);

    /**
     *
     * @param flow
     * @param stepKey the step map key corresponding to the step to delete
     */
    void deleteStep(Flow flow, String stepKey);

    /**
     * Check if a flow has existed
     * @param flowName a flow name
     * @return a boolean value
     */
    boolean isFlowExisted(String flowName);

    /**
     * Use flow.getSteps()
     *
     * @param flow a flow object
     * @return a map of steps
     */
    @Deprecated
    Map getSteps(Flow flow);

    /**
     * Use flow.setSteps(stepMap)
     *
     * @param flow a flow object
     * @param stepMap a map of steps
     */
    @Deprecated
    void setSteps(Flow flow, Map stepMap);

    /**
     * Use flow.getStep(stepNum)
     *
     * @param flow a flow object
     * @param stepNum step key
     * @return a step
     */
    @Deprecated
    Step getStep(Flow flow, String stepNum);
}