com.diffusiondata.gateway.framework

Enum DiffusionGatewayFramework

java.lang.Object

java.lang.Enum<DiffusionGatewayFramework>

com.diffusiondata.gateway.framework.DiffusionGatewayFramework

All Implemented Interfaces:

Serializable, Comparable<DiffusionGatewayFramework>

public enum DiffusionGatewayFramework
extends Enum<DiffusionGatewayFramework>

Provides static methods for use with the Diffusion Gateway Framework.

For full details of the use of the framework see Package Guide.

Author:

DiffusionData Limited

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DiffusionGatewayFramework.Implementation Do not use - Use static methods on DiffusionGatewayFramework.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMPLEMENTATION Internal type - do not use.

Method Summary

Modifier and Type	Method and Description
static GatewayFramework	initialize(GatewayApplication application) Called by an application to introduce a gateway framework application implementation.
static GatewayApplication.ApplicationDetails.Builder	newApplicationDetailsBuilder() Factory for an GatewayApplication.ApplicationDetails builder.
static SinkHandler.SinkServiceProperties.Builder	newSinkServicePropertiesBuilder() Factory for builders of SinkHandler.SinkServiceProperties.
static SourceHandler.SourceServiceProperties.Builder	newSourceServicePropertiesBuilder() Factory for builders of SourceHandler.SourceServiceProperties.
static DiffusionGatewayFramework	valueOf(String name) Returns the enum constant of this type with the specified name.
static DiffusionGatewayFramework[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IMPLEMENTATION

public static final DiffusionGatewayFramework IMPLEMENTATION

Internal type - do not use.

Method Detail

values

public static DiffusionGatewayFramework[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DiffusionGatewayFramework c : DiffusionGatewayFramework.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DiffusionGatewayFramework valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

initialize

public static GatewayFramework initialize(GatewayApplication application)
                                   throws ApplicationInitializationException

Called by an application to introduce a gateway framework application implementation.

This may only be called once per JVM.

When this is called the framework will call back on the application to determine its application details and then initialize and start the application.

Parameters:

application - the application

Returns:

a reference to the framework

Throws:

ApplicationInitializationException - if initialization fails

newApplicationDetailsBuilder

public static GatewayApplication.ApplicationDetails.Builder newApplicationDetailsBuilder()

Factory for an GatewayApplication.ApplicationDetails builder.

Returns:

a new application details builder

newSourceServicePropertiesBuilder

public static SourceHandler.SourceServiceProperties.Builder newSourceServicePropertiesBuilder()

Factory for builders of SourceHandler.SourceServiceProperties.

Returns:

a new source service properties builder

newSinkServicePropertiesBuilder

public static SinkHandler.SinkServiceProperties.Builder newSinkServicePropertiesBuilder()

Factory for builders of SinkHandler.SinkServiceProperties.

Returns:

a new sink service properties builder