Package org.camunda.bpm.cockpit.impl.plugin

Class CockpitPlugins

java.lang.Object

org.camunda.bpm.webapp.plugin.spi.impl.AbstractAppPlugin

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

org.camunda.bpm.cockpit.impl.plugin.CockpitPlugins

All Implemented Interfaces:

CockpitPlugin, AppPlugin

public class CockpitPlugins
extends AbstractCockpitPlugin

Author:

nico.rehwaldt

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ID

Constructor Summary

Constructors

Constructor	Description
CockpitPlugins()

Method Summary

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

Methods inherited from class org.camunda.bpm.webapp.plugin.spi.impl.AbstractAppPlugin

getResourceOverrides

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.webapp.plugin.spi.AppPlugin

getResourceOverrides

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

CockpitPlugins

public CockpitPlugins()

Method Detail

getMappingFiles

public java.util.List<java.lang.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

getId

public java.lang.String getId()

Description copied from interface: AppPlugin

Returns the unique id of this plugin.

Returns:

getResourceClasses

public java.util.Set<java.lang.Class<?>> getResourceClasses()

Description copied from interface: AppPlugin

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

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

Specified by:

getResourceClasses in interface AppPlugin

Overrides:

getResourceClasses in class AbstractAppPlugin

Returns:

the set of resource classes provided by this plugin

getAssetDirectory

public java.lang.String getAssetDirectory()

Description copied from class: AbstractAppPlugin

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

This implementation assumes that the resources are provided in the directory plugin-webapp/PLUGIN_ID, absolute to the root directory.

Specified by:

getAssetDirectory in interface AppPlugin

Overrides:

getAssetDirectory in class AbstractAppPlugin

Returns:

the directory providing the plugins client side resources