at.ac.tuwien.dsg.cloud.elise.master.RESTService

Interface EliseRepository

@Path(value="/")
 @Configurable
public interface EliseRepository

The APIs enables to read/write/search unit instances in ELISE. These APIs only query information in the database without any execution for collecting real information. For the information collecting, please use communication service APIs.

Author:

Duc-Hung Le

Method Summary

Modifier and Type	Method and Description
void	deleteArtifact(Artifact artifact) To delete the artifact
void	deleteProvider(String uniqueID) Delete information of provider from DB
void	deleteServiceTemplate(String uniqueID) Delete the service template from DB
void	deleteUnitInstance(String uniqueID) Delete unit instance by ID
Set<String>	getUnitCategory() Return a list of supported service unit types.
String	health() To check the availability of this RESTful API.
Set<UnitInstance>	query(at.ac.tuwien.dsg.cloud.salsa.messaging.model.Elise.EliseQuery query) Filter unit instance by an ID
Set<Provider>	readAllProviders() Get a list of all available provider
Set<ServiceTemplate>	readAllServiceTemplates() Get all the list of service template
Set<UnitInstance>	readAllUnitInstances(String name, String category, String state, String hostedOnID) Get the unit instance base on some basic metadata, managed by ELISE.
Set<Artifact>	readArtifact(String name, String version, String type) Read the artifact information.
Provider	readProvider(String uniqueID) Read information about provider
ServiceTemplate	readServiceTemplate(String uniqueID) To read service template
UnitInstance	readUnitInstance(String uniqueID) Read an unit instance from the database and all its extensions
Set<UnitInstance>	readUnitInstanceByExtension(List<ExtensibleModel> extra) Get the list of instance with external model info, e.g.
Artifact	saveArtifact(Artifact artifact) To create new or update artifacts
String	saveProvider(Provider provider) To save a provider
void	saveRelationshipConnectTo(ConnectToRelationshipInstance connectToRela) To save a relationship between two instances
void	saveRelationshipHostOn(HostOnRelationshipInstance hostOnRela) To save a relationship between two instances
ServiceTemplate	saveServiceTemplate(ServiceTemplate serviceTemplate) Create new or update a service template
UnitInstance	saveUnitInstance(UnitInstance unitInstance) Add new or update an unit instance.

Method Detail

readUnitInstance

@GET
 @Path(value="/instance/{uniqueID}")
 @Produces(value="application/json")
UnitInstance readUnitInstance(@PathParam(value="uniqueID")
                                                                                                             String uniqueID)

Read an unit instance from the database and all its extensions

Parameters:

uniqueID - The uuid of the unit

Returns:

An unit instance object

readAllUnitInstances

@GET
 @Path(value="/instance/")
 @Produces(value="application/json")
Set<UnitInstance> readAllUnitInstances(@QueryParam(value="name")
                                                                                                            String name,
                                                                                                            @QueryParam(value="category")
                                                                                                            String category,
                                                                                                            @QueryParam(value="state")
                                                                                                            String state,
                                                                                                            @QueryParam(value="hostedOnID")
                                                                                                            String hostedOnID)

Get the unit instance base on some basic metadata, managed by ELISE. The metadata can be null if not available.

Parameters:

name - Name of the service instance, e.g. LoadBalancerUnit

category - The category, e.g. docker

state - The state, e.g. to get all "error" instance

hostedOnID - To find all instances which is hosted by an instance

Returns:

A list of unit instances.

readUnitInstanceByExtension

@POST
 @Path(value="/instance/querymeta")
 @Produces(value="application/json")
Set<UnitInstance> readUnitInstanceByExtension(List<ExtensibleModel> extra)

Get the list of instance with external model info, e.g. location at xyz The matching of extended info is similar search.

Parameters:

extra - The template of extra information

Returns:

A list of unit instances with similar extra info.

saveUnitInstance

@POST
 @Path(value="/instance")
 @Consumes(value="application/json")
 @Produces(value="application/json")
UnitInstance saveUnitInstance(UnitInstance unitInstance)

Add new or update an unit instance.

Parameters:

unitInstance - The instance to be saved

Returns:

The object of the instance include DB id, or null if failed

saveRelationshipHostOn

@POST
 @Path(value="/instance/relationship/hoston")
 @Consumes(value="application/json")
void saveRelationshipHostOn(HostOnRelationshipInstance hostOnRela)

To save a relationship between two instances

Parameters:

hostOnRela - The relationship type

saveRelationshipConnectTo

@POST
 @Path(value="/instance/relationship/connectto")
 @Consumes(value="application/json")
void saveRelationshipConnectTo(ConnectToRelationshipInstance connectToRela)

To save a relationship between two instances

Parameters:

connectToRela - The relationship type

deleteUnitInstance

@DELETE
 @Path(value="/instance/{uniqueID}")
void deleteUnitInstance(@PathParam(value="uniqueID")
                                                                     String uniqueID)

Delete unit instance by ID

Parameters:

uniqueID - The ID of the unit

query

@POST
 @Path(value="/instance/query")
 @Consumes(value="application/json")
Set<UnitInstance> query(at.ac.tuwien.dsg.cloud.salsa.messaging.model.Elise.EliseQuery query)

Filter unit instance by an ID

Parameters:

query - A filter to query the result. This functions will be replated by the readUnitInstanceByExtension function

Returns:

A set of unit instancess

readProvider

@GET
 @Path(value="/provider/{uniqueID}")
 @Produces(value="application/json")
Provider readProvider(@PathParam(value="uniqueID")
                                                                                                     String uniqueID)

Read information about provider

Parameters:

uniqueID - the uuid of provider

Returns:

An provider object

readAllProviders

@GET
 @Path(value="/provider")
 @Produces(value="application/json")
Set<Provider> readAllProviders()

Get a list of all available provider

Returns:

A list of providers

saveProvider

@POST
 @Path(value="/provider")
 @Consumes(value="application/json")
String saveProvider(Provider provider)

To save a provider

Parameters:

provider - the information

Returns:

the assigned id of provider

deleteProvider

@DELETE
 @Path(value="/provider/{uniqueID}")
 @Produces(value="application/json")
void deleteProvider(@PathParam(value="uniqueID")
                                                                                                      String uniqueID)

Delete information of provider from DB

Parameters:

uniqueID - The id of the provider to be deleted

readServiceTemplate

@GET
 @Path(value="/servicetemplate/{uniqueID}")
 @Produces(value="application/json")
ServiceTemplate readServiceTemplate(@PathParam(value="uniqueID")
                                                                                                                          String uniqueID)

To read service template

Parameters:

uniqueID - The uuid of the template

Returns:

an service template object

readAllServiceTemplates

@GET
 @Path(value="/servicetemplate")
 @Produces(value="application/json")
Set<ServiceTemplate> readAllServiceTemplates()

Get all the list of service template

Returns:

A set of service templates

saveServiceTemplate

@POST
 @Path(value="/servicetemplate")
 @Consumes(value="application/json")
 @Produces(value="application/json")
ServiceTemplate saveServiceTemplate(ServiceTemplate serviceTemplate)

Create new or update a service template

Parameters:

serviceTemplate - the service template to be saved

Returns:

The object with ID from the DB

deleteServiceTemplate

@DELETE
 @Path(value="/servicetemplate/{uniqueID}")
void deleteServiceTemplate(@PathParam(value="uniqueID")
                                                                               String uniqueID)

Delete the service template from DB

Parameters:

uniqueID - The uuid of the template

readArtifact

@GET
 @Path(value="/artifact/")
 @Produces(value="application/json")
Set<Artifact> readArtifact(@QueryParam(value="name")
                                                                                                String name,
                                                                                                @QueryParam(value="version")
                                                                                                String version,
                                                                                                @QueryParam(value="type")
                                                                                                String type)

Read the artifact information. The parameters are optional.

Parameters:

name - E.g. haproxy.sh

version - E.g. v1.0

type - E.g. shellscript

Returns:

The list of the artifacts

saveArtifact

@POST
 @Path(value="/artifact")
 @Consumes(value="application/json")
 @Produces(value="application/json")
Artifact saveArtifact(Artifact artifact)

To create new or update artifacts

Parameters:

artifact - the information

Returns:

the object from DB

deleteArtifact

@DELETE
 @Path(value="/artifact")
 @Consumes(value="application/json")
void deleteArtifact(Artifact artifact)

To delete the artifact

Parameters:

artifact - The artifact object

getUnitCategory

@GET
 @Path(value="/categories")
Set<String> getUnitCategory()

Return a list of supported service unit types. This information is static in SALS

Returns:

A list of categories of service units

health

@GET
 @Path(value="/health")
String health()

To check the availability of this RESTful API. Use for testing.

Returns:

A quick message