Package com.inductiveautomation.ignition.gateway.config

Class SingletonResourceHandler.Builder<R>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.SingletonResourceHandler.Builder<R>

Enclosing class:

SingletonResourceHandler<R>

public static class SingletonResourceHandler.Builder<R>
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(ResourceTypeMeta<R> meta)

Method Summary

Modifier and Type	Method	Description
SingletonResourceHandler<R>	build()
SingletonResourceHandler.Builder<R>	configurationManager(ConfigurationManager manager)	The configuration manager that will be used to store the resource
SingletonResourceHandler.Builder<R>	context(GatewayContext context)	Use the GatewayContext to set the configuration manager and redundancy manager.
SingletonResourceHandler.Builder<R>	onChange(Consumer<R> resourceChangeListener)	A callback that will be invoked whenever the resource changes.
SingletonResourceHandler.Builder<R>	redundancyManager(RedundancyManager redundancyManager)	By specifying a redundancy manager, the handler will automatically use the "backupConfig.json" version of the resource's configuration if the gateway is running as the Backup node.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@Nonnull
 ResourceTypeMeta<R> meta)

Method Details

context

public SingletonResourceHandler.Builder<R> context(GatewayContext context)

Use the GatewayContext to set the configuration manager and redundancy manager. If you call this (recommended) you can skip calling configurationManager(ConfigurationManager) and redundancyManager(RedundancyManager)

configurationManager

public SingletonResourceHandler.Builder<R> configurationManager(ConfigurationManager manager)

The configuration manager that will be used to store the resource

Calling either this or context(GatewayContext) is required.

See Also:

• GatewayContext.getConfigurationManager()

redundancyManager

public SingletonResourceHandler.Builder<R> redundancyManager(RedundancyManager redundancyManager)

By specifying a redundancy manager, the handler will automatically use the "backupConfig.json" version of the resource's configuration if the gateway is running as the Backup node.

This is optional.

See Also:

• GatewayContext.getRedundancyManager()

onChange

public SingletonResourceHandler.Builder<R> onChange(Consumer<R> resourceChangeListener)

A callback that will be invoked whenever the resource changes. This may be called on startup if the resource is different from the meta's default config.

This is optional.

build

public SingletonResourceHandler<R> build()