rapture.common.api.ScriptRunnerApi 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.CallingContext;
import rapture.common.exception.RaptureException;
import java.util.List;
import java.util.Map;
import rapture.common.RaptureLibraryDefinition;
import rapture.common.RaptureRunnerConfig;
import rapture.common.RaptureRunnerStatus;
import rapture.common.RaptureApplicationDefinition;
import rapture.common.RaptureServerGroup;
import rapture.common.RaptureInstanceCapabilities;
import rapture.common.model.RaptureApplicationStatus;
import rapture.common.RaptureApplicationInstance;
import rapture.common.model.RaptureApplicationStatusStep;


@SuppressWarnings("all")
public interface ScriptRunnerApi {
     /**
     * 
     * 
     */
     RaptureServerGroup createServerGroup(String name, String description);

     /**
     * 
     * 
     */
     void deleteServerGroup(String name);

     /**
     * 
     * 
     */
     List getAllServerGroups();

     /**
     * 
     * 
     */
     List getAllApplicationDefinitions();

     /**
     * 
     * 
     */
     List getAllLibraryDefinitions();

     /**
     * 
     * 
     */
     List getAllApplicationInstances();

     /**
     * 
     * 
     */
     RaptureServerGroup getServerGroup(String name);

     /**
     * 
     * 
     */
     RaptureServerGroup addGroupInclusion(String name, String inclusion);

     /**
     * 
     * 
     */
     RaptureServerGroup removeGroupInclusion(String name, String inclusion);

     /**
     * 
     * 
     */
     RaptureServerGroup addGroupExclusion(String name, String exclusion);

     /**
     * 
     * 
     */
     RaptureServerGroup removeGroupExclusion(String name, String exclusion);

     /**
     * 
     * 
     */
     RaptureServerGroup removeGroupEntry(String name, String entry);

     /**
     * 
     * 
     */
     RaptureApplicationDefinition createApplicationDefinition(String name, String ver, String description);

     /**
     * 
     * 
     */
     void deleteApplicationDefinition(String name);

     /**
     * 
     * 
     */
     RaptureApplicationDefinition updateApplicationVersion(String name, String ver);

     /**
     * 
     * 
     */
     RaptureLibraryDefinition createLibraryDefinition(String name, String ver, String description);

     /**
     * 
     * 
     */
     void deleteLibraryDefinition(String name);

     /**
     * 
     * 
     */
     RaptureLibraryDefinition getLibraryDefinition(String name);

     /**
     * 
     * 
     */
     RaptureLibraryDefinition updateLibraryVersion(String name, String ver);

     /**
     * 
     * 
     */
     RaptureServerGroup addLibraryToGroup(String serverGroup, String libraryName);

     /**
     * 
     * 
     */
     RaptureServerGroup removeLibraryFromGroup(String serverGroup, String libraryName);

     /**
     * 
     * 
     */
     RaptureApplicationInstance createApplicationInstance(String name, String description, String serverGroup, String appName, String timeRange, int retryCount, String parameters, String apiUser);

     /**
     * 
     * 
     */
     RaptureApplicationStatus runApplication(String appName, String queueName, Map parameterInput, Map parameterOutput);

     /**
     * 
     * 
     */
     RaptureApplicationStatus runCustomApplication(String appName, String queueName, Map parameterInput, Map parameterOutput, String customApplicationPath);

     /**
     * 
     * 
     */
     RaptureApplicationStatus getApplicationStatus(String applicationStatusURI);

     /**
     * 
     * 
     */
     List getApplicationStatuses(String date);

     /**
     * 
     * 
     */
     List getApplicationStatusDates();

     /**
     * 
     * 
     */
     void archiveApplicationStatuses();

     /**
     * 
     * 
     */
     RaptureApplicationStatus changeApplicationStatus(String applicationStatusURI, RaptureApplicationStatusStep statusCode, String message);

     /**
     * 
     * 
     */
     void recordStatusMessages(String applicationStatusURI, List messages);

     /**
     * 
     * 
     */
     RaptureApplicationStatus terminateApplication(String applicationStatusURI, String reasonMessage);

     /**
     * 
     * 
     */
     void deleteApplicationInstance(String name, String serverGroup);

     /**
     * 
     * 
     */
     RaptureApplicationInstance getApplicationInstance(String name, String serverGroup);

     /**
     * 
     * 
     */
     void updateStatus(String name, String serverGroup, String myServer, String status, Boolean finished);

     /**
     * 
     * 
     */
     List getApplicationsForServerGroup(String serverGroup);

     /**
     * 
     * 
     */
     List getApplicationsForServer(String serverName);

     /**
     * 
     * 
     */
     RaptureApplicationDefinition getApplicationDefinition(String name);

     /**
     * 
     * 
     */
     void setRunnerConfig(String name, String value);

     /**
     * 
     * 
     */
     void deleteRunnerConfig(String name);

     /**
     * 
     * 
     */
     RaptureRunnerConfig getRunnerConfig();

     /**
     * 
     * 
     */
     void recordRunnerStatus(String serverName, String serverGroup, String appInstance, String appName, String status);

     /**
     * 
     * 
     */
     void recordInstanceCapabilities(String serverName, String instanceName, Map capabilities);

     /**
     * 
     * 
     */
     Map getCapabilities(String serverName, List instanceNames);

     /**
     * 
     * 
     */
     List getRunnerServers();

     /**
     * 
     * 
     */
     RaptureRunnerStatus getRunnerStatus(String serverName);

     /**
     * 
     * 
     */
     void cleanRunnerStatus(int ageInMinutes);

     /**
     * 
     * 
     */
     void markForRestart(String serverName, String name);

}