Interface BindingContext
-
- All Superinterfaces:
AuditingContext
,LoggingContext
- All Known Implementing Classes:
AbstractBindingHarness
,ElementBindingHarness
public interface BindingContext extends AuditingContext, LoggingContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.util.Optional<AuditProfile>
getAuditProfile()
default java.util.concurrent.ExecutorService
getExecutorService()
Shortcut to get to the shared executor.QualifiedValue
getLastValue()
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. SeePerspectiveContext.getExecutorService()
-
getScheduler
default java.util.concurrent.ScheduledExecutorService getScheduler()
-
getAuditProfile
@Nonnull default java.util.Optional<AuditProfile> getAuditProfile()
- Specified by:
getAuditProfile
in interfaceAuditingContext
- Returns:
- an
Optional
containing theAuditProfile
for this context or an emptyOptional
if no audit profile is set
-
-