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)
PluginContext	getPluginContext()
SPluginType	getPluginType()
ServiceInterface	getServiceInterface(String token)
void	init(PluginContext pluginContext) Initialize this plugin
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(long uoid, 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

getSettingsDefinition

Constructor Detail

ServicePlugin

public ServicePlugin()

Method Detail

getServiceInterface

public ServiceInterface getServiceInterface(String token)
                                     throws UserException

Throws:

UserException

registerNewRevisionHandler

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

unregisterNewRevisionHandler

protected void unregisterNewRevisionHandler(long uoid,
                                            ServiceDescriptor serviceDescriptor)

getLocalBimServerClientInterface

protected BimServerClientInterface getLocalBimServerClientInterface(AuthenticationInfo tokenAuthentication)
                                                             throws ServiceException,
                                                                    ChannelConnectionException

Throws:

ServiceException

ChannelConnectionException

init

public void init(PluginContext pluginContext)
          throws PluginException

Description copied from interface: Plugin

Initialize this plugin

Specified by:

init in interface Plugin

Parameters:

pluginContext - The context of the plugin, you can store this object as a field and use it later

Throws:

PluginException - When the init method throws a PluginException, this will always disable the plugin

registerNewExtendedDataOnProjectHandler

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

getPluginContext

public PluginContext getPluginContext()

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)

getPluginType

public final SPluginType getPluginType()

Specified by:

getPluginType in interface Plugin

Returns:

Returns the type of plugin, should be implemented by all underlying interfaces, and not by the actual plugins