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, ServicePlugin

public interface Plugin

Method Summary

Modifier and Type	Method and Description
String	getDefaultName()
String	getDescription()
ObjectDefinition	getSettingsDefinition()
String	getVersion()
void	init(PluginManagerInterface pluginManager) Initialize this plugin
boolean	isInitialized()

Method Detail

init

void init(PluginManagerInterface pluginManager)
   throws PluginException

Initialize this plugin

Parameters:

pluginManager -

Throws:

PluginException

getDescription

String getDescription()

Returns:

A description of this plugin

getDefaultName

String getDefaultName()

Returns:

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

getVersion

String getVersion()

Returns:

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

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

isInitialized

boolean isInitialized()

Returns:

Whether the plugin has successfully initialized