rapture.common.api.AsyncApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.dp.WorkOrderStatus;


@SuppressWarnings("all")
public interface AsyncApi {
     /**
     * Run a passed script in an asynchronous manner. Tells Rapture to run the script as
     * part of a predefined internal workflow, and returns workOrderURI that can be used
     * in other calls to retrieve the status. The second parameter is the set of parameters
     * that will be passed to the script upon execution.
     * 
     */
     String asyncReflexScript(CallingContext context, String reflexScript, Map parameters);

     /**
     * Run a script that has already been loaded onto Rapture in an asynchronous manner.
     * The script is named through its uri. As with asyncReflexScript, the parameters passed
     * in the last parameter to this function are passed to the script upon invocation,
     * and the return value from this function is a workOrderURI that can be used to determine
     * the ultimate status of this WorkOrder.
     * 
     */
     String asyncReflexReference(CallingContext context, String scriptURI, Map parameters);

     /**
     * Retrieve the status of a given async task. Will return null if the task id is not
     * known to the environment.
     * 
     */
     WorkOrderStatus asyncStatus(CallingContext context, String taskId);

     /**
     * Sets up workflows needed to run any of these scripts. Should be called by Rapture
     * internally on init
     * 
     */
     void setupDefaultWorkflows(CallingContext context, Boolean force);

}