com.scaleoutsoftware.soss.client

Class InvocationGrid

java.lang.Object

com.scaleoutsoftware.soss.client.pmi.KeyedObject

com.scaleoutsoftware.soss.client.InvocationGrid

All Implemented Interfaces:

java.io.Serializable

public final class InvocationGrid
extends com.scaleoutsoftware.soss.client.pmi.KeyedObject

This is a handle object for the available invocation grid. It is used to identify the invocation grid to be used for invocations when calling NamedCache.setInvocationGrid(InvocationGrid). It also provides a way to unload the IG by calling unload()

See Also:

Serialized Form

Field Summary

Fields inherited from class com.scaleoutsoftware.soss.client.pmi.KeyedObject

key

Method Summary

Modifier and Type	Method and Description
boolean	getAllowClientCaching() Returns whether client caching is allowed on workers.
boolean	getAllowFastReads() Returns whether "fast object reads" feature is supported.
int	getClientCacheSize() Returns the size of the client cache maintained by workers.
java.util.Map<java.lang.Integer,java.lang.Integer>	getCoherencyIntervalPerAppId()
java.util.List<Dependency>	getDependencies() Gets the invocation grid dependencies.
java.lang.String	getGridName() Gets the invocation grid name.
int	getId() Gets the IG id.
java.lang.String	getLibraryPath() Gets the name of the Hadoop distribution for hServer.
TimeSpan	getLingerTime() Gets the linger time for the invocation grid.
static java.util.Collection<InvocationGrid>	getLoadedInvocationGrids() Returns all invocation grids loaded by this client.
boolean	getLockOnRead() If true, the objects are locked before they are read and passed to the Invokable.eval(Object, java.io.Serializable, EvalArgs) method.
int	getMaxNumberOfCores() Gets the maximum number of cores across the IG.
boolean	getNewClassLoader() Get the "use new class loader" property.
int	getNumberOfThreads() Gets the number of threads in the invocation workers which handle evals and merges.
java.util.List<com.scaleoutsoftware.soss.client.pmi.GridAction>	getStartupActions() Returns the startup objects associated with this InvocationGrid
static InvocationGrid	loadFromConfigurationFile(java.lang.String invocationGridName) Loads a predeclared invocation grid from the configuration file.
static InvocationGrid	loadFromConfigurationFile(java.lang.String invocationGridName, boolean forceReload) Loads a predeclared invocation grid from the configuration file.
static void	stopInvocationGrid(java.lang.String invocationGridName)
void	unload() Unloads the invocation grid from the StateServer store and stops all invocation workers.
static void	unloadAll() Unloads all invocation grids loaded by this client.

Methods inherited from class java.lang.Object

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

Method Detail

getClientCacheSize

public int getClientCacheSize()

Returns the size of the client cache maintained by workers.

Returns:

size of the client cache in kilobytes

getAllowClientCaching

public boolean getAllowClientCaching()

Returns whether client caching is allowed on workers.

Returns:

true if client caching is allowed

getAllowFastReads

public boolean getAllowFastReads()

Returns whether "fast object reads" feature is supported.

Returns:

true if "fast reads" are allowed.

getGridName

public java.lang.String getGridName()

Gets the invocation grid name.

Returns:

IG name

getLingerTime

public TimeSpan getLingerTime()

Gets the linger time for the invocation grid.

Returns:

idle timeout

getDependencies

public java.util.List<Dependency> getDependencies()

Gets the invocation grid dependencies.

Returns:

list of all dependencies

getStartupActions

public java.util.List<com.scaleoutsoftware.soss.client.pmi.GridAction> getStartupActions()

Returns the startup objects associated with this InvocationGrid

Returns:

the startup objects associated with this InvocationGrid

getNumberOfThreads

public int getNumberOfThreads()

Gets the number of threads in the invocation workers which handle evals and merges. If the number of threads is not set, IG will fall back to the reasonable default based on the number of cores.

Returns:

number of threads in the invocation worker

getLockOnRead

public boolean getLockOnRead()

If true, the objects are locked before they are read and passed to the Invokable.eval(Object, java.io.Serializable, EvalArgs) method.

Returns:

true if the objects should be locked before evaluation

getNewClassLoader

public boolean getNewClassLoader()

Get the "use new class loader" property.

Returns:

true if the new class loader should be used by IG worker

getMaxNumberOfCores

public int getMaxNumberOfCores()

Gets the maximum number of cores across the IG.

Returns:

maximum number of cores

unload

public void unload()
            throws NamedCacheException

Unloads the invocation grid from the StateServer store and stops all invocation workers.

Throws:

NamedCacheException - if there was error while unloading the invocation grid.

getCoherencyIntervalPerAppId

public java.util.Map<java.lang.Integer,java.lang.Integer> getCoherencyIntervalPerAppId()

getId

public int getId()

Gets the IG id.

Returns:

invocation grid id

getLibraryPath

public java.lang.String getLibraryPath()

Gets the name of the Hadoop distribution for hServer.

Returns:

name of the folder in hslib to be added to classpath.

getLoadedInvocationGrids

public static java.util.Collection<InvocationGrid> getLoadedInvocationGrids()

Returns all invocation grids loaded by this client.

Returns:

a Set of all loaded invocation grids

stopInvocationGrid

public static void stopInvocationGrid(java.lang.String invocationGridName)
                               throws NamedCacheException

Throws:

NamedCacheException

unloadAll

public static void unloadAll()
                      throws NamedCacheException

Unloads all invocation grids loaded by this client. This method does not affect invocation grids loaded by other clients.

Throws:

NamedCacheException - thrown if the NamedCache has experienced an internal error.

loadFromConfigurationFile

public static InvocationGrid loadFromConfigurationFile(java.lang.String invocationGridName)
                                                throws NamedCacheException

Loads a predeclared invocation grid from the configuration file.

Invocation grids can be declared in the configuration file soss-java-ig-config.xml which should be put in the classpath root. The invocation grids are declared in the following format:

 
 <?xml version="1.0" encoding="UTF-8" ?>
 <invocationGrids>

      <invocationGrid name="FirstGrid" >
          <dependencies>
              <dependency type="class">x.y.z.MyInvokable</dependency>
          </dependencies>
      </invocationGrid>

      <invocationGrid name="SecondGrid" lingerTime="100">
          <dependencies>
              <dependency type="class">a.b.c.SomeInvokable</dependency>
              <dependency type="jar">myjar.jar</dependency>
          </dependencies>
      </invocationGrid>

 </invocationGrids>
 
 

Parameters:

invocationGridName - name of the invocation grid

Returns:

InvocationGrid object.

Throws:

NamedCacheException - if invocation grid cannot be loaded

loadFromConfigurationFile

public static InvocationGrid loadFromConfigurationFile(java.lang.String invocationGridName,
                                                       boolean forceReload)
                                                throws NamedCacheException

Loads a predeclared invocation grid from the configuration file.

Parameters:

invocationGridName - name of the invocation grid

forceReload - this parameter controls the behaviour in case invocation grid is already loaded. If true, the method will not connect to existing invocation grid, instead it will reload it from scratch.

Returns:

InvocationGrid object.

Throws:

NamedCacheException - if invocation grid cannot be loaded