org.apache.brooklyn.rest.api

Interface AdjunctApi

All Known Implementing Classes:

AdjunctResource

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

Method Summary

Modifier and Type	Method and Description
AdjunctDetail	addAdjunct(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctRegisteredTypeName, java.util.Map<java.lang.String,java.lang.String> config)
java.util.Map<java.lang.String,java.lang.Object>	batchConfigRead(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctToken)
javax.ws.rs.core.Response	destroy(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctId)
AdjunctDetail	get(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctId)
java.lang.String	getConfig(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctToken, java.lang.String configKeyName)
javax.ws.rs.core.Response	getIcon(java.lang.String applicationId, java.lang.String entityId, java.lang.String adjunctToken)
Status	getStatus(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctId)
java.util.List<AdjunctSummary>	list(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctType)
java.util.List<ConfigSummary>	listConfig(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctToken)
java.util.List<TaskSummary>	listTasks(java.lang.String applicationId, java.lang.String entityId, java.lang.String adjunctToken, int limit, java.lang.Boolean recurse)
javax.ws.rs.core.Response	setConfig(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctToken, java.lang.String configKeyName, java.lang.Object value)
javax.ws.rs.core.Response	start(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctId)
javax.ws.rs.core.Response	stop(java.lang.String application, java.lang.String entityToken, java.lang.String adjunctId)

Method Detail

list

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

addAdjunct

@POST
AdjunctDetail addAdjunct(@PathParam(value="application")
                               java.lang.String application,
                               @PathParam(value="entity")
                               java.lang.String entityToken,
                               @QueryParam(value="type")
                               java.lang.String adjunctRegisteredTypeName,
                               java.util.Map<java.lang.String,java.lang.String> config)

get

@GET
 @Path(value="/{adjunct}")
AdjunctDetail get(@PathParam(value="application")
                                                  java.lang.String application,
                                                  @PathParam(value="entity")
                                                  java.lang.String entityToken,
                                                  @PathParam(value="adjunct")
                                                  java.lang.String adjunctId)

getStatus

@GET
 @Path(value="/{adjunct}/status")
Status getStatus(@PathParam(value="application")
                                                        java.lang.String application,
                                                        @PathParam(value="entity")
                                                        java.lang.String entityToken,
                                                        @PathParam(value="adjunct")
                                                        java.lang.String adjunctId)

start

@POST
 @Path(value="/{adjunct}/start")
javax.ws.rs.core.Response start(@PathParam(value="application")
                                                                       java.lang.String application,
                                                                       @PathParam(value="entity")
                                                                       java.lang.String entityToken,
                                                                       @PathParam(value="adjunct")
                                                                       java.lang.String adjunctId)

stop

@POST
 @Path(value="/{adjunct}/stop")
javax.ws.rs.core.Response stop(@PathParam(value="application")
                                                                     java.lang.String application,
                                                                     @PathParam(value="entity")
                                                                     java.lang.String entityToken,
                                                                     @PathParam(value="adjunct")
                                                                     java.lang.String adjunctId)

destroy

@DELETE
 @Path(value="/{adjunct}")
javax.ws.rs.core.Response destroy(@PathParam(value="application")
                                                                     java.lang.String application,
                                                                     @PathParam(value="entity")
                                                                     java.lang.String entityToken,
                                                                     @PathParam(value="adjunct")
                                                                     java.lang.String adjunctId)

listConfig

@GET
 @Path(value="/{adjunct}/config")
java.util.List<ConfigSummary> listConfig(@PathParam(value="application")
                                                                                java.lang.String application,
                                                                                @PathParam(value="entity")
                                                                                java.lang.String entityToken,
                                                                                @PathParam(value="adjunct")
                                                                                java.lang.String adjunctToken)

batchConfigRead

@GET
 @Path(value="/{adjunct}/config-current")
java.util.Map<java.lang.String,java.lang.Object> batchConfigRead(@PathParam(value="application")
                                                                                                                java.lang.String application,
                                                                                                                @PathParam(value="entity")
                                                                                                                java.lang.String entityToken,
                                                                                                                @PathParam(value="adjunct")
                                                                                                                java.lang.String adjunctToken)

getConfig

@GET
 @Path(value="/{adjunct}/config/{config}")
java.lang.String getConfig(@PathParam(value="application")
                                                                           java.lang.String application,
                                                                           @PathParam(value="entity")
                                                                           java.lang.String entityToken,
                                                                           @PathParam(value="adjunct")
                                                                           java.lang.String adjunctToken,
                                                                           @PathParam(value="config")
                                                                           java.lang.String configKeyName)

setConfig

@POST
 @Path(value="/{adjunct}/config/{config}")
 @Consumes(value="*/*")
javax.ws.rs.core.Response setConfig(@PathParam(value="application")
                                                                                                             java.lang.String application,
                                                                                                             @PathParam(value="entity")
                                                                                                             java.lang.String entityToken,
                                                                                                             @PathParam(value="adjunct")
                                                                                                             java.lang.String adjunctToken,
                                                                                                             @PathParam(value="config")
                                                                                                             java.lang.String configKeyName,
                                                                                                             java.lang.Object value)

listTasks

@GET
 @Path(value="/{adjunct}/activities")
java.util.List<TaskSummary> listTasks(@PathParam(value="application")
                                                                                 java.lang.String applicationId,
                                                                                 @PathParam(value="entity")
                                                                                 java.lang.String entityId,
                                                                                 @PathParam(value="adjunct")
                                                                                 java.lang.String adjunctToken,
                                                                                 @QueryParam(value="limit") @DefaultValue(value="200")
                                                                                 int limit,
                                                                                 @QueryParam(value="recurse") @DefaultValue(value="false")
                                                                                 java.lang.Boolean recurse)

getIcon

@GET
 @Path(value="/{adjunct}/icon")
javax.ws.rs.core.Response getIcon(@PathParam(value="application")
                                                                       java.lang.String applicationId,
                                                                       @PathParam(value="entity")
                                                                       java.lang.String entityId,
                                                                       @PathParam(value="adjunct")
                                                                       java.lang.String adjunctToken)