org.apache.brooklyn.ui.modularity

Class ExternalUiModule

java.lang.Object

org.apache.brooklyn.ui.modularity.ExternalUiModule

All Implemented Interfaces:

UiModule

public class ExternalUiModule
extends java.lang.Object
implements UiModule

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.ui.modularity.module.api.UiModule

UiModule.Utils

Field Summary

Fields inherited from interface org.apache.brooklyn.ui.modularity.module.api.UiModule

DEFAULT_ICON

Constructor Summary

Constructors

Constructor and Description
ExternalUiModule()

Method Summary

Modifier and Type	Method and Description
void	activate(java.util.Map<java.lang.String,java.lang.String> properties)
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()
void	modified(java.util.Map<java.lang.String,java.lang.String> properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalUiModule

public ExternalUiModule()

Method Detail

activate

public void activate(java.util.Map<java.lang.String,java.lang.String> properties)

modified

public void modified(java.util.Map<java.lang.String,java.lang.String> properties)

getId

public java.lang.String getId()

Specified by:

getId in interface UiModule

Returns:

The unique ID of the module

getName

public java.lang.String getName()

Specified by:

getName in interface UiModule

Returns:

The module name

getSlug

public java.lang.String getSlug()

Specified by:

getSlug in interface UiModule

Returns:

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

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface UiModule

Returns:

The icon to be used for the module

getTypes

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

Specified by:

getTypes in interface UiModule

Returns:

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

getSupersedesBundles

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

Specified by:

getSupersedesBundles in interface UiModule

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

public boolean getStopExisting()

Specified by:

getStopExisting in interface UiModule

Returns:

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

getPath

public java.lang.String getPath()

Specified by:

getPath in interface UiModule

Returns:

The module path

getActions

public java.util.List<UiModuleAction> getActions()

Specified by:

getActions in interface UiModule

Returns:

Registered module actions