com.diffusiondata.gateway.framework

Interface SharedConfigType

public interface SharedConfigType

A sharedConfig type.

An application that uses sharedConfigs can define one or more sharedConfig types, each having its own schema defining the parameters to the sharedConfig.

Any number of sharedConfig types can be defined providing different schemas for sharedConfig parameters.

SharedConfig types are declared by a GatewayApplication via its getApplicationDetails method.

Author:

DiffusionData Limited

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the sharedConfig type's description.
String	getName() Return the sharedConfig type name.
String	getSchema() Returns the sharedConfig type's JSON schema.

Method Detail

getName

String getName()

Return the sharedConfig type name.

This is the name that any configured sharedConfig must provide in order to specify its parameters.

Returns:

the sharedConfig type name

getDescription

String getDescription()

Returns the sharedConfig type's description.

The description defines the sharedConfig type so that users understand what the sharedConfig type is for.

Returns:

description of the service type.

getSchema

String getSchema()

Returns the sharedConfig type's JSON schema.

The schema defines the format of the application specific parameters that may be configured for a sharedConfig of this type.

Returns:

schema