org.bimserver.plugins.services

Class AbstractService

java.lang.Object

org.bimserver.plugins.services.ServicePlugin

org.bimserver.plugins.services.AbstractService

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

AbstractAddExtendedDataService, AbstractModifyRevisionService

public abstract class AbstractService
extends ServicePlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractService.ProgressType
class	AbstractService.RunningService

Constructor Summary

Constructors

Constructor and Description
AbstractService(String name, String description)

Method Summary

Modifier and Type	Method and Description
abstract void	addRequiredRights(ServiceDescriptor serviceDescriptor)
String	getDefaultName()
String	getDescription()
PluginContext	getPluginContext()
AbstractService.ProgressType	getProgressType() Should return whether this service can report progress (as a percentage) or not
ObjectDefinition	getSettingsDefinition()
String	getTitle()
String	getVersion()
void	init(PluginManagerInterface pluginManager) Initialize this plugin
abstract void	newRevision(AbstractService.RunningService runningService, BimServerClientInterface bimServerClientInterface, long poid, long roid, String userToken, long soid, SObjectType settings) This method gets called when there is a new revision
void	register(long uoid, SInternalServicePluginConfiguration internalService, PluginConfiguration pluginConfiguration) This will start an instance of the ServicePlugin with the settings for a specific user
void	unregister(SInternalServicePluginConfiguration internalService)

Methods inherited from class org.bimserver.plugins.services.ServicePlugin

getLocalBimServerClientInterface, getPluginManager, getServiceInterface, isInitialized, registerNewExtendedDataOnProjectHandler, registerNewExtendedDataOnRevisionHandler, registerNewRevisionHandler, unregisterNewRevisionHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractService

public AbstractService(String name,
                       String description)

Method Detail

init

public void init(PluginManagerInterface pluginManager)
          throws PluginException

Description copied from interface: Plugin

Initialize this plugin

Specified by:

init in interface Plugin

Overrides:

init in class ServicePlugin

Throws:

PluginException

getPluginContext

public PluginContext getPluginContext()

getDescription

public String getDescription()

Returns:

A description of this plugin

getDefaultName

public String getDefaultName()

Returns:

The default name of this plugin, a user can later change the name

getVersion

public String getVersion()

Returns:

The version of this plugin, for now it's not used for dependencies, only for (manual) identification

getSettingsDefinition

public ObjectDefinition getSettingsDefinition()

Returns:

An object with the definition of a set of properties that can be set by the user of a plugin, the plugin can later use the actual values a user has set

getTitle

public String getTitle()

Specified by:

getTitle in class ServicePlugin

newRevision

public abstract void newRevision(AbstractService.RunningService runningService,
                                 BimServerClientInterface bimServerClientInterface,
                                 long poid,
                                 long roid,
                                 String userToken,
                                 long soid,
                                 SObjectType settings)
                          throws Exception

This method gets called when there is a new revision

Parameters:

runningService - A reference to the RunningService, you can use it to update the progress if you know it

bimServerClientInterface - A client with the proper authorization on this or a remote BIMserver to fetch the revision, and write extended data to

poid - ProjectID of the project

roid - RevisionID of the new revision

userToken - Optional token, unused at the moment

soid - ServiceID

settings - Optional settings a user might have given in the InternalService settings

Throws:

Exception

getProgressType

public AbstractService.ProgressType getProgressType()

Should return whether this service can report progress (as a percentage) or not

Returns:

ProgressType.UNKNOWN when the progress is not known, or KNOWN when it is

addRequiredRights

public abstract void addRequiredRights(ServiceDescriptor serviceDescriptor)

register

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

Description copied from class: ServicePlugin

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

Specified by:

register in class ServicePlugin

unregister

public void unregister(SInternalServicePluginConfiguration internalService)

Specified by:

unregister in class ServicePlugin