Class EsbDeveloperPanelProvider

java.lang.Object

com.kingsrook.qqq.esb.api.EsbDeveloperPanelProvider

All Implemented Interfaces:

DeveloperPanelProviderInterface

public class EsbDeveloperPanelProvider
extends Object
implements DeveloperPanelProviderInterface

Developer panel for a record of a table that publishes change events to the ESB: the CloudEvents type, source and subject of its events, where they are published, the triggers (processes) subscribed to them with their dead letter counts, and a sample event for this record. Available when the ESB is configured and the table has ESB publications; the subscribers are only those on processes the user may run (as on GET /qqq/v1/esb/table/{table}).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Constructor Summary

Constructors

Constructor	Description
EsbDeveloperPanelProvider()

Method Summary

Modifier and Type	Method	Description
DeveloperPanel	build(DeveloperPanelContext context)	Build the panel's content.
String	getIcon()	Optional icon-name hint for the frontend (a Material icon name).
String	getId()	Stable identifier of the panel, unique in the instance (e.g., "esb").
Integer	getOrder()	Sort order among panels (lower first).
String	getTitle()	Heading of the panel.
boolean	isAvailable(DeveloperPanelContext context)	Available when the ESB is configured and the table publishes to it.

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

EsbDeveloperPanelProvider

public EsbDeveloperPanelProvider()

Method Details

getId

public String getId()

Description copied from interface: DeveloperPanelProviderInterface

Stable identifier of the panel, unique in the instance (e.g., "esb").

Specified by:

getId in interface DeveloperPanelProviderInterface

getTitle

public String getTitle()

Description copied from interface: DeveloperPanelProviderInterface

Heading of the panel.

Specified by:

getTitle in interface DeveloperPanelProviderInterface

getOrder

public Integer getOrder()

Description copied from interface: DeveloperPanelProviderInterface

Sort order among panels (lower first). Built-in panels use 100-199; qbits default to 500.

Specified by:

getOrder in interface DeveloperPanelProviderInterface

getIcon

public String getIcon()

Description copied from interface: DeveloperPanelProviderInterface

Optional icon-name hint for the frontend (a Material icon name).

Specified by:

getIcon in interface DeveloperPanelProviderInterface

isAvailable

public boolean isAvailable(DeveloperPanelContext context)

Available when the ESB is configured and the table publishes to it.

Specified by:

isAvailable in interface DeveloperPanelProviderInterface

build

public DeveloperPanel build(DeveloperPanelContext context)
                     throws QException

Description copied from interface: DeveloperPanelProviderInterface

Build the panel's content. The id, title, order and icon are filled in from this provider when the returned panel leaves them null.

Specified by:

build in interface DeveloperPanelProviderInterface

Throws:

QException