com.diffusiondata.gateway.framework

Interface SourceHandler

All Superinterfaces:

ServiceHandler

All Known Subinterfaces:

HybridHandler<T>, PollingSourceHandler, StreamingSourceHandler

public interface SourceHandler
extends ServiceHandler

The base interface for source service handlers.

A source service handler may be a StreamingSourceHandler or a PollingSourceHandler.

The handler publishes updates to Diffusion using a Publisher provided to it when it is instantiated.

The handler may also optionally return service specific properties via its getSourceServiceProperties() method. If it does not then defaults will be assumed. These properties allow the handler to define details about the topics it wants to create and/or the data conversions to use.

Author:

DiffusionData Limited

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SourceHandler.SourceServiceProperties The properties that apply to topics created by and published to by the service.

Nested classes/interfaces inherited from interface com.diffusiondata.gateway.framework.ServiceHandler

ServiceHandler.PauseReason, ServiceHandler.ResumeReason

Method Summary

Modifier and Type	Method and Description
default SourceHandler.SourceServiceProperties	getSourceServiceProperties() This is used to set topic-specific properties for topics created by this service.

Methods inherited from interface com.diffusiondata.gateway.framework.ServiceHandler

pause, resume, start, stop

Method Detail

getSourceServiceProperties

default SourceHandler.SourceServiceProperties getSourceServiceProperties()
                                                                  throws InvalidConfigurationException

This is used to set topic-specific properties for topics created by this service.

Properties can be built using a builder which can be created using DiffusionGatewayFramework.newSourceServicePropertiesBuilder().

The default implementation returns null, which means that all defaults are assumed for service properties. See the methods of SourceHandler.SourceServiceProperties.Builder for details about defaults.

Returns:

service properties or null if default are to be assumed

Throws:

InvalidConfigurationException - possibly thrown by SourceHandler.SourceServiceProperties.Builder