Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceEntityDelegate

java.lang.Object

com.inductiveautomation.ignition.gateway.config.DefaultResourceEntityDelegate

All Implemented Interfaces:

ResourceEntityDelegate

public class DefaultResourceEntityDelegate
extends Object
implements ResourceEntityDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultResourceEntityDelegate.ActiveResourcesMetric	A ratio gauge that shows active/total resources for a given resource type, where "active" is defined as having a healthcheck named "status" that is healthy
static class	DefaultResourceEntityDelegate.Builder
protected static class	DefaultResourceEntityDelegate.EnabledResourcesMetric	A ratio gauge that shows enabled/total resources for a given resource type
protected static class	DefaultResourceEntityDelegate.ResourceEntity	Implementation that turns a named Resource into an Entity.

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ResourceEntityDelegate

NONE

Constructor Summary

Constructors

Constructor	Description
DefaultResourceEntityDelegate()	This constructor will decide to include or exclude the entity from the section overview based on whether the resource type is a singleton
DefaultResourceEntityDelegate(Boolean includeInSectionOverview)
DefaultResourceEntityDelegate(Boolean includeInSectionOverview, boolean includeInDiagnosticOverview)
DefaultResourceEntityDelegate(Boolean includeInSectionOverview, boolean includeInDiagnosticOverview, List<String> excludedMetrics)

Method Summary

Modifier and Type	Method	Description
protected Entity	buildChildEntity(GatewayContext context, ResourceTypeMeta<?> meta, Resource resource)
protected Entity	buildEntity(GatewayContext context, ResourceTypeMeta<?> meta)
protected void	configureChildren(GatewayContext context, ResourceTypeMeta<?> meta, EntityBuilder builder)
protected void	configureDescription(ResourceTypeMeta<?> meta, EntityBuilder.DescriptionComponentBuilder descriptionBuilder)
protected void	configureDiagnostics(GatewayContext context, ResourceTypeMeta<?> meta, EntityBuilder builder)
protected void	configureNavigation(ResourceTypeMeta<?> meta, NavLocation location, EntityBuilder.NavigationComponentBuilder navBuilder)
Optional<Entity>	getEntity(GatewayContext context, ResourceTypeMeta<?> meta)
protected boolean	includeInSectionOverview(ResourceTypeMeta<?> meta)	If this returns true, the "section-overview" tag will be added to the entity's navigation component.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultResourceEntityDelegate

public DefaultResourceEntityDelegate()

This constructor will decide to include or exclude the entity from the section overview based on whether the resource type is a singleton

DefaultResourceEntityDelegate

public DefaultResourceEntityDelegate(@Nullable
 Boolean includeInSectionOverview)

Parameters:

includeInSectionOverview - Whether to include this resource type in the section overview page.

DefaultResourceEntityDelegate

public DefaultResourceEntityDelegate(@Nullable
 Boolean includeInSectionOverview,
 boolean includeInDiagnosticOverview)

Parameters:

includeInSectionOverview - Whether to include this resource type in the section overview page.

includeInDiagnosticOverview - Whether to include this resource type in the diagnostic overview page.

DefaultResourceEntityDelegate

public DefaultResourceEntityDelegate(@Nullable
 Boolean includeInSectionOverview,
 boolean includeInDiagnosticOverview,
 List<String> excludedMetrics)

Parameters:

includeInSectionOverview - Whether to include this resource type in the section overview page.

includeInDiagnosticOverview - Whether to include this resource type in the diagnostic overview page.

excludedMetrics - A list of metric alias names to be excluded from the entity object

Method Details

getEntity

public Optional<Entity> getEntity(GatewayContext context,
 ResourceTypeMeta<?> meta)

Specified by:

getEntity in interface ResourceEntityDelegate

Returns:

An Entity that represents this resource type, or empty if no entity is associated with this resource type.

buildEntity

protected Entity buildEntity(GatewayContext context,
 ResourceTypeMeta<?> meta)

configureDescription

protected void configureDescription(ResourceTypeMeta<?> meta,
 EntityBuilder.DescriptionComponentBuilder descriptionBuilder)

includeInSectionOverview

protected boolean includeInSectionOverview(ResourceTypeMeta<?> meta)

If this returns true, the "section-overview" tag will be added to the entity's navigation component.

configureNavigation

protected void configureNavigation(ResourceTypeMeta<?> meta,
 NavLocation location,
 EntityBuilder.NavigationComponentBuilder navBuilder)

configureDiagnostics

protected void configureDiagnostics(GatewayContext context,
 ResourceTypeMeta<?> meta,
 EntityBuilder builder)

configureChildren

protected void configureChildren(GatewayContext context,
 ResourceTypeMeta<?> meta,
 EntityBuilder builder)

buildChildEntity

protected Entity buildChildEntity(GatewayContext context,
 ResourceTypeMeta<?> meta,
 Resource resource)