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

Class AbstractAppPlugin

java.lang.Object

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

All Implemented Interfaces:

AppPlugin

Direct Known Subclasses:

AbstractAdminPlugin, AbstractCockpitPlugin, AbstractTasklistPlugin, AbstractWelcomePlugin

public abstract class AbstractAppPlugin
extends Object
implements AppPlugin

Abstract implementation of the AppPlugin SPI. Should be used by

Author:

Daniel Meyer

Constructor Summary

Constructors

Constructor and Description
AbstractAppPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAssetDirectory() Returns a uri to a plugin resources directory.
Set<Class<?>>	getResourceClasses() Returns a set of JAX-RS resource classes that extend the rest API.
List<PluginResourceOverride>	getResourceOverrides() Allows providing a list of resource overrides.

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

getId

Constructor Detail

AbstractAppPlugin

public AbstractAppPlugin()

Method Detail

getAssetDirectory

public String getAssetDirectory()

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

Returns:

the directory providing the plugins client side resources

getResourceClasses

public Set<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

Returns:

the set of resource classes provided by this plugin

getResourceOverrides

public List<PluginResourceOverride> getResourceOverrides()

Description copied from interface: AppPlugin

Allows providing a list of resource overrides. Resource overrides allow to conditionally override the static resources provided by other plugins.

Specified by:

getResourceOverrides in interface AppPlugin

Returns:

a list of PluginResourceOverride implementations.