com.diffusiondata.gateway.framework

Interface GatewayFramework

public interface GatewayFramework

Gateway Framework.

A GatewayApplication introduces itself to the framework using the DiffusionGatewayFramework.initialize method which returns a reference of this type that the application can use initiate the initial connection to Diffusion.

Author:

DiffusionData Limited

Method Summary

Modifier and Type	Method and Description
void	connect() Connect to Diffusion and register the application.
String	getConfiguration() Returns the full configuration for the declared gateway application.
ScheduledExecutorService	getExecutorService() Returns instance of ScheduledExecutorService initialized by the framework using the thread pool configured in configuration file.
boolean	isMetricsEnabled() Returns a boolean value to represent whether metrics is enabled in the configuration, by application user.
void	shutdown() Shuts down the framework.

Method Detail

connect

void connect()
      throws ApplicationConfigurationException,
             DiffusionSecurityException,
             DiffusionClientException,
             ApplicationInitializationException

Connect to Diffusion and register the application.

Throws:

ApplicationConfigurationException - if the passed configuration or configuration obtained from the server has been found to be invalid or incompatible with the application;

DiffusionSecurityException - if the application principal does not have sufficient permissions to perform the operation;

DiffusionClientException - if some other exception has been returned from the Diffusion server via the Diffusion Client API. The cause will provide more detail.

ApplicationInitializationException - if connect fails for any other reason.

getConfiguration

String getConfiguration()

Returns the full configuration for the declared gateway application.

This returns a full representation of the whole configuration which can be saved and used when restarting the application to override any configuration saved at the server.

This will only be available after the framework has connected to the Diffusion server.

The configuration is updated whenever a service is added, updated or removed. This method returns the current state of the configuration.

Returns:

full configuration for the application, or null if called before a successful connection to the Diffusion server

shutdown

void shutdown()

Shuts down the framework. Closes session with Diffusion and terminates any running threads or processes.

getExecutorService

ScheduledExecutorService getExecutorService()

Returns instance of ScheduledExecutorService initialized by the framework using the thread pool configured in configuration file. This can be used to schedule processing in separate threads if required by service handlers.

Returns:

ScheduledExecutorService initialized by framework.

isMetricsEnabled

boolean isMetricsEnabled()

Returns a boolean value to represent whether metrics is enabled in the configuration, by application user.

This can be used to check whether components required to expose metrics should be instantiated.

By default, exposing metrics is disabled in gateway application.

Returns:

a boolean value to represent whether metrics is enabled.