org.bimserver.plugins

Class PluginContext

java.lang.Object

org.bimserver.plugins.PluginContext

public class PluginContext
extends Object

Constructor Summary

Constructors

Constructor and Description
PluginContext(PluginManagerInterface pluginManager, PluginBundle pluginBundle, Class<?> pluginInterface, ClassLoader classLoader, PluginSourceType pluginType, String description, URI location, Plugin plugin, String classLocation, Set<Dependency> dependencies, String identifier)

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader()
String	getClassLocation()
ObjectIDM	getDefaultObjectIDM()
Set<Dependency>	getDependencies()
String	getDescription()
DeserializerPlugin	getDeserializerPlugin(String string, boolean b)
String	getIdentifier()
BimServerClientInterface	getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
URI	getLocation()
MetaDataManager	getMetaDataManager()
Parameter	getParameter(String name)
Plugin	getPlugin()
PluginBundle	getPluginBundle()
Class<?>	getPluginInterface()
PluginSourceType	getPluginType()
Path	getRootPath()
SerializerPlugin	getSerializerPlugin(String string)
ServiceFactory	getServiceFactory()
Path	getTempDir()
String	getVersion()
void	initialize()
boolean	isEnabled()
boolean	isInitialized()
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	setEnabled(boolean enabled, boolean notify)
void	setInitialized(boolean initialized)
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

PluginContext

public PluginContext(PluginManagerInterface pluginManager,
                     PluginBundle pluginBundle,
                     Class<?> pluginInterface,
                     ClassLoader classLoader,
                     PluginSourceType pluginType,
                     String description,
                     URI location,
                     Plugin plugin,
                     String classLocation,
                     Set<Dependency> dependencies,
                     String identifier)
              throws IOException

Throws:

IOException

Method Detail

getPluginType

public PluginSourceType getPluginType()

getPlugin

public Plugin getPlugin()

getLocation

public URI getLocation()

setEnabled

public void setEnabled(boolean enabled,
                       boolean notify)

isEnabled

public boolean isEnabled()

getClassLocation

public String getClassLocation()

getClassLoader

public ClassLoader getClassLoader()

getRootPath

public Path getRootPath()

getParameter

public Parameter getParameter(String name)

getDependencies

public Set<Dependency> getDependencies()

getPluginBundle

public PluginBundle getPluginBundle()

getDescription

public String getDescription()

isInitialized

public boolean isInitialized()

setInitialized

public void setInitialized(boolean initialized)

getVersion

public String getVersion()

getPluginInterface

public Class<?> getPluginInterface()

initialize

public void initialize()
                throws PluginException

Throws:

PluginException

getIdentifier

public String getIdentifier()

getDefaultObjectIDM

public ObjectIDM getDefaultObjectIDM()
                              throws ObjectIDMException

Throws:

ObjectIDMException

getTempDir

public Path getTempDir()

getMetaDataManager

public MetaDataManager getMetaDataManager()

getServiceFactory

public ServiceFactory getServiceFactory()

registerNewRevisionHandler

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

unregisterNewRevisionHandler

public void unregisterNewRevisionHandler(long uoid,
                                         ServiceDescriptor serviceDescriptor)

getLocalBimServerClientInterface

public BimServerClientInterface getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
                                                          throws ServiceException,
                                                                 ChannelConnectionException

Throws:

ServiceException

ChannelConnectionException

registerNewExtendedDataOnProjectHandler

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

registerNewExtendedDataOnRevisionHandler

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

requireDeserializer

public DeserializerPlugin requireDeserializer(String extension)
                                       throws DeserializeException

Throws:

DeserializeException

getDeserializerPlugin

public DeserializerPlugin getDeserializerPlugin(String string,
                                                boolean b)

getSerializerPlugin

public SerializerPlugin getSerializerPlugin(String string)