net.adamcin.oakpal.core

Class Locator

java.lang.Object

net.adamcin.oakpal.core.Locator

public final class Locator
extends Object

Unified class path locator for PackageLister classes and scripts.

Method Summary

Modifier and Type	Method and Description
static List<net.adamcin.oakpal.api.ProgressCheck>	loadFromCheckSpecs(List<CheckSpec> checkSpecs) Load a list of ProgressChecks from from a list of CheckSpecs using the default classloader.
static List<net.adamcin.oakpal.api.ProgressCheck>	loadFromCheckSpecs(List<CheckSpec> checkSpecs, ClassLoader checkLoader) Load a list of ProgressChecks from from a list of CheckSpecs using the provided classloader.
static net.adamcin.oakpal.api.ProgressCheck	loadProgressCheck(String impl) Attempt to load a ProgressCheck from the class path.
static net.adamcin.oakpal.api.ProgressCheck	loadProgressCheck(String impl, javax.json.JsonObject config) Attempt to load a ProgressCheck from a particular class loader.
static net.adamcin.oakpal.api.ProgressCheck	loadProgressCheck(String impl, javax.json.JsonObject config, ClassLoader classLoader) Attempt to load a ProgressCheck from a particular class loader.
static net.adamcin.oakpal.api.ProgressCheck	wrapWithAlias(net.adamcin.oakpal.api.ProgressCheck progressCheck, String alias) Rename the provided package check with the provided alias.

Methods inherited from class java.lang.Object

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

Method Detail

loadProgressCheck

public static net.adamcin.oakpal.api.ProgressCheck loadProgressCheck(String impl)
                                                              throws Exception

Attempt to load a ProgressCheck from the class path.

Parameters:

impl - className or resourceName

Returns:

a new ProgressCheck instance for the given name

Throws:

Exception - on any error or failure to find a resource for given name.

loadProgressCheck

public static net.adamcin.oakpal.api.ProgressCheck loadProgressCheck(String impl,
                                                                     javax.json.JsonObject config)
                                                              throws Exception

Attempt to load a ProgressCheck from a particular class loader.

Parameters:

impl - className or resourceName

config - provide an optional config object (may be ignored by the check.)

Returns:

a new ProgressCheck instance for the given name

Throws:

Exception - on any error or failure to find a resource for given name.

loadProgressCheck

public static net.adamcin.oakpal.api.ProgressCheck loadProgressCheck(String impl,
                                                                     javax.json.JsonObject config,
                                                                     ClassLoader classLoader)
                                                              throws Exception

Attempt to load a ProgressCheck from a particular class loader. The impl value is first tried as a fully-qualified class name, and if a Class<?> is found, it is first checked for the ProgressCheckFactory interface, and then for the ProgressCheck interface. If a class is not found, Locator assumes the impl value represents a resource name for an Invocable script, and attempts to create a ScriptProgressCheck from it.

Parameters:

impl - className or resourceName

config - provide an optional config object (may be ignored by the check.)

classLoader - a specific classLoader to use

Returns:

a new ProgressCheck instance for the given name

Throws:

Exception - on any error or failure to find a resource for given name.

wrapWithAlias

public static net.adamcin.oakpal.api.ProgressCheck wrapWithAlias(net.adamcin.oakpal.api.ProgressCheck progressCheck,
                                                                 String alias)

Rename the provided package check with the provided alias.

Parameters:

progressCheck - the check to rename.

alias - the name to override ProgressCheck.getCheckName().

Returns:

the renamed package check.

loadFromCheckSpecs

public static List<net.adamcin.oakpal.api.ProgressCheck> loadFromCheckSpecs(List<CheckSpec> checkSpecs)
                                                                     throws Exception

Load a list of ProgressChecks from from a list of CheckSpecs using the default classloader.

Parameters:

checkSpecs - the list of CheckSpecs

Returns:

a list of loaded ProgressChecks

Throws:

Exception - for validation errors

loadFromCheckSpecs

public static List<net.adamcin.oakpal.api.ProgressCheck> loadFromCheckSpecs(List<CheckSpec> checkSpecs,
                                                                            ClassLoader checkLoader)
                                                                     throws Exception

Load a list of ProgressChecks from from a list of CheckSpecs using the provided classloader.

Parameters:

checkSpecs - the list of CheckSpecs

checkLoader - the classloader to use

Returns:

a list of loaded ProgressChecks

Throws:

Exception - for validation errors