com.denodo.configuration.metadata.manager

Class MetadataManagerImpl

java.lang.Object

com.denodo.configuration.metadata.manager.MetadataManagerImpl

All Implemented Interfaces:

MetadataManager

public class MetadataManagerImpl
extends java.lang.Object
implements MetadataManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAR_EXTENSION
protected static java.lang.String	pluginsFolder
static java.lang.String	REGEXP

Constructor Summary

Constructors

Constructor and Description
MetadataManagerImpl()

Method Summary

Modifier and Type	Method and Description
PluginInfo	addPlugin(java.lang.String fileName, byte[] fileContents) Adds a new plugin (custom element implementation) to the plugins register and its metadata to the the meta-configuration register.
void	exportPlugins(java.lang.String folder) Writes the collection of plugins files to the given folder.
void	exportPlugins(java.lang.String folder, java.util.Collection<java.lang.String> pluginNames) Writes the collection of plugins files to the given folder.
java.util.Collection<java.lang.String>	getElementSubTypes(java.lang.String type) Obtains all the subTypes for the given element type with its meta-configuration available in the system.
java.util.Collection<java.lang.String>	getElementTypes() Obtains all the types of elements with its meta-configuration available in the system.
MetaConfiguration	getMetaConfiguration(java.lang.String type, java.lang.String subType) Obtains the MetaConfiguration for the element matching the specified type and subType.
java.util.Collection<MetaConfiguration>	getMetaConfigurations(java.lang.String type) Obtains a Collection of MetaConfiguration.
java.lang.Class<?>	getPluginClass(MetaConfiguration metaConfig) Returns the class implementing the plugin (custom element implementation).
java.lang.Class<?>	getPluginClass(java.lang.String pluginName) Returns the class implementing the the plugin (custom element implementation).
PluginInfo	getPluginDetails(java.lang.String pluginName) Obtains the plugin details(custom element implementation) of the specified identifier.
java.util.Collection<PluginInfo>	getPlugins() Obtains the collection of plugins (custom element implementations ) registered in the application.
java.util.Collection<java.lang.String>	importPlugins(java.lang.String folder, boolean replace) Loads plugins files from the given folder.
protected void	loadPluginsMetadata() Loads the meta-configuration from the plugins directory.
void	removePlugin(java.lang.String pluginName) Removes the plugin (custom element implementation) with the specified identifier and its metadata.

Methods inherited from class java.lang.Object

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

Field Detail

JAR_EXTENSION

public static final java.lang.String JAR_EXTENSION

See Also:

Constant Field Values

REGEXP

public static final java.lang.String REGEXP

See Also:

Constant Field Values

pluginsFolder

protected static java.lang.String pluginsFolder

Constructor Detail

MetadataManagerImpl

public MetadataManagerImpl()
                    throws InternalErrorException

Throws:

InternalErrorException

Method Detail

loadPluginsMetadata

protected void loadPluginsMetadata()

Loads the meta-configuration from the plugins directory.

getElementTypes

public java.util.Collection<java.lang.String> getElementTypes()
                                                       throws InternalErrorException

Description copied from interface: MetadataManager

Obtains all the types of elements with its meta-configuration available in the system.

Specified by:

getElementTypes in interface MetadataManager

Returns:

Collection of element types.

Throws:

InternalErrorException - if a severe error occurs.

getElementSubTypes

public java.util.Collection<java.lang.String> getElementSubTypes(java.lang.String type)
                                                          throws InstanceNotFoundException,
                                                                 InternalErrorException

Description copied from interface: MetadataManager

Obtains all the subTypes for the given element type with its meta-configuration available in the system.

Specified by:

getElementSubTypes in interface MetadataManager

Returns:

Collection of all the subtypes of the given element type.

Throws:

InstanceNotFoundException - if no element with the specified type could be found.

InternalErrorException - if a severe error occurs.

getMetaConfigurations

public java.util.Collection<MetaConfiguration> getMetaConfigurations(java.lang.String type)
                                                              throws InstanceNotFoundException,
                                                                     InternalErrorException

Description copied from interface: MetadataManager

Obtains a Collection of MetaConfiguration. If the element is categorized according to its type its meta-configuration is returned. If the element is categorized according to its type and subtype the meta-configuration of all its subTypes is returned.

Specified by:

getMetaConfigurations in interface MetadataManager

Returns:

Collection of MetaConfiguration

Throws:

InstanceNotFoundException - if no element with the specified type could be found.

InternalErrorException - if a severe error occurs.

getMetaConfiguration

public MetaConfiguration getMetaConfiguration(java.lang.String type,
                                              java.lang.String subType)
                                       throws InstanceNotFoundException,
                                              InternalErrorException

Description copied from interface: MetadataManager

Obtains the MetaConfiguration for the element matching the specified type and subType.

Specified by:

getMetaConfiguration in interface MetadataManager

Returns:

MetaConfiguration

Throws:

InstanceNotFoundException - if no element with the specified type and subType could be found.

InternalErrorException - if a severe error occurs.

addPlugin

public PluginInfo addPlugin(java.lang.String fileName,
                            byte[] fileContents)
                     throws DuplicateInstanceException,
                            InternalErrorException

Description copied from interface: MetadataManager

Adds a new plugin (custom element implementation) to the plugins register and its metadata to the the meta-configuration register. The plugin jar file is copied to the plugin folder of the application. The plugin manifest file should include a section started with an attribute with the name as "Name" and value "CustomElement". This section should cointain three attributes:

• "PluginType": the type of the custom element the plugin implements
• "PluginName": the unique identifier of the custom element the plugin implements, the name acts as the subtype of the element too
• "PluginClass": the implementation class name of the custom element

otherwise the plugin will not be registered.

Specified by:

addPlugin in interface MetadataManager

Parameters:

fileName - the name of the plugin jar file, that is the last name in the pathname's name sequence.

fileContents - a byte array with the plugin jar file contents.

Returns:

a PluginInfo specifying the details of the plugin added.

Throws:

DuplicateInstanceException - if a plugin with the same name already exists.

InternalErrorException - if a severe error occurs.

getPluginDetails

public PluginInfo getPluginDetails(java.lang.String pluginName)
                            throws InstanceNotFoundException,
                                   InternalErrorException

Description copied from interface: MetadataManager

Obtains the plugin details(custom element implementation) of the specified identifier.

Specified by:

getPluginDetails in interface MetadataManager

Parameters:

pluginName - the unique identifier of the custom element the plugin implements, the name acts as the subtype of the element too.

Returns:

a PluginInfo specifying the details of the plugin.

Throws:

InstanceNotFoundException - if the plugin does not exist.

InternalErrorException

getPlugins

public java.util.Collection<PluginInfo> getPlugins()
                                            throws InternalErrorException

Description copied from interface: MetadataManager

Obtains the collection of plugins (custom element implementations ) registered in the application.

Specified by:

getPlugins in interface MetadataManager

Returns:

a Collection of PluginInfo.

Throws:

InternalErrorException

removePlugin

public void removePlugin(java.lang.String pluginName)
                  throws InstanceNotFoundException,
                         InternalErrorException

Description copied from interface: MetadataManager

Removes the plugin (custom element implementation) with the specified identifier and its metadata. Also removes all the configuration elements that matches the type and subtype (the plugin name) of the plugin removed.

Specified by:

removePlugin in interface MetadataManager

Throws:

InstanceNotFoundException - if the plugin does not exist.

InternalErrorException - if a severe error occurs.

getPluginClass

public java.lang.Class<?> getPluginClass(MetaConfiguration metaConfig)
                                  throws InstanceNotFoundException,
                                         InternalErrorException

Description copied from interface: MetadataManager

Returns the class implementing the plugin (custom element implementation).

Specified by:

getPluginClass in interface MetadataManager

Returns:

the class implementing the given plugin (a custom element).

Throws:

InstanceNotFoundException - if the plugin does not exist.

InternalErrorException - if a severe error occurs.

getPluginClass

public java.lang.Class<?> getPluginClass(java.lang.String pluginName)
                                  throws InstanceNotFoundException,
                                         InternalErrorException

Description copied from interface: MetadataManager

Returns the class implementing the the plugin (custom element implementation).

Specified by:

getPluginClass in interface MetadataManager

Returns:

the class implementing the given plugin (a custom element).

Throws:

InstanceNotFoundException - if the plugin does not exist.

InternalErrorException - if a severe error occurs.

exportPlugins

public void exportPlugins(java.lang.String folder)

Description copied from interface: MetadataManager

Writes the collection of plugins files to the given folder.

Specified by:

exportPlugins in interface MetadataManager

exportPlugins

public void exportPlugins(java.lang.String folder,
                          java.util.Collection<java.lang.String> pluginNames)

Description copied from interface: MetadataManager

Writes the collection of plugins files to the given folder.

Specified by:

exportPlugins in interface MetadataManager

pluginNames - Collection with the names of the plugins that will be exported.

importPlugins

public java.util.Collection<java.lang.String> importPlugins(java.lang.String folder,
                                                            boolean replace)

Description copied from interface: MetadataManager

Loads plugins files from the given folder.

Specified by:

importPlugins in interface MetadataManager

replace - if any existing plugin in the application should be replaced, and false otherwise.

Returns:

Collection a Collection of warnings informing the plugins that were replaced (if replace is true) or the plugins that were maintained as is (if replaces is false).