biolockj.api

Class BioLockJ_API

java.lang.Object

biolockj.api.BioLockJ_API

public class BioLockJ_API
extends Object

Method Summary

Modifier and Type	Method and Description
static Boolean	isValidProp(String prop, String val, List<String> modules) Returns true if the
static List<String>	listApiModules() Like listModules, but only include modules that implement the ApiModule interface.
static List<String>	listModuleProps(String mod)
static List<String>	listModules()
static List<String>	listModules(String prefix) Return a list of all the modules on the class path.
static List<String>	listMounts(String config)
static List<String>	listProps()
static List<String>	listUploads(String config)
static void	main(String[] args)
static org.json.JSONArray	moduleInfo() Returns a json formatted list of all modules and for each module that implements the gui interface, it lists the props used by the module, and for each prop the info.
static String	propDescModule(String prop, String module)
static org.json.JSONArray	propInfo() For each of the properties registered to the Properties class, report the property name, type, description and default value.
static String	propTypeModule(String prop, String module) Returns a string describing the format type that required for the value of the property given.
static String	propValue(String property)
static String	propValue(String property, BioModule module)
static String	propValue(String property, String config, BioModule module) Returns the value for that property (first String) If a second argument is given, it is assumed to be the primary config file.
static void	setVerbose(boolean writeLots)

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

setVerbose

public static void setVerbose(boolean writeLots)

listModules

public static List<String> listModules(String prefix)
                                throws Exception

Return a list of all the modules on the class path.

Parameters:

prefix - - Single argument passed to the constructor of the Reflections class.

Returns:

Throws:

Exception

listModules

public static List<String> listModules()
                                throws Exception

Throws:

Exception

listApiModules

public static List<String> listApiModules()
                                   throws Exception

Like listModules, but only include modules that implement the ApiModule interface.

Parameters:

args -

Returns:

Throws:

Exception

listProps

public static List<String> listProps()
                              throws API_Exception

Throws:

API_Exception

listModuleProps

public static List<String> listModuleProps(String mod)
                                    throws Exception

Throws:

Exception

isValidProp

public static Boolean isValidProp(String prop,
                                  String val,
                                  List<String> modules)
                           throws Exception

Returns true if the

Parameters:

prop - - a config property

val - - a proposed value for prop

modules - - if not empty, the property/val pair is validated by one or more modules, in addition to the biolockj backbone.

Returns:

Throws:

Exception

propTypeModule

public static String propTypeModule(String prop,
                                    String module)
                             throws API_Exception

Returns a string describing the format type that required for the value of the property given. The first String in args is taken as the property of interest. The second string is a module the property type is queried for that module rather than the BioLockJ backbone.

Parameters:

args - -

Returns:

Throws:

API_Exception

propDescModule

public static String propDescModule(String prop,
                                    String module)
                             throws API_Exception

Throws:

API_Exception

propValue

public static String propValue(String property,
                               String config,
                               BioModule module)
                        throws Exception

Returns the value for that property (first String) If a second argument is given, it is assumed to be the primary config file.

Parameters:

property - - the property to get the value of

config - - (can be null) the config file to read in to establish property values

module - - (can be null) a module to pass in a context when getting the value

Returns:

Throws:

Exception

propValue

public static String propValue(String property,
                               BioModule module)
                        throws Exception

Throws:

Exception

propValue

public static String propValue(String property)
                        throws Exception

Throws:

Exception

propInfo

public static org.json.JSONArray propInfo()
                                   throws Exception

For each of the properties registered to the Properties class, report the property name, type, description and default value.

Returns:

Throws:

Exception

moduleInfo

public static org.json.JSONArray moduleInfo()
                                     throws Exception

Returns a json formatted list of all modules and for each module that implements the gui interface, it lists the props used by the module, and for each prop the info.

Parameters:

args -

Returns:

Throws:

Exception

listMounts

public static List<String> listMounts(String config)
                               throws Exception

Throws:

Exception

listUploads

public static List<String> listUploads(String config)
                                throws Exception

Throws:

Exception