org.apache.brooklyn.rest.api

Interface EntityConfigApi

All Known Implementing Classes:

EntityConfigResource

@Path(value="/applications/{application}/entities/{entity}/config")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface EntityConfigApi

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	batchConfigRead(java.lang.String application, java.lang.String entityToken, java.lang.Boolean raw)
java.lang.Object	get(java.lang.String application, java.lang.String entityToken, java.lang.String configKeyName, java.lang.Boolean raw)
java.lang.String	getPlain(java.lang.String application, java.lang.String entityToken, java.lang.String configKeyName, java.lang.Boolean raw)
java.util.List<ConfigSummary>	list(java.lang.String application, java.lang.String entityToken)
void	set(java.lang.String application, java.lang.String entityToken, java.lang.String configName, java.lang.Boolean recurse, java.lang.Object newValue)
void	setFromMap(java.lang.String application, java.lang.String entityToken, java.lang.Boolean recurse, java.util.Map newValues)

Method Detail

list

@GET
java.util.List<ConfigSummary> list(@PathParam(value="application")
                                        java.lang.String application,
                                        @PathParam(value="entity")
                                        java.lang.String entityToken)

batchConfigRead

@GET
 @Path(value="/current-state")
java.util.Map<java.lang.String,java.lang.Object> batchConfigRead(@PathParam(value="application")
                                                                                                     java.lang.String application,
                                                                                                     @PathParam(value="entity")
                                                                                                     java.lang.String entityToken,
                                                                                                     @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                                     java.lang.Boolean raw)

get

@GET
 @Path(value="/{config}")
 @Produces(value="application/json")
java.lang.Object get(@PathParam(value="application")
                                                                                         java.lang.String application,
                                                                                         @PathParam(value="entity")
                                                                                         java.lang.String entityToken,
                                                                                         @PathParam(value="config")
                                                                                         java.lang.String configKeyName,
                                                                                         @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                         java.lang.Boolean raw)

getPlain

@GET
 @Path(value="/{config}")
 @Produces(value="text/plain;qs=0.9")
java.lang.String getPlain(@PathParam(value="application")
                                                                                               java.lang.String application,
                                                                                               @PathParam(value="entity")
                                                                                               java.lang.String entityToken,
                                                                                               @PathParam(value="config")
                                                                                               java.lang.String configKeyName,
                                                                                               @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                               java.lang.Boolean raw)

setFromMap

@POST
void setFromMap(@PathParam(value="application")
                      java.lang.String application,
                      @PathParam(value="entity")
                      java.lang.String entityToken,
                      @QueryParam(value="recurse") @DefaultValue(value="false")
                      java.lang.Boolean recurse,
                      java.util.Map newValues)

set

@POST
 @Path(value="/{config}")
void set(@PathParam(value="application")
                                         java.lang.String application,
                                         @PathParam(value="entity")
                                         java.lang.String entityToken,
                                         @PathParam(value="config")
                                         java.lang.String configName,
                                         @QueryParam(value="recurse") @DefaultValue(value="false")
                                         java.lang.Boolean recurse,
                                         java.lang.Object newValue)