Index (gateway-framework-api 2.1.0 API)

A B C D G H I J M N O P R S T U V W

A

addHybrid(ServiceDefinition, Publisher, Subscriber, StateHandler) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Adds a hybrid service to the application.
addMissingTopicHandler(String, MissingTopicNotificationHandler) - Method in interface com.diffusiondata.gateway.framework.Publisher: Register a MissingTopicNotificationHandler which will be notified if a client subscription request matches no known topics and the selector prefix of the subscription matches the specified branch of the topic tree.
addPollingSource(ServiceDefinition, Publisher, StateHandler) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Adds a polling source service to the application.
addServiceType(String, ServiceMode, String, String) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Add a service type.
addServiceType(String, ServiceMode, String, String, BiFunction<Integer, Map<String, Object>, Map<String, Object>>) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Add a service type.
addSharedConfigType(String, String, String) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Add a sharedConfig type.
addSharedConfigType(String, String, String, BiFunction<Integer, Map<String, Object>, Map<String, Object>>) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Add a sharedConfig type.
addSink(ServiceDefinition, Subscriber, StateHandler) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Adds a sink service to the application.
addStreamingSource(ServiceDefinition, Publisher, StateHandler) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Adds a streaming source service to the application.
appendTags(List<Tag>, String, String) - Static method in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Creates aggregated list of tags with passed key and value for a tag.
ApplicationConfigurationException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that the configuration of the application is invalid or the application failed to be initialized due to configuration issues.
ApplicationConfigurationException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.ApplicationConfigurationException: Constructor.
ApplicationConfigurationException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.ApplicationConfigurationException: Constructor.
ApplicationContext - Interface in com.diffusiondata.gateway.framework: An application context for GatewayApplication.
ApplicationInitializationException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that a failure was detected when initializing a gateway application.
ApplicationInitializationException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.ApplicationInitializationException: Constructor.
ApplicationInitializationException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.ApplicationInitializationException: Constructor.
applyJSONPatch(String, String) - Method in interface com.diffusiondata.gateway.framework.Publisher: Apply a JSON patch to a Diffusion topic value.
autoSubscribe() - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties: Returns a boolean flag to specify whether the framework should subscribe to the configured topic selector when a service is started.
autoSubscribe(boolean) - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties.Builder: Specifies a boolean flag to specify whether the framework should subscribe to the configured topic selector when a service is started.
AVRO_BYTES_TO_JSON - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Avro byte array to the Diffusion JSON topic format.
AVRO_TO_AVRO_BYTES - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Avro value to an Avro byte array.
AVRO_TO_JSON - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Avro value to the Diffusion TopicType.JSON topic format.
AVRO_TO_JSON_STRING - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Avro value to a JSON String.

B

BINARY_TOPIC_TO_BYTE_ARRAY - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts the Diffusion TopicType.BINARY topic type to a byte array.
build(String, int) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Create an GatewayApplication.ApplicationDetails instance with the current settings of this builder.
build() - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties.Builder: Creates a SinkHandler.SinkServiceProperties instance with the current settings of this builder.
build() - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties.Builder: Create a SourceHandler.SourceServiceProperties instance with the current settings of this builder.

C

com.diffusiondata.gateway.framework - package com.diffusiondata.gateway.framework: Diffusion Gateway Framework API.
com.diffusiondata.gateway.framework.converters - package com.diffusiondata.gateway.framework.converters: Payload Converters.
com.diffusiondata.gateway.framework.exceptions - package com.diffusiondata.gateway.framework.exceptions: Diffusion Gateway Framework API : Exceptions.
convert(I) - Method in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: Converts an input value of type 'I' to an output value of type 'O'.
createTagsWithException(List<Tag>, Throwable) - Static method in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Creates aggregated list of tags with passed list and tag with exception detail.
CSV_TO_JSON - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts CSV data to the Diffusion TopicType.JSON topic format.

D

DATA_TYPES - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: Diffusion datatype implementation that can be used to create Diffusion topic types.
DiffusionClientException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that an exception has been returned from the Diffusion Client API.
DiffusionClientException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.DiffusionClientException: Constructor.
DiffusionClientException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.DiffusionClientException: Constructor.
DiffusionGatewayFramework - Enum in com.diffusiondata.gateway.framework: Provides static methods for use with the Diffusion Gateway Framework.
DiffusionGatewayFramework.Implementation - Interface in com.diffusiondata.gateway.framework: Do not use - Use static methods on DiffusionGatewayFramework.
DiffusionSecurityException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that the framework application principal does not have sufficient permissions to perform the operation.
DiffusionSecurityException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.DiffusionSecurityException: Constructor.
dontRetainValue() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a boolean value to specify whether a topic should not retain its last value.

G

GatewayApplication - Interface in com.diffusiondata.gateway.framework: The interface that a Gateway Framework application must implement.
GatewayApplication.ApplicationDetails - Interface in com.diffusiondata.gateway.framework: Basic details of the application.
GatewayApplication.ApplicationDetails.Builder - Interface in com.diffusiondata.gateway.framework: A builder for application details.
GatewayApplicationException - Exception in com.diffusiondata.gateway.framework.exceptions: A checked exception that can be thrown by a GatewayApplication.
GatewayApplicationException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.GatewayApplicationException: Constructor.
GatewayApplicationException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.GatewayApplicationException: Constructor.
GatewayFramework - Interface in com.diffusiondata.gateway.framework: Gateway Framework.
GatewayFrameworkException - Exception in com.diffusiondata.gateway.framework.exceptions: An unchecked exception returned to a GatewayApplication from the Gateway Framework.
GatewayFrameworkException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.GatewayFrameworkException: Constructor.
GatewayFrameworkException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.GatewayFrameworkException: Constructor.
GatewayMeterRegistry - Interface in com.diffusiondata.gateway.framework: Interface to supply MeterRegistry instance and to provide useful utility methods to create tags which can be used by application and framework.
getApplicationDetails() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Returns the basic details about the application.
getApplicationType() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails: Returns the application type.
getConfiguration() - Method in interface com.diffusiondata.gateway.framework.GatewayFramework: Returns the full configuration for the declared gateway application.
getConfigurationVersion() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails: Returns the configuration version of application.
getConfiguredDiffusionTopicSelector() - Method in interface com.diffusiondata.gateway.framework.Subscriber: Returns the configured diffusionTopicSelector in the framework configuration of the service.
getConfiguredTopicProperties() - Method in interface com.diffusiondata.gateway.framework.Publisher: Returns a TopicProperties with user-configured or default topic properties for the service.
getDataType() - Method in enum com.diffusiondata.gateway.framework.TopicType
getDescription() - Method in enum com.diffusiondata.gateway.framework.ServiceMode
getDescription() - Method in interface com.diffusiondata.gateway.framework.ServiceType: Returns the service type's description.
getDescription() - Method in interface com.diffusiondata.gateway.framework.SharedConfigType: Returns the sharedConfig type's description.
getErrors() - Method in exception com.diffusiondata.gateway.framework.exceptions.InvalidConfigurationException: Returns the map of errors.
getExecutorService() - Method in interface com.diffusiondata.gateway.framework.ApplicationContext: Returns instance of ScheduledExecutorService initialized by the framework using the thread pool configured in configuration file.
getGlobalConfiguration() - Method in interface com.diffusiondata.gateway.framework.ApplicationContext: Returns the configured global parameters for the application.
getGlobalSchema() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails: Returns the global configuration schema.
getId() - Method in interface com.diffusiondata.gateway.framework.ApplicationContext: Returns the application identifier as supplied in the configuration.
getId() - Method in interface com.diffusiondata.gateway.framework.ServiceDefinition: Returns the service identifier.
getId() - Method in interface com.diffusiondata.gateway.framework.SharedConfig: Returns the sharedConfig identifier.
getMessage() - Method in exception com.diffusiondata.gateway.framework.exceptions.InvalidConfigurationException
getMeterRegistry() - Method in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Should return MeterRegistry instance for the application.
getMode() - Method in interface com.diffusiondata.gateway.framework.ServiceType: Returns the service mode.
getName() - Method in interface com.diffusiondata.gateway.framework.ServiceType: Returns the service type name.
getName() - Method in interface com.diffusiondata.gateway.framework.SharedConfig: Returns the sharedConfig name.
getName() - Method in interface com.diffusiondata.gateway.framework.SharedConfigType: Return the sharedConfig type name.
getParameters() - Method in interface com.diffusiondata.gateway.framework.ServiceDefinition: Returns the configured parameters for the service, defined in the application section of the service configuration.
getParameters() - Method in interface com.diffusiondata.gateway.framework.SharedConfig: Returns the sharedConfig parameters as defined by the configuration.
getPayloadConverterNames() - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties: Returns the list of names of payload converters that are assigned for this service, to be used for converting the Diffusion topic values to application format.
getPayloadConverterNames() - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties: Returns a list of names of payload converters that are to be used for converting the published values to Diffusion format.
getPersistencePolicy() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns the persistence policy for the topic.
getSchema() - Method in interface com.diffusiondata.gateway.framework.ServiceType: Returns the service type's JSON schema.
getSchema() - Method in interface com.diffusiondata.gateway.framework.SharedConfigType: Returns the sharedConfig type's JSON schema.
getServiceName() - Method in interface com.diffusiondata.gateway.framework.ServiceDefinition: Returns the service name.
getServiceNameTag(String) - Static method in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Creates a singleton list with Tag containing name of the service for which the metrics is being collected.
getServiceType() - Method in interface com.diffusiondata.gateway.framework.ServiceDefinition: Returns the service type.
getServiceTypes() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails: Returns the services types.
getSessionProperties() - Method in interface com.diffusiondata.gateway.framework.MissingTopicNotification: Returns the session properties of the session that made the request.
getSharedConfig() - Method in interface com.diffusiondata.gateway.framework.ServiceDefinition: Returns the SharedConfig for the service.
getSharedConfigTypes() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails: Returns the sharedConfig types.
getSinkServiceProperties() - Method in interface com.diffusiondata.gateway.framework.SinkHandler: This is used to set topic-specific properties for topics consumed by this service.
getSourceServiceProperties() - Method in interface com.diffusiondata.gateway.framework.SourceHandler: This is used to set topic-specific properties for topics created by this service.
getState() - Method in exception com.diffusiondata.gateway.framework.exceptions.ServiceStateException: Returns the current service state.
getState() - Method in interface com.diffusiondata.gateway.framework.StateHandler: Returns the current state of the service.
getTimeSeriesRetainedRange() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a retained range for a time series topic.
getTimeSeriesSubscriptionRange() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a subscription range for a time series topic.
getTopicPath() - Method in interface com.diffusiondata.gateway.framework.MissingTopicNotification: Returns the topic path derived from the requested topic selector.
getTopicSelector() - Method in interface com.diffusiondata.gateway.framework.MissingTopicNotification: Returns topicSelector string that triggered this notification.
getTopicType() - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties: Returns the type of topic that the service will publish to.
getTopicType() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns the topic type.
getType() - Method in interface com.diffusiondata.gateway.framework.SharedConfig: Returns the sharedConfig type.
getUpdateMode() - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties: Returns the update mode to be used for updating topics.
globalConfigUpgradeFunction(BiFunction<Integer, Map<String, Object>, Map<String, Object>>) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Sets a BiFunction to upgrade global application configuration from an older version to the latest version supported by the application.
globalSchema(String) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication.ApplicationDetails.Builder: Sets the schema for the global application configuration.

H

HybridHandler<T> - Interface in com.diffusiondata.gateway.framework: The interface that a hybrid handler must implement.

I

IncompatibleConfigurationException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that the operation being attempted is incompatible with the application's configuration.
IncompatibleConfigurationException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.IncompatibleConfigurationException: Constructor.
initialize(ApplicationContext) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Called to initialize the application.
initializeGatewayMeterRegistry(Map<String, Object>) - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Initializes and returns an instance of GatewayMeterRegistry which should supply MeterRegistry for the application specific monitoring tool/tools.
InvalidConfigurationException - Exception in com.diffusiondata.gateway.framework.exceptions: Exception thrown by a GatewayApplication to indicate that the configuration parameters that have been passed to it are invalid.
InvalidConfigurationException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.InvalidConfigurationException: Constructor for a general purpose message.
InvalidConfigurationException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.InvalidConfigurationException: Constructor for a general purpose message and specific throwable.
InvalidConfigurationException(String, Map<String, String>) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.InvalidConfigurationException: Constructor for multiple errors.
isMetricsEnabled() - Method in interface com.diffusiondata.gateway.framework.ApplicationContext: Returns a boolean value to represent whether metrics is enabled in the configuration, by application user.
isTimeSeries() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns the boolean value to specify if the topic is a time series topic.

J

JSON_DATA_TYPE - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: JSON datatype implementation.
JSON_TO_AVRO - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts the Diffusion TopicType.JSON topic format to an Avro format.
JSON_TO_CSV - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of this payload converter that converts the Diffusion TopicType.JSON topic format to CSV string.
JSON_TO_STRING - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts the Diffusion TopicType.JSON topic format to a String.
JSONPatchException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that an attempt to apply a JSON patch to a Diffusion topic has failed.
JSONPatchException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.JSONPatchException: Constructor.
JSONPatchException(Integer) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.JSONPatchException: Constructor.

M

mapDiffusionTopic(String, String) - Method in interface com.diffusiondata.gateway.framework.DiffusionGatewayFramework.Implementation: Extracts parts of the Diffusion topic branch in the supplied source path and constructs another topic path specified by the supplied mapping function.
mapDiffusionTopic(String, String) - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Delegator for DiffusionGatewayFramework.mapDiffusionTopic(String, String).
MissingTopicNotification - Interface in com.diffusiondata.gateway.framework: Notification that a session has made a subscription request using a selector that does not match any topics.
MissingTopicNotificationHandler - Interface in com.diffusiondata.gateway.framework: Handler called when any session subscribes using a topic selector that matches no topics.

N

newApplicationDetailsBuilder() - Method in interface com.diffusiondata.gateway.framework.DiffusionGatewayFramework.Implementation: Do not use - Use DiffusionGatewayFramework.newApplicationDetailsBuilder().
newApplicationDetailsBuilder() - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Factory for an GatewayApplication.ApplicationDetails builder.
newSinkServicePropertiesBuilder() - Method in interface com.diffusiondata.gateway.framework.DiffusionGatewayFramework.Implementation: Do not use - Use DiffusionGatewayFramework.newSinkServicePropertiesBuilder().
newSinkServicePropertiesBuilder() - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Factory for builders of SinkHandler.SinkServiceProperties.
newSourceServicePropertiesBuilder() - Method in interface com.diffusiondata.gateway.framework.DiffusionGatewayFramework.Implementation: Do not use - Use DiffusionGatewayFramework.newSourceServicePropertiesBuilder().
newSourceServicePropertiesBuilder() - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Factory for builders of SourceHandler.SourceServiceProperties.

O

OBJECT_TO_BINARY_TOPIC - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Object to the Diffusion TopicType.BINARY topic type.
OBJECT_TO_DOUBLE - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Object to a Double.
OBJECT_TO_JSON - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Object to the Diffusion TopicType.JSON topic format.
OBJECT_TO_LONG - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Object to a Long.
OBJECT_TO_STRING - Static variable in interface com.diffusiondata.gateway.framework.converters.PayloadConverter: The name of payload converter that converts an Object to a String.
onMissingTopic(MissingTopicNotification) - Method in interface com.diffusiondata.gateway.framework.MissingTopicNotificationHandler: Handle passed missing topic notification.
onSubscription(String, TopicProperties) - Method in interface com.diffusiondata.gateway.framework.SinkHandler: Called when the sink service is subscribed to a Diffusion topic.
onUnsubscription(String, TopicProperties, SinkHandler.UnsubscriptionReason) - Method in interface com.diffusiondata.gateway.framework.SinkHandler: Called when the sink service is unsubscribed from a Diffusion topic.

P

pause(ServiceHandler.PauseReason) - Method in interface com.diffusiondata.gateway.framework.ServiceHandler: Notification that the service has been paused.
PayloadConversionException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates a failure to perform a PayloadConverter operation.
PayloadConversionException(String, Throwable) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.PayloadConversionException: Constructor.
PayloadConversionException(String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.PayloadConversionException: Constructor.
PayloadConverter<I,O> - Interface in com.diffusiondata.gateway.framework.converters: The base interface that a payload converter implements.
payloadConverter(String) - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties.Builder: Specifies the name of a payload converter to use for this service.
payloadConverter(String, Map<String, Object>) - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties.Builder: Specifies the name of a payload converter and parameters the converter requires to be initialized.
payloadConverter(PayloadConverter<?, ?>) - Method in interface com.diffusiondata.gateway.framework.SinkHandler.SinkServiceProperties.Builder: Specifies a payload converter to use for the service.
payloadConverter(String) - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties.Builder: Specifies the name of a payload converter to use for this service.
payloadConverter(String, Map<String, Object>) - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties.Builder: Specifies the name of a payload converter and parameters the converter requires to be initialized.
payloadConverter(PayloadConverter<?, ?>) - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties.Builder: Specifies a payload converter to use for this service.
poll() - Method in interface com.diffusiondata.gateway.framework.PollingSourceHandler: Polls the handler for a new value or values.
PollingSourceHandler - Interface in com.diffusiondata.gateway.framework: The interface that a polling source handler must implement.
publish(String, Object) - Method in interface com.diffusiondata.gateway.framework.Publisher: Publishes a new value to Diffusion.
publish(String, Object, TopicProperties) - Method in interface com.diffusiondata.gateway.framework.Publisher: Publishes a new value to Diffusion.
Publisher - Interface in com.diffusiondata.gateway.framework: Allows updates to be published to Diffusion by source handlers or hybrid handlers.
publishValuesOnly() - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a boolean value to specify whether a topic should publish only values.

R

remove(String) - Method in interface com.diffusiondata.gateway.framework.Publisher: Remove a topic or topics.
removeMissingTopicHandler(String) - Method in interface com.diffusiondata.gateway.framework.Publisher: Removes MissingTopicNotificationHandler registered for the specified topicPath in the service.
reportStatus(StateHandler.Status, String, String) - Method in interface com.diffusiondata.gateway.framework.StateHandler: Reports current status.
resume(ServiceHandler.ResumeReason) - Method in interface com.diffusiondata.gateway.framework.ServiceHandler: Notification that the service is being resumed.

S

ServiceDefinition - Interface in com.diffusiondata.gateway.framework: A service definition contains the details of a service required when instantiating a ServiceHandler for the service.
ServiceHandler - Interface in com.diffusiondata.gateway.framework: Base interface for all service handlers.
ServiceHandler.PauseReason - Enum in com.diffusiondata.gateway.framework: The reason that a service is being paused.
ServiceHandler.ResumeReason - Enum in com.diffusiondata.gateway.framework: The reason that a service is being resumed.
ServiceMode - Enum in com.diffusiondata.gateway.framework: Service mode of operation.
ServiceState - Enum in com.diffusiondata.gateway.framework: Indicates the current state of a service.
ServiceStateException - Exception in com.diffusiondata.gateway.framework.exceptions: Indicates that the operation being attempted is incompatible with the current service state.
ServiceStateException(ServiceState) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.ServiceStateException: Constructor.
ServiceStateException(ServiceState, String) - Constructor for exception com.diffusiondata.gateway.framework.exceptions.ServiceStateException: Constructor.
ServiceType - Interface in com.diffusiondata.gateway.framework: A service type.
setInitialJSONValueForPatchUpdates(String, String) - Method in interface com.diffusiondata.gateway.framework.Publisher: Sets the initial value for a Diffusion JSON topic, to which subsequent patch updates will be applied.
SharedConfig - Interface in com.diffusiondata.gateway.framework: Defines a SharedConfig.
SharedConfigType - Interface in com.diffusiondata.gateway.framework: A sharedConfig type.
shutdown() - Method in interface com.diffusiondata.gateway.framework.DiffusionGatewayFramework.Implementation: Shuts down the framework.
shutdown() - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Shuts down the framework.
SinkHandler<T> - Interface in com.diffusiondata.gateway.framework: The interface that a sink handler must implement.
SinkHandler.SinkServiceProperties - Interface in com.diffusiondata.gateway.framework: The service properties that apply to the sink service.
SinkHandler.SinkServiceProperties.Builder - Interface in com.diffusiondata.gateway.framework: A builder for sink service properties.
SinkHandler.UnsubscriptionReason - Enum in com.diffusiondata.gateway.framework: The reason for an unsubscription from a Diffusion topic.
SourceHandler - Interface in com.diffusiondata.gateway.framework: The base interface for source service handlers.
SourceHandler.SourceServiceProperties - Interface in com.diffusiondata.gateway.framework: The properties that apply to topics created by and published to by the service.
SourceHandler.SourceServiceProperties.Builder - Interface in com.diffusiondata.gateway.framework: A builder for source service properties.
start(GatewayApplication) - Method in interface com.diffusiondata.gateway.framework.DiffusionGatewayFramework.Implementation: Do not use - Use DiffusionGatewayFramework.start(com.diffusiondata.gateway.framework.GatewayApplication).
start(GatewayApplication) - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Called by an application to introduce a gateway framework application implementation and start the framework.
start() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Starts the application.
start() - Method in interface com.diffusiondata.gateway.framework.ServiceHandler: Start the service.
StateHandler - Interface in com.diffusiondata.gateway.framework: State Handler.
StateHandler.Status - Enum in com.diffusiondata.gateway.framework: Indicates the type of status being reported when using the StateHandler.reportStatus(com.diffusiondata.gateway.framework.StateHandler.Status, java.lang.String, java.lang.String) method.
stop() - Method in interface com.diffusiondata.gateway.framework.GatewayApplication: Stops the application.
stop() - Method in interface com.diffusiondata.gateway.framework.ServiceHandler: Stop the service.
StreamingSourceHandler - Interface in com.diffusiondata.gateway.framework: The interface that a streaming source handler must implement.
subscribe() - Method in interface com.diffusiondata.gateway.framework.Subscriber: Request subscription to configured topics in the Diffusion server.
subscribe(String) - Method in interface com.diffusiondata.gateway.framework.Subscriber: Request subscription to passed topics in the Diffusion server.
Subscriber - Interface in com.diffusiondata.gateway.framework: A subscriber to be used to subscribe to or unsubscribe from Diffusion topics.

T

TAG_KEY_EXCEPTION - Static variable in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Key for 'exception' tag.
TAG_KEY_REASON - Static variable in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Key for 'reason' tag.
TAG_KEY_SERVICE - Static variable in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Key for 'service' tag.
TAG_VALUE_PLACEHOLDER - Static variable in interface com.diffusiondata.gateway.framework.GatewayMeterRegistry: Placeholder value for any tag.
TopicProperties - Interface in com.diffusiondata.gateway.framework: Diffusion topic properties.
TopicProperties.PersistencePolicy - Enum in com.diffusiondata.gateway.framework: The persistence policy to be applied to topics created by the service.
topicType(TopicType) - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties.Builder: Sets the topic type.
TopicType - Enum in com.diffusiondata.gateway.framework: Specifies a Diffusion topic type.

U

unsubscribe(String) - Method in interface com.diffusiondata.gateway.framework.Subscriber: Request unsubscription to topics from the Diffusion server.
update(String, T, TopicProperties) - Method in interface com.diffusiondata.gateway.framework.SinkHandler: Called by the framework to publish a new value received from Diffusion to the sink.
updateMode(UpdateMode) - Method in interface com.diffusiondata.gateway.framework.SourceHandler.SourceServiceProperties.Builder: Sets the update mode to be used for topics published to by the service.
UpdateMode - Enum in com.diffusiondata.gateway.framework: The update mode describes the style of updating that should be used when publishing to Diffusion.

V

valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.ServiceHandler.PauseReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.ServiceHandler.ResumeReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.ServiceMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.ServiceState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.SinkHandler.UnsubscriptionReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.StateHandler.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.TopicProperties.PersistencePolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.TopicType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.diffusiondata.gateway.framework.UpdateMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.diffusiondata.gateway.framework.DiffusionGatewayFramework: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.ServiceHandler.PauseReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.ServiceHandler.ResumeReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.ServiceMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.ServiceState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.SinkHandler.UnsubscriptionReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.StateHandler.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.TopicProperties.PersistencePolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.TopicType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.diffusiondata.gateway.framework.UpdateMode: Returns an array containing the constants of this enum type, in the order they are declared.
valueType() - Method in interface com.diffusiondata.gateway.framework.SinkHandler: Class of the value expected by this handler.

W

withDontRetainValue(boolean) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied boolean value to specify whether a topic should not retain its last value.
withPersistencePolicy(TopicProperties.PersistencePolicy) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied PersistencePolicy and other existing properties.
withPublishValuesOnly(boolean) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied boolean value to specify whether a topic should publish only values.
withTimeSeries(boolean) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied boolean value to specify if the topic is time series and other existing properties.
withTimeSeriesRetainedRange(String) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied timeSeriesRetainedRange and other existing properties.
withTimeSeriesSubscriptionRange(String) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied timeSeriesSubscriptionRange and other existing properties.
withTopicType(TopicType) - Method in interface com.diffusiondata.gateway.framework.TopicProperties: Returns a new instance of TopicProperties with the supplied topic type and other existing properties.

A B C D G H I J M N O P R S T U V W