Package com.inductiveautomation.eventstream.gateway.rpc

Class GatewayEventStreamRpc

java.lang.Object

com.inductiveautomation.eventstream.gateway.rpc.GatewayEventStreamRpc

All Implemented Interfaces:

EventStreamRpc

public class GatewayEventStreamRpc
extends Object
implements EventStreamRpc

Field Summary

Fields inherited from interface com.inductiveautomation.eventstream.rpc.EventStreamRpc

SERIALIZER

Constructor Summary

Constructors

Constructor	Description
GatewayEventStreamRpc(EventStreamManager eventStreamManager)

Method Summary

Modifier and Type	Method	Description
EventStreamDiagnostics	getDiagnostics(String projectName, String path)	Returns the current diagnostics for the given Event Stream.
List<EventStreamEncoder.Descriptor>	getEventStreamEncoders()	Returns a list of all available Event Stream encoders.
List<HandlerDescriptor>	getHandlerDescriptors()	List of all available Event Stream Handler descriptors.
List<SourceDescriptor>	getSourceDescriptors()	List of all available Event Stream Source descriptors.
EventStreamState	getState(String project, String path)	Returns the current state of the Event Stream.
List<EventStreamDescription>	listEventStreams(String project)	Returns a list of all Event Streams in the given project.
EventStreamDiagnostics	runEventStream(String projectName, String path, EventStreamConfig config, EventStreamRunConfig runConfig)	Starts the Event Stream with the given configuration.
boolean	validateExpression(String project, ExpressionValue expressionValue)	Validates the given expression value.

Methods inherited from class java.lang.Object

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

Constructor Details

GatewayEventStreamRpc

public GatewayEventStreamRpc(EventStreamManager eventStreamManager)

Method Details

getSourceDescriptors

public List<SourceDescriptor> getSourceDescriptors()

Description copied from interface: EventStreamRpc

List of all available Event Stream Source descriptors.

Specified by:

getSourceDescriptors in interface EventStreamRpc

getHandlerDescriptors

public List<HandlerDescriptor> getHandlerDescriptors()

Description copied from interface: EventStreamRpc

List of all available Event Stream Handler descriptors.

Specified by:

getHandlerDescriptors in interface EventStreamRpc

getEventStreamEncoders

public List<EventStreamEncoder.Descriptor> getEventStreamEncoders()

Description copied from interface: EventStreamRpc

Returns a list of all available Event Stream encoders.

Specified by:

getEventStreamEncoders in interface EventStreamRpc

Returns:

List of Event Stream encoder descriptors

listEventStreams

public List<EventStreamDescription> listEventStreams(String project)

Description copied from interface: EventStreamRpc

Returns a list of all Event Streams in the given project.

Specified by:

listEventStreams in interface EventStreamRpc

Parameters:

project - Project name

Returns:

List of Event Stream descriptions

getDiagnostics

public EventStreamDiagnostics getDiagnostics(String projectName,
 String path)

Description copied from interface: EventStreamRpc

Returns the current diagnostics for the given Event Stream.

Specified by:

getDiagnostics in interface EventStreamRpc

Parameters:

projectName - Project name

path - Path to Event Stream

Returns:

Current diagnostics for the Event Stream

runEventStream

public EventStreamDiagnostics runEventStream(String projectName,
 String path,
 EventStreamConfig config,
 EventStreamRunConfig runConfig)

Description copied from interface: EventStreamRpc

Starts the Event Stream with the given configuration. Stops immediately after the first event.

Specified by:

runEventStream in interface EventStreamRpc

Parameters:

projectName - Project name

path - Path to Event Stream

config - Configuration for the Event Stream

runConfig - Run configuration for the Event Stream

Returns:

Current diagnostics for the Event Stream

getState

public EventStreamState getState(String project,
 String path)

Description copied from interface: EventStreamRpc

Returns the current state of the Event Stream.

Specified by:

getState in interface EventStreamRpc

Parameters:

project - Project name

path - Path to Event Stream

Returns:

Current state of the Event Stream

validateExpression

public boolean validateExpression(String project,
 ExpressionValue expressionValue)

Description copied from interface: EventStreamRpc

Validates the given expression value.

Specified by:

validateExpression in interface EventStreamRpc

Parameters:

project - Project name

expressionValue - Expression value to validate

Returns:

True if the expression is valid, False otherwise