org.camunda.bpm.cockpit.impl.plugin.base

Class BasePlugin

java.lang.Object

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

org.camunda.bpm.cockpit.impl.plugin.base.BasePlugin

All Implemented Interfaces:

CockpitPlugin

public class BasePlugin
extends AbstractCockpitPlugin

Author:

nico.rehwaldt

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Constructor and Description
BasePlugin()

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.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

BasePlugin

public BasePlugin()

Method Detail

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

Overrides:

getResourceClasses in class AbstractCockpitPlugin

Returns:

the set of resource classes provided by this plugin

getId

public String getId()

Description copied from interface: CockpitPlugin

Returns the id of this plugin.

Returns:

getAssetDirectory

public String getAssetDirectory()

Description copied from class: AbstractCockpitPlugin

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

Overrides:

getAssetDirectory in class AbstractCockpitPlugin

Returns:

the directory providing the plugins client side assets

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

Overrides:

getMappingFiles in class AbstractCockpitPlugin

Returns:

the list of additional mapping files