com.diffusiondata.gateway.framework

Interface ServiceType

public interface ServiceType

A service type.

A service type defines a type of service that the application supports. Any number of instances of service of the same type may be instantiated with differing parameters.

An application can define any number of service types, each having its own schema defining the parameters to the service.

An application must define at least one service type, but any number can be defined providing different schemas for service parameters.

Service 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 service type's description.
ServiceMode	getMode() Returns the service mode.
String	getName() Returns the service type name.
String	getSchema() Returns the service type's JSON schema.

Method Detail

getName

String getName()

Returns the service type name.

Every configured service must specify a service type name that identifies the type of service.

Returns:

service type name

getMode

ServiceMode getMode()

Returns the service mode.

Indicates the mode of services of this type.

Returns:

the service mode

getDescription

String getDescription()

Returns the service type's description.

The description defines the service type so that users understand what the service type will do.

Returns:

description of the service type.

getSchema

String getSchema()

Returns the service type's JSON schema.

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

Returns:

schema