fr.cnes.sitools.engine
Class SitoolsEngine

java.lang.Object
  fr.cnes.sitools.engine.SitoolsEngine

public final class SitoolsEngine
extends java.lang.Object

Like restlet engine to register Helpers (Sitools Converters ...)

Author:

jp.boignard (AKKA Technologies)

Field Summary

static java.lang.String	DESCRIPTOR Descriptor folder path
static java.lang.String	DESCRIPTOR_APPLICATION_PLUGIN Descriptor file name
static java.lang.String	DESCRIPTOR_APPLICATION_PLUGIN_PATH Descriptor Path
static java.lang.String	DESCRIPTOR_DATASET_CONVERTER Descriptor file name
static java.lang.String	DESCRIPTOR_DATASET_CONVERTER_PATH Descriptor Path
static java.lang.String	DESCRIPTOR_DATASET_FILTER Descriptor file name
static java.lang.String	DESCRIPTOR_DATASET_FILTER_PATH Descriptor Path
static java.lang.String	DESCRIPTOR_DATASET_SVA Descriptor file name
static java.lang.String	DESCRIPTOR_DATASET_SVA_PATH Descriptor Path
static java.lang.String	DESCRIPTOR_FILTER_PLUGIN Descriptor file name
static java.lang.String	DESCRIPTOR_FILTER_PLUGIN_PATH Descriptor Path
static java.lang.String	DESCRIPTOR_RESOURCE_PLUGIN Descriptor file name
static java.lang.String	DESCRIPTOR_RESOURCE_PLUGIN_PATH Descriptor Path
static java.lang.String	DESCRIPTOR_UNITS Descriptor file name
static java.lang.String	DESCRIPTOR_UNITS_PLUGIN_PATH Descriptor Path

Constructor Summary

SitoolsEngine()
Constructor that will automatically attempt to discover connectors.

SitoolsEngine(boolean discoverHelpers)
Constructor.

Method Summary

static void	clear() Clears the current Restlet Engine altogether.
java.lang.ClassLoader	getClassLoader() Returns the class loader.
java.util.List<AbstractConverter>	getDatasetConverters() Returns the list of available converters.
java.util.List<AbstractFilter>	getDatasetFilters() Gets the registeredFilters value
java.util.List<FilterModel>	getFilterPlugins() Returns the list of available FilterPlugins.
static SitoolsEngine	getInstance() Returns the registered SitoolsEngine engine.
java.util.List<AbstractApplicationPlugin>	getRegisteredApplicationPlugins() Returns the list of available ApplicationPlugins.
java.util.List<DimensionHelper>	getRegisteredDimensionHelpers() Returns the list of available Dimension Helpers.
java.util.List<ResourceModel>	getRegisteredParameterizedResources() Gets the registeredParameterizedResources value
static java.net.URL	getResource(java.lang.String name) Returns the classloader resource for a given name/path.
java.lang.ClassLoader	getUserClassLoader() Returns the class loader specified by the user and that should be used in priority.
static java.lang.Class<?>	loadClass(java.lang.String className) Returns the class object for the given name using the engine classloader.
static SitoolsEngine	register() Registers a new Restlet Engine.
static SitoolsEngine	register(boolean discoverPlugins) Registers a new Restlet Engine.
void	registerHelper(java.lang.ClassLoader classLoader, java.lang.String provider, java.util.List helpers, java.lang.Class constructorClass) Registers a helper.
void	registerHelpers(java.lang.ClassLoader classLoader, java.net.URL configUrl, java.util.List<?> helpers, java.lang.Class<?> constructorClass) Registers a helper.
void	registerHelpers(java.lang.String descriptorPath, java.util.List<?> helpers, java.lang.Class<?> constructorClass) Registers a list of helpers.
void	registerUrlFactory() Registers a factory that is used by the URL class to create the URLConnection instances when the URL.openConnection() or URL.openStream() methods are invoked.
void	setClassLoader(java.lang.ClassLoader newClassLoader) Sets the engine class loader.
void	setDatasetConverters(java.util.List<AbstractConverter> registeredConverters) Sets the list of available converter helpers.
void	setDatasetFilters(java.util.List<AbstractFilter> registeredFilters) Sets the list of available filter helpers.
static void	setInstance(SitoolsEngine engine) Deprecated. Use the register() and register(boolean) methods instead.
void	setRegisteredParameterizedResources(java.util.List<ResourceModel> registeredParameterizedResources) Sets the value of registeredParameterizedResources
void	setUserClassLoader(java.lang.ClassLoader newClassLoader) Sets the user class loader that should used in priority.

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

public static final java.lang.String DESCRIPTOR

Descriptor folder path

See Also:

Constant Field Values

DESCRIPTOR_DATASET_CONVERTER

public static final java.lang.String DESCRIPTOR_DATASET_CONVERTER

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_DATASET_FILTER

public static final java.lang.String DESCRIPTOR_DATASET_FILTER

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_DATASET_SVA

public static final java.lang.String DESCRIPTOR_DATASET_SVA

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_APPLICATION_PLUGIN

public static final java.lang.String DESCRIPTOR_APPLICATION_PLUGIN

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_FILTER_PLUGIN

public static final java.lang.String DESCRIPTOR_FILTER_PLUGIN

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_RESOURCE_PLUGIN

public static final java.lang.String DESCRIPTOR_RESOURCE_PLUGIN

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_UNITS

public static final java.lang.String DESCRIPTOR_UNITS

Descriptor file name

See Also:

Constant Field Values

DESCRIPTOR_DATASET_CONVERTER_PATH

public static final java.lang.String DESCRIPTOR_DATASET_CONVERTER_PATH

Descriptor Path

See Also:

Constant Field Values

DESCRIPTOR_DATASET_FILTER_PATH

public static final java.lang.String DESCRIPTOR_DATASET_FILTER_PATH

Descriptor Path

See Also:

Constant Field Values

DESCRIPTOR_DATASET_SVA_PATH

public static final java.lang.String DESCRIPTOR_DATASET_SVA_PATH

Descriptor Path

See Also:

Constant Field Values

DESCRIPTOR_APPLICATION_PLUGIN_PATH

public static final java.lang.String DESCRIPTOR_APPLICATION_PLUGIN_PATH

Descriptor Path

See Also:

Constant Field Values

DESCRIPTOR_FILTER_PLUGIN_PATH

public static final java.lang.String DESCRIPTOR_FILTER_PLUGIN_PATH

Descriptor Path

See Also:

Constant Field Values

DESCRIPTOR_RESOURCE_PLUGIN_PATH

public static final java.lang.String DESCRIPTOR_RESOURCE_PLUGIN_PATH

Descriptor Path

See Also:

Constant Field Values

DESCRIPTOR_UNITS_PLUGIN_PATH

public static final java.lang.String DESCRIPTOR_UNITS_PLUGIN_PATH

Descriptor Path

See Also:

Constant Field Values

Constructor Detail

SitoolsEngine

public SitoolsEngine()

Constructor that will automatically attempt to discover connectors.

SitoolsEngine

public SitoolsEngine(boolean discoverHelpers)

Constructor.

Parameters:

discoverHelpers - True if helpers should be automatically discovered.

Method Detail

clear

public static void clear()

Clears the current Restlet Engine altogether.

getInstance

public static SitoolsEngine getInstance()

Returns the registered SitoolsEngine engine.

Returns:

The registered SitoolsEngine engine.

getResource

public static java.net.URL getResource(java.lang.String name)

Returns the classloader resource for a given name/path.

Parameters:

name - The name/path to lookup.

Returns:

The resource URL.

loadClass

public static java.lang.Class<?> loadClass(java.lang.String className)
                                    throws java.lang.ClassNotFoundException

Returns the class object for the given name using the engine classloader.

Parameters:

className - The class name to lookup.

Returns:

The class object or null if the class was not found.

Throws:

java.lang.ClassNotFoundException - if class is not found

See Also:

getClassLoader()

register

public static SitoolsEngine register()

Registers a new Restlet Engine.

Returns:

The registered engine.

register

public static SitoolsEngine register(boolean discoverPlugins)

Registers a new Restlet Engine.

Parameters:

discoverPlugins - True if plug-ins should be automatically discovered.

Returns:

The registered engine.

setInstance

@Deprecated
public static void setInstance(SitoolsEngine engine)

Deprecated. Use the register() and register(boolean) methods instead.

Sets the registered Restlet engine.

Parameters:

engine - The registered Restlet engine.

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns the class loader. It uses the delegation model with the Engine class's class loader as a parent. If this parent doesn't find a class or resource, it then tries the user class loader (via getUserClassLoader() and finally the Thread.getContextClassLoader().

Returns:

The engine class loader.

See Also:

EngineClassLoader

getDatasetConverters

public java.util.List<AbstractConverter> getDatasetConverters()

Returns the list of available converters.

Returns:

The list of available converters.

getDatasetFilters

public java.util.List<AbstractFilter> getDatasetFilters()

Gets the registeredFilters value

Returns:

the registeredFilters

getRegisteredApplicationPlugins

public java.util.List<AbstractApplicationPlugin> getRegisteredApplicationPlugins()

Returns the list of available ApplicationPlugins.

Returns:

The list of available applicationPlugins.

getFilterPlugins

public java.util.List<FilterModel> getFilterPlugins()

Returns the list of available FilterPlugins.

Returns:

The list of available filterPlugins.

getRegisteredDimensionHelpers

public java.util.List<DimensionHelper> getRegisteredDimensionHelpers()

Returns the list of available Dimension Helpers.

Returns:

The list of available Dimension Helpers.

getUserClassLoader

public java.lang.ClassLoader getUserClassLoader()

Returns the class loader specified by the user and that should be used in priority.

Returns:

The user class loader

registerHelper

public void registerHelper(java.lang.ClassLoader classLoader,
                           java.lang.String provider,
                           java.util.List helpers,
                           java.lang.Class constructorClass)

Registers a helper.

Parameters:

classLoader - The classloader to use.

provider - Bynary name of the helper's class.

helpers - The list of helpers to update.

constructorClass - The constructor parameter class to look for.

registerHelpers

public void registerHelpers(java.lang.ClassLoader classLoader,
                            java.net.URL configUrl,
                            java.util.List<?> helpers,
                            java.lang.Class<?> constructorClass)

Registers a helper.

Parameters:

classLoader - The classloader to use.

configUrl - Configuration URL to parse

helpers - The list of helpers to update.

constructorClass - The constructor parameter class to look for.

registerHelpers

public void registerHelpers(java.lang.String descriptorPath,
                            java.util.List<?> helpers,
                            java.lang.Class<?> constructorClass)
                     throws java.io.IOException

Registers a list of helpers.

Parameters:

descriptorPath - Classpath to the descriptor file.

helpers - The list of helpers to update.

constructorClass - The constructor parameter class to look for.

Throws:

java.io.IOException - if occurs.

registerUrlFactory

public void registerUrlFactory()

Registers a factory that is used by the URL class to create the URLConnection instances when the URL.openConnection() or URL.openStream() methods are invoked.

The implementation is based on the client dispatcher of the current context, as provided by Context.getCurrent() method.

setClassLoader

public void setClassLoader(java.lang.ClassLoader newClassLoader)

Sets the engine class loader.

Parameters:

newClassLoader - The new user class loader to use.

setDatasetConverters

public void setDatasetConverters(java.util.List<AbstractConverter> registeredConverters)

Sets the list of available converter helpers.

Parameters:

registeredConverters - The list of available converter helpers.

setDatasetFilters

public void setDatasetFilters(java.util.List<AbstractFilter> registeredFilters)

Sets the list of available filter helpers.

Parameters:

registeredFilters - The list of available filter helpers.

setUserClassLoader

public void setUserClassLoader(java.lang.ClassLoader newClassLoader)

Sets the user class loader that should used in priority.

Parameters:

newClassLoader - The new user class loader to use.

setRegisteredParameterizedResources

public void setRegisteredParameterizedResources(java.util.List<ResourceModel> registeredParameterizedResources)

Sets the value of registeredParameterizedResources

Parameters:

registeredParameterizedResources - the registeredParameterizedResources to set

getRegisteredParameterizedResources

public java.util.List<ResourceModel> getRegisteredParameterizedResources()

Gets the registeredParameterizedResources value

Returns:

the registeredParameterizedResources