com.revo.deployr.client.broker.task.BackgroundTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jRBroker Show documentation
DeployR RBroker Framework - Rapid R Analytics Integration.
There is a newer version: 7.4.8
/*
 * BackgroundTask.java
 *
 * Copyright (C) 2010-2014 by Revolution Analytics Inc.
 *
 * This program is licensed to you under the terms of Version 2.0 of the
 * Apache License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0) for more details.
 *
 */
package com.revo.deployr.client.broker.task;

import com.revo.deployr.client.broker.options.BackgroundTaskOptions;

import java.net.URL;

/**
 * Represents a Background {@link com.revo.deployr.client.broker.RTask}
 * for execution on an
 * {@link com.revo.deployr.client.broker.RBroker}.
 */
public class BackgroundTask extends AbstractTask {

    /*
     * Name and description properties describe the
     * background task.
     */
    public final String name;
    public final String description;

    /*
     * Code property represents a block of executable R code.
     */
    public final String code;

    /*
     * Filename, directory, author and optional version
     * properties represent a repository-managed executable R script.
     */
    public final String filename;
    public final String author;
    public final String directory;
    public final String version;

    /*
     * Exteral property represents a URL/path to an external script
     * or chain of scripts.
     */
    public String external;

    /*
     * Options customize the pre-execution, on-execution
     * and post-execution handling of the task on DeployR.
     *
     * Must not be declared final as BackgroundTaskBroker
     * may need to adjust BackgroundTaskOptions.priority.
     */
    public BackgroundTaskOptions options;

    public BackgroundTask(String name,
                          String description,
                          String code,
                          BackgroundTaskOptions options) {

        this.name = name;
        this.description = description;
        this.code = code;
        this.filename = null;
        this.directory = null;
        this.author = null;
        this.version = null;
        this.external = null;
        this.options = options;
    }

    public BackgroundTask(String name,
                          String description,
                          URL externalURL,
                          BackgroundTaskOptions options) {

        this.name = name;
        this.description = description;
        this.code = null;
        this.filename = null;
        this.directory = null;
        this.author = null;
        this.version = null;
        this.external = externalURL.toString();
        this.options = options;
    }

    public BackgroundTask(String name,
                          String description,
                          String filename,
                          String directory,
                          String author,
                          String version,
                          BackgroundTaskOptions options) {

        this.name = name;
        this.description = description;
        this.code = null;
        this.filename = filename;
        this.directory = directory;
        this.author = author;
        this.version = version;
        this.external = external;
        this.options = options;
    }

    public String toString() {

        if (code != null) {
            return "BackgroundTask: [ " + name + " , " +
                    description + " , " +
                    code + " ]";
        } else if (external != null) {
            return "BackgroundTask: [ " + name + " , " +
                    description + " , " +
                    external + " ]";
        } else {
            return "BackgroundTask: [ " + name + " , " +
                    description + " , " +
                    filename + " , " +
                    directory + " , " +
                    author + " , " +
                    version + " ]";
        }
    }


}