org.camunda.bpm.cockpit.plugin.spi

Interface CockpitPlugin

All Known Implementing Classes:

AbstractCockpitPlugin, BasePlugin

public interface CockpitPlugin

The service provider interface (SPI) that must be provided by a cockpit plugin.

A implementation of this SPI publishes

• a unique name
• a number of mybatis mapping files that contain custom engine queries
• a directory that contains the plugins client-side assets (HTML + JavaScript files)
• a number of resource classes that extend the cockpit restful API

Plugin developers should not use this interface directly but use AbstractCockpitPlugin as a base class.

Author:

nico.rehwaldt

See Also:

AbstractCockpitPlugin

Method Summary

Methods

Modifier and Type	Method and Description
String	getAssetDirectory() Returns a uri to a plugins asset directory.
String	getId() Returns the id of this plugin.
List<String>	getMappingFiles() Returns a list of mapping files that define the custom queries provided by this plugin.
Set<Class<?>>	getResourceClasses() Returns a set of JAX-RS resource classes that extend the cockpit rest API.

Method Detail

getResourceClasses

Set<Class<?>> getResourceClasses()

Returns a set of JAX-RS resource classes that extend the cockpit rest API.

Typically, a plugin publishes its API via a subclass of AbstractPluginRootResource.

Returns:

the set of resource classes provided by this plugin

getMappingFiles

List<String> getMappingFiles()

Returns a list of mapping files that define the custom queries provided by this plugin.

The mapping files define additional MyBatis queries that can be executed by the plugin.

Inside the plugin the queries may be executed via the QueryService that may be obtained through Cockpit.getQueryService(java.lang.String).

Returns:

the list of additional mapping files

getAssetDirectory

String getAssetDirectory()

Returns a uri to a plugins asset directory. The directory must be unique across all plugins.

Returns:

the directory providing the plugins client side assets

getId

String getId()

Returns the id of this plugin.

Returns: