org.camunda.bpm.cockpit.plugin.spi.impl

Class AbstractCockpitPlugin

java.lang.Object

org.camunda.bpm.cockpit.plugin.spi.impl.AbstractCockpitPlugin

All Implemented Interfaces:

CockpitPlugin

Direct Known Subclasses:

BasePlugin

public abstract class AbstractCockpitPlugin
extends Object
implements CockpitPlugin

An implementation of CockpitPlugin that comes with reasonable defaults.

Author:

nico.rehwaldt

See Also:

CockpitPlugin

Constructor Summary

Constructors

Constructor and Description
AbstractCockpitPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAssetDirectory() Returns a uri to a plugins asset directory.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.cockpit.plugin.spi.CockpitPlugin

getId

Constructor Detail

AbstractCockpitPlugin

public AbstractCockpitPlugin()

Method Detail

getAssetDirectory

public String getAssetDirectory()

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

This implementation assumes that the assets are provided in the directory assets, relative to the location of the CockpitPlugin SPI implementation class.

Specified by:

getAssetDirectory in interface CockpitPlugin

Returns:

the directory providing the plugins client side assets

getResourceClasses

public Set<Class<?>> getResourceClasses()

Description copied from interface: CockpitPlugin

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.

Specified by:

getResourceClasses in interface CockpitPlugin

Returns:

the set of resource classes provided by this plugin

getMappingFiles

public List<String> getMappingFiles()

Description copied from interface: CockpitPlugin

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).

Specified by:

getMappingFiles in interface CockpitPlugin

Returns:

the list of additional mapping files