org.lappsgrid.api

Interface WebService

All Known Subinterfaces:

DataSource, ProcessingService

public interface WebService

Interface for all services deployed to the LAPPS grid.

A service accepts a JSON object as input and produces a JSON object as output. The JSON objects must use the LAPPS Interchange Format (LIF) with the discriminator set to one of the LAPPS URI.

See http://vocab.lappsgrid.org/discriminators.html for a list of all URI used by LAPPS services.

Author:

Keith Suderman

Method Summary

Methods

Modifier and Type	Method and Description
String	execute(String input) Entry point for a Lappsgrid service.
String	getMetadata() Returns a JSON string containing metadata describing the service.

Method Detail

execute

String execute(String input)

Entry point for a Lappsgrid service.

Each service on the Lappsgrid will accept org.lappsgrid.serialization.Data object and return a Data object with a org.lappsgrid.serialization.lif.Container payload.

Errors and exceptions the occur during processing should be wrapped in a Data object with the discriminator set to http://vocab.lappsgrid.org/ns/error

See org.lappsgrid.serialization.lif.Container

Parameters:

input - A JSON string representing a Data object

Returns:

A JSON string containing a Data object with a Container payload.

getMetadata

String getMetadata()

Returns a JSON string containing metadata describing the service. The JSON must conform to the json-schema at http://vocab.lappsgrid.org/schema/service-schema.json (processing services) or http://vocab.lappsgrid.org/schema/datasource-schema.json (datasources).