org.apache.brooklyn.rest.api

Interface ApplicationApi

All Known Implementing Classes:

ApplicationResource

@Path(value="/applications")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface ApplicationApi

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createFromForm(java.lang.String contents)
javax.ws.rs.core.Response	createFromYaml(java.lang.String yaml)
javax.ws.rs.core.Response	createFromYamlWithAppId(java.lang.String yaml, java.lang.String appId)
javax.ws.rs.core.Response	createPoly(byte[] autodetectedInput)
javax.ws.rs.core.Response	delete(java.lang.String application)
java.util.List<EntitySummary>	details(java.lang.String items, boolean includeAllApps, java.lang.String sensors, java.lang.String config, int depth)
java.util.List<EntityDetail>	fetch(java.lang.String items, java.lang.String sensors) Deprecated.
ApplicationSummary	get(java.lang.String application)
java.util.List<EntitySummary>	getDescendants(java.lang.String application, java.lang.String typeRegex)
java.util.Map<java.lang.String,java.lang.Object>	getDescendantsSensor(java.lang.String application, java.lang.String sensor, java.lang.String typeRegex)
java.util.List<ApplicationSummary>	list(java.lang.String typeRegex)

Method Detail

details

@GET
 @Path(value="/details")
java.util.List<EntitySummary> details(@DefaultValue(value="") @QueryParam(value="items")
                                                                    java.lang.String items,
                                                                    @DefaultValue(value="true") @QueryParam(value="includeAllApps")
                                                                    boolean includeAllApps,
                                                                    @DefaultValue(value="") @QueryParam(value="sensors")
                                                                    java.lang.String sensors,
                                                                    @DefaultValue(value="") @QueryParam(value="config")
                                                                    java.lang.String config,
                                                                    @DefaultValue(value="1") @QueryParam(value="depth")
                                                                    int depth)

fetch

@GET
 @Path(value="/fetch")
 @Deprecated
java.util.List<EntityDetail> fetch(@DefaultValue(value="") @QueryParam(value="items")
                                                                            java.lang.String items,
                                                                            @DefaultValue(value="") @QueryParam(value="sensors")
                                                                            java.lang.String sensors)

Deprecated.

list

@GET
java.util.List<ApplicationSummary> list(@DefaultValue(value=".*") @QueryParam(value="typeRegex")
                                             java.lang.String typeRegex)

get

@GET
 @Path(value="/{application}")
ApplicationSummary get(@PathParam(value="application")
                                                           java.lang.String application)

createFromYaml

@POST
 @Consumes(value={"application/x-yaml","text/yaml","text/x-yaml","application/yaml"})
javax.ws.rs.core.Response createFromYaml(java.lang.String yaml)

createFromYamlWithAppId

@PUT
 @Path(value="/{application}")
 @Consumes(value={"application/x-yaml","text/yaml","text/x-yaml","application/yaml"})
javax.ws.rs.core.Response createFromYamlWithAppId(java.lang.String yaml,
                                                                                                                                                                            @PathParam(value="application")
                                                                                                                                                                            java.lang.String appId)

createPoly

@POST
 @Consumes(value={"application/json","application/octet-stream","text/plain"})
javax.ws.rs.core.Response createPoly(byte[] autodetectedInput)

createFromForm

@POST
 @Consumes(value="application/x-www-form-urlencoded")
javax.ws.rs.core.Response createFromForm(java.lang.String contents)

delete

@DELETE
 @Path(value="/{application}")
javax.ws.rs.core.Response delete(@PathParam(value="application")
                                                                        java.lang.String application)

getDescendants

@GET
 @Path(value="/{application}/descendants")
java.util.List<EntitySummary> getDescendants(@PathParam(value="application")
                                                                                             java.lang.String application,
                                                                                             @DefaultValue(value=".*") @QueryParam(value="typeRegex")
                                                                                             java.lang.String typeRegex)

getDescendantsSensor

@GET
 @Path(value="/{application}/descendants/sensor/{sensor}")
java.util.Map<java.lang.String,java.lang.Object> getDescendantsSensor(@PathParam(value="application")
                                                                                                                                      java.lang.String application,
                                                                                                                                      @PathParam(value="sensor")
                                                                                                                                      java.lang.String sensor,
                                                                                                                                      @DefaultValue(value=".*") @QueryParam(value="typeRegex")
                                                                                                                                      java.lang.String typeRegex)