com.dnastack.bob.rest.api

Interface BeaconResource

@Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public interface BeaconResource

Version:

1.0

Author:

Miroslav Cupak (mirocupak@gmail.com)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, com.dnastack.bob.service.dto.BeaconDto beacon)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, String beaconId)
Collection<com.dnastack.bob.service.dto.BeaconDto>	show(String beaconIds) Shows all the beacons or a specific beacon as determined by a param.
com.dnastack.bob.service.dto.BeaconDto	showBeacon(String beaconId) Shows beacon details.
javax.ws.rs.core.Response	update(javax.ws.rs.core.UriInfo uriInfo, String beaconId, com.dnastack.bob.service.dto.BeaconDto beacon)

Method Detail

create

@POST
javax.ws.rs.core.Response create(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       com.dnastack.bob.service.dto.BeaconDto beacon)

delete

@DELETE
 @Path(value="/{beaconId}")
javax.ws.rs.core.Response delete(@Context
                                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                                     @PathParam(value="beaconId")
                                                                     String beaconId)

show

@GET
Collection<com.dnastack.bob.service.dto.BeaconDto> show(@QueryParam(value="beacon")
                                                             String beaconIds)

Shows all the beacons or a specific beacon as determined by a param.

Parameters:

beaconIds - beacon ID

Returns:

set of beacons

showBeacon

@GET
 @Path(value="/{beaconId}")
com.dnastack.bob.service.dto.BeaconDto showBeacon(@PathParam(value="beaconId")
                                                                                   String beaconId)

Shows beacon details.

Parameters:

beaconId - id of the beacon

Returns:

beacon

update

@PUT
 @Path(value="/{beaconId}")
javax.ws.rs.core.Response update(@Context
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  @PathParam(value="beaconId")
                                                                  String beaconId,
                                                                  com.dnastack.bob.service.dto.BeaconDto beacon)