Package org.camunda.bpm.cockpit.plugin.spi

Interface CockpitPlugin

All Superinterfaces:

AppPlugin

All Known Implementing Classes:

AbstractCockpitPlugin, CockpitPlugins, TestCockpitPlugin

public interface CockpitPlugin
extends AppPlugin

The service provider interface (SPI) that must be provided by a cockpit plugin. A cockpit plugin may provide additional MyBatis mapping files, see getMappingFiles(). Plugin developers should not use this interface directly but use AbstractCockpitPlugin as a base class.

Author:

nico.rehwaldt

See Also:

• AbstractCockpitPlugin

Method Summary

Modifier and Type	Method	Description
List<String>	getMappingFiles()	Returns a list of mapping files that define the custom queries provided by this plugin.

Methods inherited from interface org.camunda.bpm.webapp.plugin.spi.AppPlugin

getAssetDirectory, getId, getResourceClasses, getResourceOverrides

Method Details

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