Package uk.ac.warwick.dcs.sherlock.engine

Class SherlockEngine

java.lang.Object

uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

public class SherlockEngine
extends java.lang.Object

Main engine class, creates a new instance of Sherlock

Field Summary

Fields

Modifier and Type	Field	Description
static java.net.URLClassLoader	classloader
static Configuration	configuration
static IExecutor	executor
static Side	side
static IStorageWrapper	storage
static java.lang.String	version

Constructor Summary

Constructors

Constructor	Description
SherlockEngine(Side side)	Initial setup

Method Summary

Modifier and Type	Method	Description
void	initialise()	Initialise Sherlock!, must be called for Sherlock to work
boolean	isInitialised()	is SherlockEngine initialised
static boolean	isModulePresent(java.lang.String classpath)	Test the presence of a module at the passed classpath, should point to a class within the module
boolean	isValidInstance()	is SherlockEngine valid
static void	setOverrideModulesPath(java.lang.String overrideModulesPath)	Set the module override location

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

side

public static Side side

configuration

public static Configuration configuration

storage

public static IStorageWrapper storage

executor

public static IExecutor executor

classloader

public static java.net.URLClassLoader classloader

Constructor Detail

SherlockEngine

public SherlockEngine(Side side)

Initial setup

Parameters:

side - Client or Server

Method Detail

isModulePresent

public static boolean isModulePresent(java.lang.String classpath)

Test the presence of a module at the passed classpath, should point to a class within the module

Parameters:

classpath - the module classpath as a string (to avoid requiring an import). Example for base Sherlock module: "uk.ac.warwick.dcs.sherlock.module.model.base.ModuleModelBase"

Returns:

Whether the module is present

setOverrideModulesPath

public static void setOverrideModulesPath(java.lang.String overrideModulesPath)

Set the module override location

Parameters:

overrideModulesPath - new path for modules

initialise

public void initialise()

Initialise Sherlock!, must be called for Sherlock to work

isInitialised

public boolean isInitialised()

is SherlockEngine initialised

Returns:

is SherlockEngine initialised

isValidInstance

public boolean isValidInstance()

is SherlockEngine valid

Returns:

is valid