org.apache.brooklyn.rest.api

Interface BundleApi

All Known Implementing Classes:

BundleResource

@Path(value="/catalog/bundles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public interface BundleApi

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createFromArchive(byte[] archive, java.lang.Boolean force)
javax.ws.rs.core.Response	createFromYaml(java.lang.String yaml, java.lang.Boolean forceUpdate)
BundleSummary	detail(java.lang.String symbolicName, java.lang.String version)
TypeDetail	getType(java.lang.String symbolicName, java.lang.String version, java.lang.String typeSymbolicName)
TypeDetail	getTypeExplicitVersion(java.lang.String symbolicName, java.lang.String version, java.lang.String typeSymbolicName, java.lang.String typeVersion)
java.util.List<TypeSummary>	getTypes(java.lang.String symbolicName, java.lang.String version)
java.util.List<BundleSummary>	list(java.lang.String versions, boolean detail)
java.util.List<BundleSummary>	listVersions(java.lang.String symbolicName, boolean detail)
BundleInstallationRestResult	remove(java.lang.String symbolicName, java.lang.String version, java.lang.Boolean force)

Method Detail

list

@GET
java.util.List<BundleSummary> list(@QueryParam(value="versions")
                                        java.lang.String versions,
                                        @QueryParam(value="detail")
                                        boolean detail)

listVersions

@Path(value="/{symbolicName}")
 @GET
java.util.List<BundleSummary> listVersions(@PathParam(value="symbolicName")
                                                                                java.lang.String symbolicName,
                                                                                @QueryParam(value="detail")
                                                                                boolean detail)

detail

@Path(value="/{symbolicName}/{version}")
 @GET
BundleSummary detail(@PathParam(value="symbolicName")
                                                                    java.lang.String symbolicName,
                                                                    @PathParam(value="version")
                                                                    java.lang.String version)

getTypes

@Path(value="/{symbolicName}/{version}/types")
 @GET
java.util.List<TypeSummary> getTypes(@PathParam(value="symbolicName")
                                                                                          java.lang.String symbolicName,
                                                                                          @PathParam(value="version")
                                                                                          java.lang.String version)

getType

@Path(value="/{symbolicName}/{version}/types/{typeSymbolicName}")
 @GET
TypeDetail getType(@PathParam(value="symbolicName")
                                                                                           java.lang.String symbolicName,
                                                                                           @PathParam(value="version")
                                                                                           java.lang.String version,
                                                                                           @PathParam(value="typeSymbolicName")
                                                                                           java.lang.String typeSymbolicName)

getTypeExplicitVersion

@Path(value="/{symbolicName}/{version}/types/{typeSymbolicName}/{typeVersion}")
 @GET
TypeDetail getTypeExplicitVersion(@PathParam(value="symbolicName")
                                                                                                                        java.lang.String symbolicName,
                                                                                                                        @PathParam(value="version")
                                                                                                                        java.lang.String version,
                                                                                                                        @PathParam(value="typeSymbolicName")
                                                                                                                        java.lang.String typeSymbolicName,
                                                                                                                        @PathParam(value="typeVersion")
                                                                                                                        java.lang.String typeVersion)

remove

@Path(value="/{symbolicName}/{version}")
 @DELETE
BundleInstallationRestResult remove(@PathParam(value="symbolicName")
                                                                                      java.lang.String symbolicName,
                                                                                      @PathParam(value="version")
                                                                                      java.lang.String version,
                                                                                      @QueryParam(value="force") @DefaultValue(value="false")
                                                                                      java.lang.Boolean force)

createFromYaml

@POST
 @Consumes(value={"application/json","application/x-yaml","text/yaml","text/x-yaml","application/yaml"})
javax.ws.rs.core.Response createFromYaml(java.lang.String yaml,
                                                                                                                                                        @QueryParam(value="force") @DefaultValue(value="false")
                                                                                                                                                        java.lang.Boolean forceUpdate)

createFromArchive

@POST
 @Consumes(value={"application/x-zip","application/x-jar"})
javax.ws.rs.core.Response createFromArchive(byte[] archive,
                                                                                                              @QueryParam(value="force") @DefaultValue(value="false")
                                                                                                              java.lang.Boolean force)