Package com.morpheusdata.core.providers

Interface SystemTabProvider

All Superinterfaces:

PluginProvider, UIExtensionProvider

All Known Implementing Classes:

AbstractSystemTabProvider

public interface SystemTabProvider
extends UIExtensionProvider

Renders tabs within a System in Morpheus. Intended for displaying additional System-specific information. To keep UI responsive, implementors should render a lightweight shell and load heavier content dynamically via an endpoint (ajax/fetch) if needed.

Since:

1.4.0

See Also:

• for a base implementation with Handlebars rendering support.

Nested Class Summary

Nested classes/interfaces inherited from interface com.morpheusdata.core.providers.PluginProvider

PluginProvider.ConfigurationDriftCheckFacet<T>, PluginProvider.EventSubscriberFacet<E extends Event>, PluginProvider.UpdateFacet<T>

Method Summary

Modifier and Type	Method	Description
String	getCode()	stable id used by UI + endpoints
String	getName()	label shown in the UI
default Integer	getOrder()	sort order
HTMLResponse	renderTemplate(System system)
Boolean	show(System system, User user, Account account)	Provide logic when tab should be displayed.

Methods inherited from interface com.morpheusdata.core.providers.PluginProvider

getMorpheus, getPlugin

Methods inherited from interface com.morpheusdata.core.providers.UIExtensionProvider

getContentSecurityPolicy, getRenderer

Method Details

getCode

String getCode()

stable id used by UI + endpoints

Specified by:

getCode in interface PluginProvider

Returns:

short code string that should be unique across all other plugin implementations.

getName

String getName()

label shown in the UI

Specified by:

getName in interface PluginProvider

Returns:

either an English name of a Provider or an i18n based key that can be scanned for in a properties file.

getOrder

default Integer getOrder()

sort order

renderTemplate

HTMLResponse renderTemplate(System system)

show

Boolean show(System system,
 User user,
 Account account)

Provide logic when tab should be displayed. This logic is checked after permissions are validated.

Parameters:

system - System details

user - current User details

account - Account details

Returns:

whether the tab should be displayed