org.bimserver.plugins

Class PluginManager

java.lang.Object

org.bimserver.plugins.PluginManager

All Implemented Interfaces:

PluginManagerInterface

public class PluginManager
extends Object
implements PluginManagerInterface

Constructor Summary

Constructors

Constructor and Description
PluginManager(Path tempDir, Path pluginsDir, MavenPluginRepository mavenPluginRepository, String baseClassPath, ServiceFactory serviceFactory, NotificationsManagerInterface notificationsManagerInterface, SServicesMap servicesMap)

Method Summary

Modifier and Type	Method and Description
void	disablePlugin(String name)
void	enablePlugin(String name) Load all plugins that can be found in the current classloader, if you downloaded a BIMserver client library and added certain plugins to the classpath, this method should be able to find and load them
SPluginBundle	extractPluginBundleFromJar(Path jarFilePath)
SPluginBundleVersion	extractPluginBundleVersionFromJar(Path jarFilePath, boolean isLocal)
Map<PluginContext,DeserializerPlugin>	getAllDeserializerPlugins(boolean onlyEnabled)
Collection<DeserializerPlugin>	getAllDeserializerPlugins(String extension, boolean onlyEnabled)
Map<PluginContext,MessagingSerializerPlugin>	getAllMessagingSerializerPlugins(boolean onlyEnabled)
Map<PluginContext,MessagingStreamingSerializerPlugin>	getAllMessagingStreamingSerializerPlugins(boolean onlyEnabled)
Map<PluginContext,ModelCheckerPlugin>	getAllModelCheckerPlugins(boolean onlyEnabled)
Map<PluginContext,ModelComparePlugin>	getAllModelComparePlugins(boolean onlyEnabled)
Map<PluginContext,ModelMergerPlugin>	getAllModelMergerPlugins(boolean onlyEnabled)
Map<PluginContext,ObjectIDMPlugin>	getAllObjectIDMPlugins(boolean onlyEnabled)
Map<PluginContext,Plugin>	getAllPlugins(boolean onlyEnabled)
Map<PluginContext,QueryEnginePlugin>	getAllQueryEnginePlugins(boolean onlyEnabled)
Map<PluginContext,RenderEnginePlugin>	getAllRenderEnginePlugins(boolean onlyEnabled)
Map<PluginContext,SerializerPlugin>	getAllSerializerPlugins(boolean onlyEnabled)
Map<PluginContext,ServicePlugin>	getAllServicePlugins(boolean onlyEnabled)
Map<PluginContext,StillImageRenderPlugin>	getAllStillImageRenderPlugins(boolean onlyEnabled)
Map<PluginContext,StreamingDeserializerPlugin>	getAllStreamingDeserializerPlugins(boolean onlyEnabled)
Map<PluginContext,StreamingSerializerPlugin>	getAllStreamingSeserializerPlugins(boolean onlyEnabled)
Map<PluginContext,WebModulePlugin>	getAllWebPlugins(boolean onlyEnabled)
String	getCompleteClassPath()
ObjectIDM	getDefaultObjectIDM()
DeserializerPlugin	getDeserializerPlugin(String pluginClassName, boolean onlyEnabled)
DeserializerPlugin	getFirstDeserializer(String extension, Schema schema, boolean onlyEnabled)
BimServerClientInterface	getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
MessagingSerializerPlugin	getMessagingSerializerPlugin(String className, boolean onlyEnabled)
MessagingStreamingSerializerPlugin	getMessagingStreamingSerializerPlugin(String className, boolean onlyEnabled)
MetaDataManager	getMetaDataManager()
ModelCheckerPlugin	getModelCheckerPlugin(String className, boolean onlyEnabled)
ModelComparePlugin	getModelComparePlugin(String className, boolean onlyEnabled)
ModelMergerPlugin	getModelMergerPlugin(String className, boolean onlyEnabled)
ObjectIDMPlugin	getObjectIDMByName(String className, boolean onlyEnabled)
FileSystem	getOrCreateFileSystem(URI uri)
Parameter	getParameter(PluginContext pluginContext, String name)
Plugin	getPlugin(String identifier, boolean onlyEnabled)
PluginBundle	getPluginBundle(PluginBundleIdentifier pluginIdentifier)
Collection<PluginBundle>	getPluginBundles()
PluginContext	getPluginContext(Plugin plugin)
PluginDescriptor	getPluginDescriptor(byte[] bytes)
PluginDescriptor	getPluginDescriptor(InputStream inputStream)
List<SPluginInformation>	getPluginInformationFromJar(InputStream jarInputStream)
List<SPluginInformation>	getPluginInformationFromJar(Path file)
List<SPluginInformation>	getPluginInformationFromPluginFile(InputStream inputStream)
List<SPluginInformation>	getPluginInformationFromPluginFile(Path file)
SPluginType	getPluginTypeFromClass(String className)
QueryEnginePlugin	getQueryEngine(String className, boolean onlyEnabled)
RenderEnginePlugin	getRenderEnginePlugin(String className, boolean onlyEnabled)
SerializerPlugin	getSerializerPlugin(String pluginClassName)
SerializerPlugin	getSerializerPlugin(String className, boolean onlyEnabled)
ServiceFactory	getServiceFactory()
ServicePlugin	getServicePlugin(String className, boolean onlyEnabled)
SServicesMap	getServicesMap()
StreamingDeserializerPlugin	getStreamingDeserializerPlugin(String pluginClassName, boolean onlyEnabled)
StreamingSerializerPlugin	getStreamingSerializerPlugin(String pluginClassName, boolean onlyEnabled)
Path	getTempDir()
WebModulePlugin	getWebModulePlugin(String className, boolean onlyEnabled)
void	initAllLoadedPlugins() This method will initialize all the loaded plugins
PluginBundle	install(MavenPluginBundle mavenPluginBundle, boolean strictDependencyChecking)
PluginBundle	install(MavenPluginBundle mavenPluginBundle, List<SPluginInformation> plugins, boolean strictDependencyChecking)
boolean	isEnabled(String className)
void	loadAllPluginsFromEclipseWorkspace(Path file, boolean showExceptions)
void	loadAllPluginsFromEclipseWorkspaces(Path directory, boolean showExceptions)
PluginBundle	loadFromPluginDir(PluginBundleVersionIdentifier pluginBundleVersionIdentifier, SPluginBundleVersion pluginBundleVersion, List<SPluginInformation> plugins, boolean strictDependencyChecking)
PluginBundle	loadJavaProject(Path projectRoot, Path pomFile, Path pluginFolder, PluginDescriptor pluginDescriptor)
PluginContext	loadPlugin(PluginBundle pluginBundle, Class<? extends Plugin> interfaceClass, URI location, String classLocation, Plugin plugin, ClassLoader classLoader, PluginSourceType pluginType, AbstractPlugin pluginImplementation, Set<Dependency> dependencies, String identifier)
PluginBundle	loadPlugin(PluginBundleVersionIdentifier pluginBundleVersionIdentifier, Path target, SPluginBundle sPluginBundle, SPluginBundleVersion pluginBundleVersion, List<SPluginInformation> plugins, ClassLoader parentClassLoader)
PluginBundle	loadPluginsFromEclipseProject(Path projectRoot)
void	loadPluginsFromEclipseProjectNoExceptions(Path projectRoot)
PluginBundle	loadPluginsFromJar(PluginBundleVersionIdentifier pluginBundleVersionIdentifier, Path file, SPluginBundle sPluginBundle, SPluginBundleVersion pluginBundleVersion, ClassLoader parentClassLoader)
void	notifyPluginStateChange(PluginContext pluginContext, boolean enabled)
void	registerNewExtendedDataOnProjectHandler(long uoid, ServiceDescriptor serviceDescriptor, NewExtendedDataOnProjectHandler newExtendedDataHandler)
void	registerNewExtendedDataOnRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor, NewExtendedDataOnRevisionHandler newExtendedDataHandler)
void	registerNewRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor, NewRevisionHandler newRevisionHandler)
DeserializerPlugin	requireDeserializer(String extension)
void	setBimServerClientFactory(BimServerClientFactory bimServerClientFactory)
void	setMetaDataManager(MetaDataManager metaDataManager)
void	setPluginChangeListener(PluginChangeListener pluginChangeListener)
void	uninstall(PluginBundleVersionIdentifier pluginBundleVersionIdentifier)
void	unregisterNewRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor)
PluginBundle	update(PluginBundleVersionIdentifier pluginBundleVersionIdentifier, SPluginBundle sPluginBundle, SPluginBundleVersion pluginBundleVersion, Path jarFile, Path pomFile, List<SPluginInformation> plugins)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager

public PluginManager(Path tempDir,
                     Path pluginsDir,
                     MavenPluginRepository mavenPluginRepository,
                     String baseClassPath,
                     ServiceFactory serviceFactory,
                     NotificationsManagerInterface notificationsManagerInterface,
                     SServicesMap servicesMap)

Method Detail

loadPluginsFromEclipseProjectNoExceptions

public void loadPluginsFromEclipseProjectNoExceptions(Path projectRoot)

loadJavaProject

public PluginBundle loadJavaProject(Path projectRoot,
                                    Path pomFile,
                                    Path pluginFolder,
                                    PluginDescriptor pluginDescriptor)
                             throws PluginException,
                                    FileNotFoundException,
                                    IOException,
                                    org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

PluginException

FileNotFoundException

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

loadPluginsFromEclipseProject

public PluginBundle loadPluginsFromEclipseProject(Path projectRoot)
                                           throws PluginException

Specified by:

loadPluginsFromEclipseProject in interface PluginManagerInterface

Throws:

PluginException

getPluginDescriptor

public PluginDescriptor getPluginDescriptor(InputStream inputStream)
                                     throws JAXBException,
                                            IOException

Throws:

JAXBException

IOException

getPluginDescriptor

public PluginDescriptor getPluginDescriptor(byte[] bytes)
                                     throws JAXBException,
                                            IOException

Throws:

JAXBException

IOException

extractPluginBundleFromJar

public SPluginBundle extractPluginBundleFromJar(Path jarFilePath)
                                         throws PluginException

Throws:

PluginException

extractPluginBundleVersionFromJar

public SPluginBundleVersion extractPluginBundleVersionFromJar(Path jarFilePath,
                                                              boolean isLocal)
                                                       throws PluginException

Throws:

PluginException

loadPluginsFromJar

public PluginBundle loadPluginsFromJar(PluginBundleVersionIdentifier pluginBundleVersionIdentifier,
                                       Path file,
                                       SPluginBundle sPluginBundle,
                                       SPluginBundleVersion pluginBundleVersion,
                                       ClassLoader parentClassLoader)
                                throws PluginException

Throws:

PluginException

getAllObjectIDMPlugins

public Map<PluginContext,ObjectIDMPlugin> getAllObjectIDMPlugins(boolean onlyEnabled)

getAllRenderEnginePlugins

public Map<PluginContext,RenderEnginePlugin> getAllRenderEnginePlugins(boolean onlyEnabled)

getAllStillImageRenderPlugins

public Map<PluginContext,StillImageRenderPlugin> getAllStillImageRenderPlugins(boolean onlyEnabled)

getAllQueryEnginePlugins

public Map<PluginContext,QueryEnginePlugin> getAllQueryEnginePlugins(boolean onlyEnabled)

getAllSerializerPlugins

public Map<PluginContext,SerializerPlugin> getAllSerializerPlugins(boolean onlyEnabled)

getAllMessagingSerializerPlugins

public Map<PluginContext,MessagingSerializerPlugin> getAllMessagingSerializerPlugins(boolean onlyEnabled)

getAllMessagingStreamingSerializerPlugins

public Map<PluginContext,MessagingStreamingSerializerPlugin> getAllMessagingStreamingSerializerPlugins(boolean onlyEnabled)

getAllDeserializerPlugins

public Map<PluginContext,DeserializerPlugin> getAllDeserializerPlugins(boolean onlyEnabled)

getAllStreamingDeserializerPlugins

public Map<PluginContext,StreamingDeserializerPlugin> getAllStreamingDeserializerPlugins(boolean onlyEnabled)

getAllStreamingSeserializerPlugins

public Map<PluginContext,StreamingSerializerPlugin> getAllStreamingSeserializerPlugins(boolean onlyEnabled)

getAllPlugins

public Map<PluginContext,Plugin> getAllPlugins(boolean onlyEnabled)

getPluginContext

public PluginContext getPluginContext(Plugin plugin)

Specified by:

getPluginContext in interface PluginManagerInterface

enablePlugin

public void enablePlugin(String name)

Load all plugins that can be found in the current classloader, if you downloaded a BIMserver client library and added certain plugins to the classpath, this method should be able to find and load them

disablePlugin

public void disablePlugin(String name)

getPlugin

public Plugin getPlugin(String identifier,
                        boolean onlyEnabled)

Specified by:

getPlugin in interface PluginManagerInterface

isEnabled

public boolean isEnabled(String className)

setPluginChangeListener

public void setPluginChangeListener(PluginChangeListener pluginChangeListener)

getAllDeserializerPlugins

public Collection<DeserializerPlugin> getAllDeserializerPlugins(String extension,
                                                                boolean onlyEnabled)

requireDeserializer

public DeserializerPlugin requireDeserializer(String extension)
                                       throws DeserializeException

Specified by:

requireDeserializer in interface PluginManagerInterface

Throws:

DeserializeException

getTempDir

public Path getTempDir()

Specified by:

getTempDir in interface PluginManagerInterface

loadPlugin

public PluginContext loadPlugin(PluginBundle pluginBundle,
                                Class<? extends Plugin> interfaceClass,
                                URI location,
                                String classLocation,
                                Plugin plugin,
                                ClassLoader classLoader,
                                PluginSourceType pluginType,
                                AbstractPlugin pluginImplementation,
                                Set<Dependency> dependencies,
                                String identifier)
                         throws PluginException

Throws:

PluginException

initAllLoadedPlugins

public void initAllLoadedPlugins()
                          throws PluginException

This method will initialize all the loaded plugins

Throws:

PluginException

getCompleteClassPath

public String getCompleteClassPath()

Specified by:

getCompleteClassPath in interface PluginManagerInterface

getFirstDeserializer

public DeserializerPlugin getFirstDeserializer(String extension,
                                               Schema schema,
                                               boolean onlyEnabled)
                                        throws PluginException

Specified by:

getFirstDeserializer in interface PluginManagerInterface

Throws:

PluginException

getObjectIDMByName

public ObjectIDMPlugin getObjectIDMByName(String className,
                                          boolean onlyEnabled)

getRenderEnginePlugin

public RenderEnginePlugin getRenderEnginePlugin(String className,
                                                boolean onlyEnabled)

Specified by:

getRenderEnginePlugin in interface PluginManagerInterface

getQueryEngine

public QueryEnginePlugin getQueryEngine(String className,
                                        boolean onlyEnabled)

loadAllPluginsFromEclipseWorkspace

public void loadAllPluginsFromEclipseWorkspace(Path file,
                                               boolean showExceptions)
                                        throws PluginException,
                                               IOException

Throws:

PluginException

IOException

loadAllPluginsFromEclipseWorkspaces

public void loadAllPluginsFromEclipseWorkspaces(Path directory,
                                                boolean showExceptions)
                                         throws PluginException,
                                                IOException

Throws:

PluginException

IOException

getAllModelMergerPlugins

public Map<PluginContext,ModelMergerPlugin> getAllModelMergerPlugins(boolean onlyEnabled)

getAllModelComparePlugins

public Map<PluginContext,ModelComparePlugin> getAllModelComparePlugins(boolean onlyEnabled)

getModelMergerPlugin

public ModelMergerPlugin getModelMergerPlugin(String className,
                                              boolean onlyEnabled)

getModelComparePlugin

public ModelComparePlugin getModelComparePlugin(String className,
                                                boolean onlyEnabled)

getAllServicePlugins

public Map<PluginContext,ServicePlugin> getAllServicePlugins(boolean onlyEnabled)

getServicePlugin

public ServicePlugin getServicePlugin(String className,
                                      boolean onlyEnabled)

getServiceFactory

public ServiceFactory getServiceFactory()

Specified by:

getServiceFactory in interface PluginManagerInterface

registerNewRevisionHandler

public void registerNewRevisionHandler(long uoid,
                                       ServiceDescriptor serviceDescriptor,
                                       NewRevisionHandler newRevisionHandler)

Specified by:

registerNewRevisionHandler in interface PluginManagerInterface

unregisterNewRevisionHandler

public void unregisterNewRevisionHandler(long uoid,
                                         ServiceDescriptor serviceDescriptor)

Specified by:

unregisterNewRevisionHandler in interface PluginManagerInterface

getServicesMap

public SServicesMap getServicesMap()

getParameter

public Parameter getParameter(PluginContext pluginContext,
                              String name)

Specified by:

getParameter in interface PluginManagerInterface

getSerializerPlugin

public SerializerPlugin getSerializerPlugin(String className,
                                            boolean onlyEnabled)

getMessagingSerializerPlugin

public MessagingSerializerPlugin getMessagingSerializerPlugin(String className,
                                                              boolean onlyEnabled)

getWebModulePlugin

public WebModulePlugin getWebModulePlugin(String className,
                                          boolean onlyEnabled)

getAllWebPlugins

public Map<PluginContext,WebModulePlugin> getAllWebPlugins(boolean onlyEnabled)

getAllModelCheckerPlugins

public Map<PluginContext,ModelCheckerPlugin> getAllModelCheckerPlugins(boolean onlyEnabled)

getModelCheckerPlugin

public ModelCheckerPlugin getModelCheckerPlugin(String className,
                                                boolean onlyEnabled)

getLocalBimServerClientInterface

public BimServerClientInterface getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
                                                          throws ServiceException,
                                                                 ChannelConnectionException

Specified by:

getLocalBimServerClientInterface in interface PluginManagerInterface

Throws:

ServiceException

ChannelConnectionException

setBimServerClientFactory

public void setBimServerClientFactory(BimServerClientFactory bimServerClientFactory)

registerNewExtendedDataOnProjectHandler

public void registerNewExtendedDataOnProjectHandler(long uoid,
                                                    ServiceDescriptor serviceDescriptor,
                                                    NewExtendedDataOnProjectHandler newExtendedDataHandler)

Specified by:

registerNewExtendedDataOnProjectHandler in interface PluginManagerInterface

registerNewExtendedDataOnRevisionHandler

public void registerNewExtendedDataOnRevisionHandler(long uoid,
                                                     ServiceDescriptor serviceDescriptor,
                                                     NewExtendedDataOnRevisionHandler newExtendedDataHandler)

Specified by:

registerNewExtendedDataOnRevisionHandler in interface PluginManagerInterface

getDeserializerPlugin

public DeserializerPlugin getDeserializerPlugin(String pluginClassName,
                                                boolean onlyEnabled)

Specified by:

getDeserializerPlugin in interface PluginManagerInterface

getStreamingDeserializerPlugin

public StreamingDeserializerPlugin getStreamingDeserializerPlugin(String pluginClassName,
                                                                  boolean onlyEnabled)

getStreamingSerializerPlugin

public StreamingSerializerPlugin getStreamingSerializerPlugin(String pluginClassName,
                                                              boolean onlyEnabled)

getMetaDataManager

public MetaDataManager getMetaDataManager()

Specified by:

getMetaDataManager in interface PluginManagerInterface

setMetaDataManager

public void setMetaDataManager(MetaDataManager metaDataManager)

getOrCreateFileSystem

public FileSystem getOrCreateFileSystem(URI uri)
                                 throws IOException

Specified by:

getOrCreateFileSystem in interface PluginManagerInterface

Throws:

IOException

getMessagingStreamingSerializerPlugin

public MessagingStreamingSerializerPlugin getMessagingStreamingSerializerPlugin(String className,
                                                                                boolean onlyEnabled)

getPluginInformationFromJar

public List<SPluginInformation> getPluginInformationFromJar(Path file)
                                                     throws PluginException,
                                                            FileNotFoundException,
                                                            IOException,
                                                            JAXBException

Throws:

PluginException

FileNotFoundException

IOException

JAXBException

getPluginInformationFromJar

public List<SPluginInformation> getPluginInformationFromJar(InputStream jarInputStream)
                                                     throws PluginException,
                                                            FileNotFoundException,
                                                            IOException,
                                                            JAXBException

Throws:

PluginException

FileNotFoundException

IOException

JAXBException

getPluginInformationFromPluginFile

public List<SPluginInformation> getPluginInformationFromPluginFile(InputStream inputStream)
                                                            throws PluginException,
                                                                   FileNotFoundException,
                                                                   IOException,
                                                                   JAXBException

Throws:

PluginException

FileNotFoundException

IOException

JAXBException

getPluginInformationFromPluginFile

public List<SPluginInformation> getPluginInformationFromPluginFile(Path file)
                                                            throws PluginException,
                                                                   FileNotFoundException,
                                                                   IOException,
                                                                   JAXBException

Throws:

PluginException

FileNotFoundException

IOException

JAXBException

getPluginTypeFromClass

public SPluginType getPluginTypeFromClass(String className)

loadFromPluginDir

public PluginBundle loadFromPluginDir(PluginBundleVersionIdentifier pluginBundleVersionIdentifier,
                                      SPluginBundleVersion pluginBundleVersion,
                                      List<SPluginInformation> plugins,
                                      boolean strictDependencyChecking)
                               throws Exception

Throws:

Exception

loadPlugin

public PluginBundle loadPlugin(PluginBundleVersionIdentifier pluginBundleVersionIdentifier,
                               Path target,
                               SPluginBundle sPluginBundle,
                               SPluginBundleVersion pluginBundleVersion,
                               List<SPluginInformation> plugins,
                               ClassLoader parentClassLoader)
                        throws Exception

Throws:

Exception

install

public PluginBundle install(MavenPluginBundle mavenPluginBundle,
                            boolean strictDependencyChecking)
                     throws Exception

Throws:

Exception

install

public PluginBundle install(MavenPluginBundle mavenPluginBundle,
                            List<SPluginInformation> plugins,
                            boolean strictDependencyChecking)
                     throws Exception

Throws:

Exception

uninstall

public void uninstall(PluginBundleVersionIdentifier pluginBundleVersionIdentifier)

getPluginBundle

public PluginBundle getPluginBundle(PluginBundleIdentifier pluginIdentifier)

getPluginBundles

public Collection<PluginBundle> getPluginBundles()

getDefaultObjectIDM

public ObjectIDM getDefaultObjectIDM()
                              throws ObjectIDMException

Specified by:

getDefaultObjectIDM in interface PluginManagerInterface

Throws:

ObjectIDMException

notifyPluginStateChange

public void notifyPluginStateChange(PluginContext pluginContext,
                                    boolean enabled)

Specified by:

notifyPluginStateChange in interface PluginManagerInterface

update

public PluginBundle update(PluginBundleVersionIdentifier pluginBundleVersionIdentifier,
                           SPluginBundle sPluginBundle,
                           SPluginBundleVersion pluginBundleVersion,
                           Path jarFile,
                           Path pomFile,
                           List<SPluginInformation> plugins)
                    throws Exception

Throws:

Exception

getSerializerPlugin

public SerializerPlugin getSerializerPlugin(String pluginClassName)

Specified by:

getSerializerPlugin in interface PluginManagerInterface