org.apache.brooklyn.ui.modularity.module.api

Interface UiModule

All Known Implementing Classes:

ExternalUiModule, UiModuleImpl

public interface UiModule

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UiModule.Utils

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.util.List<UiModuleAction>	getActions()
java.lang.String	getIcon()
java.lang.String	getId()
java.lang.String	getName()
java.lang.String	getPath()
java.lang.String	getSlug()
boolean	getStopExisting()
java.util.Set<java.lang.String>	getSupersedesBundles()
java.util.Set<java.lang.String>	getTypes()

Field Detail

DEFAULT_ICON

static final java.lang.String DEFAULT_ICON

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns:

The unique ID of the module

getName

java.lang.String getName()

Returns:

The module name

getSlug

java.lang.String getSlug()

Returns:

The human readable id in form (part1-part2-part3...)

getIcon

java.lang.String getIcon()

Returns:

The icon to be used for the module

getTypes

java.util.Set<java.lang.String> getTypes()

Returns:

The module types eg single-page-app, external-ui

getSupersedesBundles

java.util.Set<java.lang.String> getSupersedesBundles()

Returns:

List of "bundle-regex" or "bundle-regex:version-regex" of bundles that should be stopped when this is installed. Useful if supplying a bundle to replace other bundles.

getStopExisting

boolean getStopExisting()

Returns:

Whether to web-stop any bundles listening on the same endpoint.

getPath

java.lang.String getPath()

Returns:

The module path

getActions

java.util.List<UiModuleAction> getActions()

Returns:

Registered module actions