org.apache.brooklyn.rest.api

Interface LocationApi

All Known Implementing Classes:

LocationResource

@Path(value="/locations")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface LocationApi

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(LocationSpec locationSpec) Deprecated. since 0.7.0 use CatalogApi#create(String) with a location definition
void	delete(java.lang.String locationId) Deprecated. since 0.7.0; use CatalogApi.deleteLocation(String, String)
LocationSummary	get(java.lang.String locationId, java.lang.String fullConfig) WARNING: behaviour will change in a future release; this will only return location instances.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getLocatedLocations()
java.util.List<LocationSummary>	list() Deprecated. since 0.7.0; use CatalogApi.listLocations(java.lang.String, java.lang.String, boolean)

Method Detail

list

@GET
 @Deprecated
java.util.List<LocationSummary> list()

Deprecated. since 0.7.0; use CatalogApi.listLocations(java.lang.String, java.lang.String, boolean)

getLocatedLocations

@GET
 @Path(value="/usage/LocatedLocations")
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getLocatedLocations()

get

@GET
 @Path(value="/{locationId}")
LocationSummary get(@PathParam(value="locationId")
                                                       java.lang.String locationId,
                                                       @DefaultValue(value="false") @QueryParam(value="full")
                                                       java.lang.String fullConfig)

WARNING: behaviour will change in a future release; this will only return location instances. See CatalogApi.getLocation(String, String) for retrieving location definitions.

create

@POST
 @Deprecated
javax.ws.rs.core.Response create(LocationSpec locationSpec)

Deprecated. since 0.7.0 use CatalogApi#create(String) with a location definition

delete

@DELETE
 @Path(value="/{locationId}")
 @Deprecated
void delete(@PathParam(value="locationId")
                                                               java.lang.String locationId)

Deprecated. since 0.7.0; use CatalogApi.deleteLocation(String, String)