Package com.inductiveautomation.perspective.gateway.api

Interface BindingContext

All Superinterfaces:

AuditingContext, LoggingContext

All Known Implementing Classes:

AbstractBindingHarness, ElementBindingHarness

public interface BindingContext
extends AuditingContext, LoggingContext

Method Summary

Modifier and Type	Method	Description
default java.util.Optional<AuditProfile>	getAuditProfile()
default java.lang.String	getDiagnosticPath()
default java.util.concurrent.ExecutorService	getExecutorService()	Shortcut to get to the shared executor.
QualifiedValue	getLastValue()
default MutabilityMode	getMutabilityMode()
default java.util.concurrent.ScheduledExecutorService	getScheduler()
default Session	getSession()
PerspectiveElement	getTargetElement()
PropertyKey	getTargetProperty()
void	processPublishedValue()	Takes the most recently published value from the binding and runs it through the transforms or delivers it to the target if there are no transforms.
default void	publish(QualifiedValue value)
void	publish(QualifiedValue value, boolean pending)	Called from the binding when it has a value to push onto the target property ( or through its transforms )

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuditingContext

audit, getAuditSnapshot

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.LoggingContext

getLogger, getMdcParent, mdc, mdcSetup, mdcSetupTree, mdcTeardown, mdcTeardownTree, mdcWrap

Method Detail

getTargetElement

PerspectiveElement getTargetElement()

getTargetProperty

PropertyKey getTargetProperty()

publish

default void publish(QualifiedValue value)

publish

void publish(QualifiedValue value,
             boolean pending)

Called from the binding when it has a value to push onto the target property ( or through its transforms )

Parameters:

pending - true if this value is temporary and will be replaced (within a reasonable span of time) with a new value

processPublishedValue

void processPublishedValue()

Takes the most recently published value from the binding and runs it through the transforms or delivers it to the target if there are no transforms.

getLastValue

QualifiedValue getLastValue()

getSession

default Session getSession()

getExecutorService

default java.util.concurrent.ExecutorService getExecutorService()

Shortcut to get to the shared executor. See PerspectiveContext.getExecutorService()

getScheduler

default java.util.concurrent.ScheduledExecutorService getScheduler()

getAuditProfile

@Nonnull
default java.util.Optional<AuditProfile> getAuditProfile()

Specified by:

getAuditProfile in interface AuditingContext

Returns:

an Optional containing the AuditProfile for this context or an empty Optional if no audit profile is set

getMutabilityMode

default MutabilityMode getMutabilityMode()

Returns:

the mutability mode of the current session. This will be "READ_WRITE" except for designer sessions, for which it will match the designer's current gateway comm mode setting. If you need to be notified when this changes, you must listen on the CommonContext.getEventBus() for a SessionMutabilityChangeEvent

getDiagnosticPath

default java.lang.String getDiagnosticPath()