org.bimserver.plugins

Class PluginManager

java.lang.Object

org.bimserver.plugins.PluginManager

All Implemented Interfaces:

PluginManagerInterface, PluginClassLoaderProvider

public class PluginManager
extends Object
implements PluginManagerInterface, PluginClassLoaderProvider

Constructor Summary

Constructors

Constructor and Description
PluginManager(Path tempDir, String baseClassPath, ServiceFactory serviceFactory, NotificationsManagerInterface notificationsManagerInterface, SServicesMap servicesMap, BasicServerInfoProvider basicServerInfoProvider)

Method Summary

Modifier and Type	Method and Description
void	disablePlugin(String name)
void	enablePlugin(String name)
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,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)
Collection<StreamingDeserializerPlugin>	getAllStreamingDeserializerPlugins(String extension, boolean onlyEnabled)
Map<PluginContext,StreamingSerializerPlugin>	getAllStreamingSeserializerPlugins(boolean onlyEnabled)
Map<PluginContext,WebModulePlugin>	getAllWebPlugins(boolean onlyEnabled)
BasicServerInfo	getBasicServerInfo()
ClassLoader	getClassLoaderFor(String pluginClassName)
String	getCompleteClassPath()
DeserializerPlugin	getDeserializerPlugin(String pluginClassName, boolean onlyEnabled)
DeserializerPlugin	getFirstDeserializer(String extension, Schema schema, boolean onlyEnabled)
StreamingDeserializerPlugin	getFirstStreamingDeserializer(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)
FileSystem	getOrCreateFileSystem(URI uri)
Parameter	getParameter(PluginContext pluginContext, String name)
Plugin	getPlugin(String identifier, boolean onlyEnabled)
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
boolean	isEnabled(String className)
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)
void	notifyPluginStateChange(PluginContext pluginContext, boolean enabled)
long	pluginBundleInstalled(PluginBundle pluginBundle)
void	pluginBundleUninstalled(PluginBundle pluginBundle)
long	pluginBundleUpdated(PluginBundle pluginBundle)
void	pluginInstalled(long pluginBundleVersionId, PluginContext pluginContext, SPluginInformation sPluginInformation)
void	pluginUninstalled(PluginContext pluginContext)
void	pluginUpdated(long pluginBundleVersionId, PluginContext pluginContext, SPluginInformation sPluginInformation)
void	processPluginDescriptor(PluginDescriptor pluginDescriptor, List<SPluginInformation> list)
void	registerNewExtendedDataOnProjectHandler(long uoid, ServiceDescriptor serviceDescriptor, NewExtendedDataOnProjectHandler newExtendedDataHandler)
void	registerNewExtendedDataOnRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor, NewExtendedDataOnRevisionHandler newExtendedDataHandler)
void	registerNewRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor, NewRevisionHandler newRevisionHandler)
void	removeImplementation(PluginContext pluginContext)
DeserializerPlugin	requireDeserializer(String extension)
void	setBimServerClientFactory(BimServerClientFactory bimServerClientFactory)
void	setMetaDataManager(MetaDataManager metaDataManager)
void	setPluginChangeListener(PluginChangeListener pluginChangeListener)
void	unregisterNewRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor)

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,
                     String baseClassPath,
                     ServiceFactory serviceFactory,
                     NotificationsManagerInterface notificationsManagerInterface,
                     SServicesMap servicesMap,
                     BasicServerInfoProvider basicServerInfoProvider)

Method Detail

getPluginDescriptor

public PluginDescriptor getPluginDescriptor(InputStream inputStream)
                                     throws JAXBException,
                                            IOException

Throws:

JAXBException

IOException

getPluginDescriptor

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

Throws:

JAXBException

IOException

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)

getAllStreamingDeserializerPlugins

public Collection<StreamingDeserializerPlugin> getAllStreamingDeserializerPlugins(String extension,
                                                                                  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)

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

getFirstStreamingDeserializer

public StreamingDeserializerPlugin getFirstStreamingDeserializer(String extension,
                                                                 Schema schema,
                                                                 boolean onlyEnabled)
                                                          throws PluginException

Throws:

PluginException

getRenderEnginePlugin

public RenderEnginePlugin getRenderEnginePlugin(String className,
                                                boolean onlyEnabled)

Specified by:

getRenderEnginePlugin in interface PluginManagerInterface

getQueryEngine

public QueryEnginePlugin getQueryEngine(String className,
                                        boolean onlyEnabled)

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

processPluginDescriptor

public void processPluginDescriptor(PluginDescriptor pluginDescriptor,
                                    List<SPluginInformation> list)

getPluginInformationFromPluginFile

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

Throws:

PluginException

FileNotFoundException

IOException

JAXBException

getPluginTypeFromClass

public SPluginType getPluginTypeFromClass(String className)

notifyPluginStateChange

public void notifyPluginStateChange(PluginContext pluginContext,
                                    boolean enabled)

Specified by:

notifyPluginStateChange in interface PluginManagerInterface

getSerializerPlugin

public SerializerPlugin getSerializerPlugin(String pluginClassName)

Specified by:

getSerializerPlugin in interface PluginManagerInterface

getBasicServerInfo

public BasicServerInfo getBasicServerInfo()

Specified by:

getBasicServerInfo in interface PluginManagerInterface

pluginBundleUpdated

public long pluginBundleUpdated(PluginBundle pluginBundle)

pluginUpdated

public void pluginUpdated(long pluginBundleVersionId,
                          PluginContext pluginContext,
                          SPluginInformation sPluginInformation)
                   throws BimserverDatabaseException

Throws:

BimserverDatabaseException

pluginBundleInstalled

public long pluginBundleInstalled(PluginBundle pluginBundle)

pluginInstalled

public void pluginInstalled(long pluginBundleVersionId,
                            PluginContext pluginContext,
                            SPluginInformation sPluginInformation)
                     throws BimserverDatabaseException

Throws:

BimserverDatabaseException

pluginUninstalled

public void pluginUninstalled(PluginContext pluginContext)

pluginBundleUninstalled

public void pluginBundleUninstalled(PluginBundle pluginBundle)

removeImplementation

public void removeImplementation(PluginContext pluginContext)

getClassLoaderFor

public ClassLoader getClassLoaderFor(String pluginClassName)

Specified by:

getClassLoaderFor in interface PluginClassLoaderProvider