rapture.common.api.EnvironmentApi 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.model.RaptureServerStatus;
import rapture.common.model.RaptureServerInfo;


@SuppressWarnings("all")
public interface EnvironmentApi {
     /**
     * Retrieves the unique identifier and name for this Rapture server instance.
     * 
     */
     RaptureServerInfo getThisServer(CallingContext context);

     /**
     * Returns a list of the unique identifiers and names for all Rapture servers in the
     * network.
     * 
     */
     List getServers(CallingContext context);

     /**
     * Sets the passed parameter as information for the current server instance.
     * 
     */
     RaptureServerInfo setThisServer(CallingContext context, RaptureServerInfo info);

     /**
     * Configures the instance into or out of appliance mode.
     * 
     */
     void setApplianceMode(CallingContext context, Boolean mode);

     /**
     * Determines whether the instance is currently in appliance mode.
     * 
     */
     Boolean getApplianceMode(CallingContext context);

     /**
     * Returns the last reported state for each server in the network. This includes a numerical
     * status, a human readable message, and a Date object indicating the time that the
     * status was last updated.
     * 
     */
     List getServerStatus(CallingContext context);

     /**
     * Get all known appNames in the Rapture cluster. An appName is unique for an application
     * and is of the format 'name(at)ip:port'
     * 
     */
     List getAppNames(CallingContext context);

     /**
     * Get the memory information, such as RAM available or heap memory used, for the app
     * names given. Passing in null or an empty list will retrieve information for all
     * known Rapture nodes in the cluster. Returns a map of app identifiers to the associated
     * information in json format.
     * 
     */
     Map getMemoryInfo(CallingContext context, List appNames);

     /**
     * Get the operating system information, such as CPUs and Average Load, for the app
     * names given. Passing in null or an empty list will retrieve information for all
     * known Rapture nodes in the cluster. Returns a map of app identifiers to the associated
     * information in json format.
     * 
     */
     Map getOperatingSystemInfo(CallingContext context, List appNames);

     /**
     * Get the threading information, such as thread names, thread counts, and thread IDs,
     * for the app names given. Passing in null or an empty list will retrieve information
     * for all known Rapture nodes in the cluster. Returns a map of app identifiers to
     * the associated information in json format.
     * 
     */
     Map getThreadInfo(CallingContext context, List appNames);

     /**
     * Performs a read operation for the user-supplied path for the app names given. Passing
     * in null or an empty list will retrieve information for all known Rapture nodes in
     * the cluster. Returns a map of app identifiers to the associated information in
     * json format.
     * 
     */
     Map readByPath(CallingContext context, List appNames, String path);

     /**
     * Performs a write operation for the user-supplied path for the app names given. Passing
     * in null or an empty list will perform the write for all known Rapture nodes in the
     * cluster. Returns a map of app identifiers to the associated information in json
     * format.
     * 
     */
     Map writeByPath(CallingContext context, List appNames, String path);

     /**
     * Performs an exec operation for the user-supplied path for the app names given. Passing
     * in null or an empty list will perform the exec for all known Rapture nodes in the
     * cluster. Returns a map of app identifiers to the associated information in json
     * format.
     * 
     */
     Map execByPath(CallingContext context, List appNames, String path);

     /**
     * Performs a read operation for the user-supplied json for the app names given. Passing
     * in null or an empty list will retrieve information for all known Rapture nodes in
     * the cluster. Returns a map of app identifiers to the associated information in
     * json format.
     * 
     */
     Map readByJson(CallingContext context, List appNames, String json);

     /**
     * Performs a write operation for the user-supplied json for the app names given. Passing
     * in null or an empty list will perform the write for all known Rapture nodes in the
     * cluster. Returns a map of app identifiers to the associated information in json
     * format.
     * 
     */
     Map writeByJson(CallingContext context, List appNames, String json);

     /**
     * Performs an exec operation for the user-supplied json for the app names given. Passing
     * in null or an empty list will perform the exec for all known Rapture nodes in the
     * cluster. Returns a map of app identifiers to the associated information in json
     * format.
     * 
     */
     Map execByJson(CallingContext context, List appNames, String json);

}