Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceTypeMeta.ExtensionPointBuilder<P extends ExtensionPointProfileConfig>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.DefaultResourceTypeMeta.ExtensionPointBuilder<P>

Type Parameters:

P - The config object type for the extension point's "profile" configuration. Note that the type-specific "settings" object types are not defined here, but rather on each ExtensionPoint type.

Enclosing class:

DefaultResourceTypeMeta<R>

public static class DefaultResourceTypeMeta.ExtensionPointBuilder<P extends ExtensionPointProfileConfig>
extends Object

Assists in building a ResourceTypeMeta for an extension point resource type.

Constructor Summary

Constructors

Constructor	Description
ExtensionPointBuilder(Class<P> profileType)	Creates a new builder for an extension point resource type.

Method Summary

Modifier and Type	Method	Description
ResourceTypeMeta<ExtensionPointConfig<P,?>>	build()
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildActionSet(Consumer<ResourceActionSet.Builder> actionSetBuilder)
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildEntityDelegate(Consumer<DefaultResourceEntityDelegate.Builder> consumer)	Builds an entity delegate for the resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildGson(Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> gsonCustomizer)	Allows customization of the gson instance used by the ExtensionPointResourceCodec that will be built.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildProfileValidator(BiConsumer<P,ValidationErrors.Builder> validator)	Helps build a basic profile validator.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildReferenceDelegate(Consumer<ExtensionPointReferenceDelegate.Builder<P>> builderConsumer)	Allows for customization of a reference delegate.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildRouteDelegate(Consumer<DefaultResourceRouteDelegate.ExtensionPointBuilder<P>> builderConsumer)	Builds a route delegate for this resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildScriptDelegate(Consumer<DefaultResourceScriptDelegate.Builder> builderConsumer)
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	buildStatusDelegate(Consumer<DefaultResourceStatusDelegate.Builder> builderConsumer)	Builds a status delegate for the resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	categoryName(String categoryName)	Provide a "category name" for your resource, for example "Schedules" or "Module Widgets".
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	categoryNameKey(String categoryNameKey)	Similar to calling categoryName(String) but uses an i18n key instead of a raw literal string.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	description(String description)	Provide a description for your resource.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	descriptionKey(String description)	Provide a description for your resource.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	displayNameFunction(BiFunction<ResourceId,Locale,String> displayNameFunction)	Provides a function that can be used to derive the display name of a resource.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	extensionPointCollection(ExtensionPointCollection<? extends ExtensionPoint<?>> extensionPointCollection)	Sets the extension point collection for this extension point.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	iconPath(String staticPath)
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	iconPath(Function<ResourceId,String> iconPath)
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	preferredResourceCollection(String preferredResourceCollection)	Sets the preferred resource collection for the resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	resourceType(ResourceType resourceType)	Sets the resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withActionSet(ResourceActionSet actionMap)
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withAuditDelegate(ResourceAuditDelegate auditDelegate)	Sets an audit delegate for this resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withCodec(ResourceCodec<ExtensionPointConfig<P,?>> codec)	Sets the codec directly.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withDefaultProfile(P defaultProfile)	Supplies the default values for this extension point's profile configuration.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withEntityDelegate(ResourceEntityDelegate entityDelegate)	Sets an entity delegate for this resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withProfileValidator(ResourceValidator<P> profileValidator)	Sets a validator for the extension point profile config object.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withReferenceDelegate(ResourceReferenceDelegate<ExtensionPointConfig<P,?>> referenceDelegate)	Sets a reference delegate for this resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withRouteDelegate(ResourceRouteDelegate<ExtensionPointConfig<P,?>> routeDelegate)	Sets the route delegate for the resource type.
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withScriptDelegate(ResourceScriptDelegate scriptDelegate)
DefaultResourceTypeMeta.ExtensionPointBuilder<P>	withStatusDelegate(ResourceStatusDelegate statusDelegate)	Sets a custom status delegate.

Methods inherited from class java.lang.Object

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

Constructor Details

ExtensionPointBuilder

public ExtensionPointBuilder(Class<P> profileType)

Creates a new builder for an extension point resource type.

Parameters:

profileType - The class that represents the profile (shared) configuration object for all instances of this extension point.

Method Details

resourceType

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> resourceType(ResourceType resourceType)

Sets the resource type. Note that the resource type defines the extension point itself, and not an individual extension point type. Extension point types are defined by instances of ExtensionPoint and exposed by GatewayModuleHook.getExtensionPoints().

This is required.

extensionPointCollection

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> extensionPointCollection(ExtensionPointCollection<? extends ExtensionPoint<?>> extensionPointCollection)

Sets the extension point collection for this extension point. This collection contains all the registered extension point types for this extension point. Extension points often have a mix of statically-defined and module-provided types. This collection can be created like this:

     ExtensionPointCollection<MyExtensionPoint&gt = ImmutableExtensionPointCollection.build(
          myExtensionPointResourceType,
          gatewayContext.getModuleManager(),
          new MyFirstStaticType(),
          new MySecondStaticType()
     );
 

This is required.

categoryName

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> categoryName(String categoryName)

Provide a "category name" for your resource, for example "Schedules" or "Module Widgets". If you have this string defined in an i18n file, you can use the key version of this method by calling categoryNameKey(String).

This (or categoryNameKey(String)) is required.

categoryNameKey

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> categoryNameKey(String categoryNameKey)

Similar to calling categoryName(String) but uses an i18n key instead of a raw literal string.

This (or categoryName(String)) is required.

See Also:

• BundleUtil

description

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> description(String description)

Provide a description for your resource. If you have this string defined in an i18n file, you can use the key version of this method by calling descriptionKey(String).

descriptionKey

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> descriptionKey(String description)

Provide a description for your resource. Similar to calling description(String) but uses an i18n key instead of a raw literal string.

See Also:

• BundleUtil

preferredResourceCollection

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> preferredResourceCollection(String preferredResourceCollection)

Sets the preferred resource collection for the resource type. Useful in cases where a resource type should always be created in "local".

This is optional, and defaults to "core".

displayNameFunction

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> displayNameFunction(BiFunction<ResourceId,Locale,String> displayNameFunction)

Provides a function that can be used to derive the display name of a resource.

This is optional, and the resource's innate name or type (for singletons) will be used if this is not set.

See Also:

• Resource.getResourceName()

iconPath

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> iconPath(String staticPath)

iconPath

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> iconPath(Function<ResourceId,String> iconPath)

withCodec

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withCodec(ResourceCodec<ExtensionPointConfig<P,?>> codec)

Sets the codec directly. Use this if you have a custom codec that you want to use. This is not common, you likely want to call buildGson(Consumer) and/or withProfileValidator(ResourceValidator) instead.

This is optional.

If this resource type opts into the route system (e.g. by providing a route delegate), the codec must be a JsonResourceCodec.

buildGson

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildGson(Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> gsonCustomizer)

Allows customization of the gson instance used by the ExtensionPointResourceCodec that will be built. This is the gson instance that will be used to encode and decode the extension point profile config object.

Note that this is only half the story for encoding and decoding extension point resources. Each extension point type may also provide a custom gson for encoding/decoding its settings object. This is done through ExtensionPoint.decode(JsonElement)

If you call this, you shouldn't be calling withCodec(ResourceCodec)

This is optional.

withProfileValidator

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withProfileValidator(ResourceValidator<P> profileValidator)

Sets a validator for the extension point profile config object.

Note that this is only half the story for validating extension point resources. Each extension point type can also provide a validator for its settings config object: this is done through ExtensionPoint.getSettingsValidator().

If you call this, you shouldn't be calling withCodec(ResourceCodec)

This is optional.

buildProfileValidator

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildProfileValidator(BiConsumer<P,ValidationErrors.Builder> validator)

Helps build a basic profile validator. Example:

     .buildProfileValidator((profile, validation) -> validation
          .requireNonNull(profile.getSomeField(), "someField", "Some field is required")
          .check(profile.someValidityCheck(), "profile state invalid because reasons"))
 

If you call this method, do not call withCodec(ResourceCodec).

This is optional.

Parameters:

validator - Receives the config object and a ValidationErrors.Builder to add errors to. If no errors are added to the builder, the resource "passes" validation.

withActionSet

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withActionSet(ResourceActionSet actionMap)

buildActionSet

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildActionSet(Consumer<ResourceActionSet.Builder> actionSetBuilder)

withRouteDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withRouteDelegate(ResourceRouteDelegate<ExtensionPointConfig<P,?>> routeDelegate)

Sets the route delegate for the resource type. By setting a route delegate, you enable CRUD routes for the resources of this type. Typically, you will call #buildrouteDelegate(Consumer) instead of this method (don't call both).

This is optional.

buildRouteDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildRouteDelegate(Consumer<DefaultResourceRouteDelegate.ExtensionPointBuilder<P>> builderConsumer)

Builds a route delegate for this resource type. By calling this method (or withRouteDelegate(ResourceRouteDelegate)) you enable CRUD routes for the resources of this type.

This is optional

withScriptDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withScriptDelegate(ResourceScriptDelegate scriptDelegate)

buildScriptDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildScriptDelegate(Consumer<DefaultResourceScriptDelegate.Builder> builderConsumer)

withStatusDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withStatusDelegate(ResourceStatusDelegate statusDelegate)

Sets a custom status delegate. Usually these are built, see buildStatusDelegate(Consumer). Don't call both methods.

This is optional

buildStatusDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildStatusDelegate(Consumer<DefaultResourceStatusDelegate.Builder> builderConsumer)

Builds a status delegate for the resource type. The status delegate is responsible for looking up metrics and healthchecks for resource instances. If you use this builder method, don't call withStatusDelegate(ResourceStatusDelegate)

This is optional.

withEntityDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withEntityDelegate(ResourceEntityDelegate entityDelegate)

Sets an entity delegate for this resource type. This is used to generate entities for the resource type. If omitted, a default delegate will be used.

buildEntityDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildEntityDelegate(Consumer<DefaultResourceEntityDelegate.Builder> consumer)

Builds an entity delegate for the resource type. This is used to generate entities for the resource type. If you use this builder method, don't call withEntityDelegate(ResourceEntityDelegate)

This is optional.

withReferenceDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withReferenceDelegate(ResourceReferenceDelegate<ExtensionPointConfig<P,?>> referenceDelegate)

Sets a reference delegate for this resource type. Usually reference delegates are built using buildReferenceDelegate(Consumer). Don't call both methods.

This is optional.

buildReferenceDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> buildReferenceDelegate(Consumer<ExtensionPointReferenceDelegate.Builder<P>> builderConsumer)

Allows for customization of a reference delegate. Reference delegates are used to find references to other resources, so that they can be updated when resources are renamed.

Note that each extension point may need to also resolve references for the settings object, and this is done in ExtensionPoint.getReferenceProperties()

This is optional.

withAuditDelegate

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withAuditDelegate(ResourceAuditDelegate auditDelegate)

Sets an audit delegate for this resource type.

This is optional.

withDefaultProfile

public DefaultResourceTypeMeta.ExtensionPointBuilder<P> withDefaultProfile(P defaultProfile)

Supplies the default values for this extension point's profile configuration. Note that each extension point type should also provide a default settings object.

See Also:

• ExtensionPoint.defaultSettings()

build

public ResourceTypeMeta<ExtensionPointConfig<P,?>> build()