com.scaleout.client

Class InvocationGridManager

java.lang.Object

com.scaleout.client.InvocationGridManager

public class InvocationGridManager
extends java.lang.Object

The InvocationGridManager is used to manage invocation grids. This class allows API access for deploying invocation grids, starting pre-deployed InvocationGrids, and stopping running invocation grids.

Constructor Summary

Constructors

Constructor and Description
InvocationGridManager()

Method Summary

Modifier and Type	Method and Description
static void	deployInvocationGridThroughZip(GridConnection connection, java.lang.String igName, java.lang.String executableName, java.io.File zipFile, java.lang.String javaEntryPoint) Deploys a packaged invocation grid.
static void	deployInvocationGridThroughZip(GridConnection connection, java.lang.String igName, java.lang.String executableName, java.io.File zipFile, java.lang.String javaEntryPoint, byte[] startupParam) Deploys a packaged invocation grid.
static void	deployInvocationGridThroughZip(GridConnection connection, java.lang.String igName, java.lang.String executableName, java.io.File zipFile, java.lang.String javaEntryPoint, java.lang.String javaFlags, byte[] startupParam) Deploys a packaged invocation grid.
static void	shutdownInvocationGrid(GridConnection connection, long igId) Shutdown a running invocation grid.
static void	shutdownInvocationGrid(GridConnection connection, java.lang.String name) Shutdown a running invocation grid.
static void	startPreInstalledInvocationGrid(GridConnection connection, java.lang.String igName, java.lang.String executableName, java.lang.String workingDirectory, java.lang.String javaEntryPoint) Start a pre-installed invocation grid.
static void	startPreInstalledInvocationGrid(GridConnection connection, java.lang.String igName, java.lang.String executableName, java.lang.String workingDirectory, java.lang.String javaEntryPoint, byte[] startupParam) Start a pre-installed invocation grid.
static void	startPreInstalledInvocationGrid(GridConnection connection, java.lang.String igName, java.lang.String executableName, java.lang.String workingDirectory, java.lang.String javaEntryPoint, java.lang.String javaFlags, byte[] startupParam) Start a pre-installed invocation grid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvocationGridManager

public InvocationGridManager()

Method Detail

startPreInstalledInvocationGrid

public static void startPreInstalledInvocationGrid(GridConnection connection,
                                                   java.lang.String igName,
                                                   java.lang.String executableName,
                                                   java.lang.String workingDirectory,
                                                   java.lang.String javaEntryPoint)
                                            throws InvocationGridException

Start a pre-installed invocation grid. This call assumes the invocation grid entry point is compiled and available with all required dependencies to execute at the supplied working directory.

Parameters:

connection - the GridConnection

igName - the invocation grid name.

executableName - the executable name, typically, "java.exe" for Windows, and "java" for Linux.

workingDirectory - the working directory.

javaEntryPoint - the java entry point.

Throws:

InvocationGridException - if the invocation grid fails to start.

startPreInstalledInvocationGrid

public static void startPreInstalledInvocationGrid(GridConnection connection,
                                                   java.lang.String igName,
                                                   java.lang.String executableName,
                                                   java.lang.String workingDirectory,
                                                   java.lang.String javaEntryPoint,
                                                   byte[] startupParam)
                                            throws InvocationGridException

Start a pre-installed invocation grid. This call assumes the invocation grid entry point is compiled and available with all required dependencies to execute at the supplied working directory.

Parameters:

connection - the GridConnection

igName - the invocation grid name.

executableName - the executable name, typically, "java.exe" for Windows, and "java" for Linux.

workingDirectory - the working directory.

javaEntryPoint - the java entry point.

startupParam - a startup param if the IG requires extra runtime information.

Throws:

InvocationGridException - if the invocation grid fails to start.

startPreInstalledInvocationGrid

public static void startPreInstalledInvocationGrid(GridConnection connection,
                                                   java.lang.String igName,
                                                   java.lang.String executableName,
                                                   java.lang.String workingDirectory,
                                                   java.lang.String javaEntryPoint,
                                                   java.lang.String javaFlags,
                                                   byte[] startupParam)
                                            throws InvocationGridException

Start a pre-installed invocation grid. This call assumes the invocation grid entry point is compiled and available with all required dependencies to execute at the supplied working directory.

Parameters:

connection - the GridConnection

igName - the invocation grid name.

executableName - the executable name, typically, "java.exe" for Windows, and "java" for Linux.

workingDirectory - the working directory.

javaEntryPoint - the java entry point.

javaFlags - the java flags to use for the JVM.

startupParam - a startup param if the IG requires extra runtime information.

Throws:

InvocationGridException - if the invocation grid fails to start.

deployInvocationGridThroughZip

public static void deployInvocationGridThroughZip(GridConnection connection,
                                                  java.lang.String igName,
                                                  java.lang.String executableName,
                                                  java.io.File zipFile,
                                                  java.lang.String javaEntryPoint)
                                           throws InvocationGridException

Deploys a packaged invocation grid. The invocation grid is a zip archive containing the invocation grid entry point and any other required dependencies. The binaries must be in the root of the archive.

Parameters:

connection - the GridConnection

igName - the invocation grid name.

executableName - the executable name, typically, "java.exe" for Windows, and "java" for Linux.

zipFile - the zip file.

javaEntryPoint - the java entry point.

Throws:

InvocationGridException - if the invocation grid fails to start.

deployInvocationGridThroughZip

public static void deployInvocationGridThroughZip(GridConnection connection,
                                                  java.lang.String igName,
                                                  java.lang.String executableName,
                                                  java.io.File zipFile,
                                                  java.lang.String javaEntryPoint,
                                                  byte[] startupParam)
                                           throws InvocationGridException

Deploys a packaged invocation grid. The invocation grid is a zip archive containing the invocation grid entry point and any other required dependencies. The binaries must be in the root of the archive.

Parameters:

connection - the GridConnection

igName - the invocation grid name.

executableName - the executable name, typically, "java.exe" for Windows, and "java" for Linux.

zipFile - the zip file.

javaEntryPoint - the java entry point.

startupParam - a startup param if the IG requires extra runtime information.

Throws:

InvocationGridException - if the invocation grid fails to start.

deployInvocationGridThroughZip

public static void deployInvocationGridThroughZip(GridConnection connection,
                                                  java.lang.String igName,
                                                  java.lang.String executableName,
                                                  java.io.File zipFile,
                                                  java.lang.String javaEntryPoint,
                                                  java.lang.String javaFlags,
                                                  byte[] startupParam)
                                           throws InvocationGridException

Deploys a packaged invocation grid. The invocation grid is a zip archive containing the invocation grid entry point and any other required dependencies. The binaries must be in the root of the archive.

Parameters:

connection - the GridConnection

igName - the invocation grid name.

executableName - the executable name, typically, "java.exe" for Windows, and "java" for Linux.

zipFile - the zip file.

javaEntryPoint - the java entry point.

javaFlags - the java flags.

startupParam - a startup param if the IG requires extra runtime information.

Throws:

InvocationGridException - if the invocation grid fails to start.

shutdownInvocationGrid

public static void shutdownInvocationGrid(GridConnection connection,
                                          java.lang.String name)
                                   throws InvocationGridException

Shutdown a running invocation grid.

Parameters:

connection - the GridConnection

name - the invocation grid name.

Throws:

InvocationGridException - if the invocation grid fails to stop.

shutdownInvocationGrid

public static void shutdownInvocationGrid(GridConnection connection,
                                          long igId)
                                   throws InvocationGridException

Shutdown a running invocation grid.

Parameters:

connection - the GridConnection

igId - the invocation grid id.

Throws:

InvocationGridException - if the invocation grid fails to stop.