org.bimserver.plugins.services

Class ServicePlugin

java.lang.Object

org.bimserver.plugins.services.ServicePlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

AbstractService

public abstract class ServicePlugin
extends Object
implements Plugin

Constructor Summary

Constructors

Constructor and Description
ServicePlugin()

Method Summary

Modifier and Type	Method and Description
protected BimServerClientInterface	getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
PluginManagerInterface	getPluginManager()
ServiceInterface	getServiceInterface(String token)
abstract String	getTitle()
void	init(PluginManagerInterface pluginManager) Initialize this plugin
boolean	isInitialized()
abstract void	register(long uoid, SInternalServicePluginConfiguration internalService, PluginConfiguration pluginConfiguration) This will start an instance of the ServicePlugin with the settings for a specific user
void	registerNewExtendedDataOnProjectHandler(long uoid, ServiceDescriptor serviceDescriptor, NewExtendedDataOnProjectHandler newExtendedDataHandler)
void	registerNewExtendedDataOnRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor, NewExtendedDataOnRevisionHandler newExtendedDataHandler)
protected void	registerNewRevisionHandler(long uoid, ServiceDescriptor serviceDescriptor, NewRevisionHandler newRevisionHandler)
abstract void	unregister(SInternalServicePluginConfiguration internalService)
protected void	unregisterNewRevisionHandler(ServiceDescriptor serviceDescriptor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bimserver.plugins.Plugin

getDefaultName, getDescription, getSettingsDefinition, getVersion

Constructor Detail

ServicePlugin

public ServicePlugin()

Method Detail

getTitle

public abstract String getTitle()

getServiceInterface

public ServiceInterface getServiceInterface(String token)
                                     throws UserException

Throws:

UserException

registerNewRevisionHandler

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

unregisterNewRevisionHandler

protected void unregisterNewRevisionHandler(ServiceDescriptor serviceDescriptor)

getLocalBimServerClientInterface

protected BimServerClientInterface getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
                                                             throws ServiceException,
                                                                    ChannelConnectionException

Throws:

ServiceException

ChannelConnectionException

init

public void init(PluginManagerInterface pluginManager)
          throws PluginException

Description copied from interface: Plugin

Initialize this plugin

Specified by:

init in interface Plugin

Throws:

PluginException

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface Plugin

Returns:

Whether the plugin has successfully initialized

getPluginManager

public PluginManagerInterface getPluginManager()

registerNewExtendedDataOnProjectHandler

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

registerNewExtendedDataOnRevisionHandler

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

register

public abstract void register(long uoid,
                              SInternalServicePluginConfiguration internalService,
                              PluginConfiguration pluginConfiguration)

This will start an instance of the ServicePlugin with the settings for a specific user

Parameters:

pluginConfiguration -

unregister

public abstract void unregister(SInternalServicePluginConfiguration internalService)