org.bimserver.plugins

Interface Plugin

All Known Subinterfaces:

DeserializerPlugin, MessagingSerializerPlugin, MessagingStreamingSerializerPlugin, ModelCheckerPlugin, ModelComparePlugin, ModelMergerPlugin, ObjectIDMPlugin, QueryEnginePlugin, RenderEnginePlugin, SerializerPlugin, StillImageRenderPlugin, StreamingDeserializerPlugin, StreamingSerializerPlugin

All Known Implementing Classes:

AbstractAddExtendedDataService, AbstractModifyRevisionService, AbstractSerializerPlugin, AbstractService, BimBotAbstractService, ServicePlugin

public interface Plugin

Method Summary

Modifier and Type	Method and Description
SPluginType	getPluginType()
ObjectDefinition	getSettingsDefinition()
void	init(PluginContext pluginContext) Initialize this plugin

Method Detail

init

void init(PluginContext pluginContext)
   throws PluginException

Initialize this 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

getSettingsDefinition

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

getPluginType

SPluginType getPluginType()

Returns:

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