Package com.inductiveautomation.ignition.gateway.tags.managed

Class ManagedTagProviderConfiguration.Builder

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.managed.ManagedTagProviderConfiguration.Builder

Enclosing class:

ManagedTagProviderConfiguration

public static class ManagedTagProviderConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(ManagedTagProviderConfiguration config)
Builder(String name)

Method Summary

Modifier and Type	Method	Description
ManagedTagProviderConfiguration.Builder	allowBackfill(boolean allow)
ManagedTagProviderConfiguration.Builder	allowDefaultWriteHandling(boolean allow)	If true, writes to tags will be allowed and will not require a write handler to be installed.
ManagedTagProviderConfiguration.Builder	allowTagCustomization(boolean allow)
ManagedTagProviderConfiguration.Builder	allowTagDeletion(boolean allow)
ManagedTagProviderConfiguration	build()
ManagedTagProviderConfiguration.Builder	hasDataTypes(boolean value)
ManagedTagProviderConfiguration.Builder	historyAssociation(String providerName, QualifiedPathTransform pathAdapter)	If set, the tags can be queried for history through this historical provider.
ManagedTagProviderConfiguration.Builder	mountPath(String path)
ManagedTagProviderConfiguration.Builder	persistTags(boolean allow)
ManagedTagProviderConfiguration.Builder	setAttribute(int flag, boolean value)	These attributes affect advanced traits of the provider, and currently come from TagProviderProps
ManagedTagProviderConfiguration.Builder	staleTimeout(long timeout)	Not currently implemented fully, is used to mark persistent values stale if value is anything other than 0.
ManagedTagProviderConfiguration.Builder	synchronizeMemoryValues(boolean allow)	If true, the provider will synchronize memory values to redundant pair.
ManagedTagProviderConfiguration.Builder	valuePersistence(TagProviderValuePersistence persistence)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String name)

Builder

public Builder(ManagedTagProviderConfiguration config)

Method Details

allowTagCustomization

public ManagedTagProviderConfiguration.Builder allowTagCustomization(boolean allow)

allowTagDeletion

public ManagedTagProviderConfiguration.Builder allowTagDeletion(boolean allow)

persistTags

public ManagedTagProviderConfiguration.Builder persistTags(boolean allow)

allowDefaultWriteHandling

public ManagedTagProviderConfiguration.Builder allowDefaultWriteHandling(boolean allow)

If true, writes to tags will be allowed and will not require a write handler to be installed. If false, the manager of the provider must register a WriteHandler for each tag (or wildcard path) that will allow writes. Registered write handlers will still be called, if this value is true.

synchronizeMemoryValues

public ManagedTagProviderConfiguration.Builder synchronizeMemoryValues(boolean allow)

If true, the provider will synchronize memory values to redundant pair.

staleTimeout

public ManagedTagProviderConfiguration.Builder staleTimeout(long timeout)

Not currently implemented fully, is used to mark persistent values stale if value is anything other than 0.

setAttribute

public ManagedTagProviderConfiguration.Builder setAttribute(int flag,
 boolean value)

These attributes affect advanced traits of the provider, and currently come from TagProviderProps

hasDataTypes

public ManagedTagProviderConfiguration.Builder hasDataTypes(boolean value)

allowBackfill

public ManagedTagProviderConfiguration.Builder allowBackfill(boolean allow)

mountPath

public ManagedTagProviderConfiguration.Builder mountPath(String path)

valuePersistence

public ManagedTagProviderConfiguration.Builder valuePersistence(TagProviderValuePersistence persistence)

historyAssociation

public ManagedTagProviderConfiguration.Builder historyAssociation(String providerName,
 QualifiedPathTransform pathAdapter)

If set, the tags can be queried for history through this historical provider. Note that when set, the user will not be able to configure additional history on the tags.

build

public ManagedTagProviderConfiguration build()