org.apache.brooklyn.rest.api

Interface TypeApi

All Known Implementing Classes:

TypeResource

@Path(value="/catalog/types")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public interface TypeApi

Method Summary

Modifier and Type	Method and Description
TypeDetail	detail(java.lang.String symbolicName, java.lang.String version)
javax.ws.rs.core.Response	icon(java.lang.String symbolicName, java.lang.String version)
java.util.List<TypeSummary>	list(java.lang.String supertype, java.lang.String versions, java.lang.String regex, java.lang.String fragment)
java.util.List<TypeSummary>	listVersions(java.lang.String nameOrAlias)

Method Detail

list

@GET
java.util.List<TypeSummary> list(@QueryParam(value="supertype")
                                      java.lang.String supertype,
                                      @QueryParam(value="versions")
                                      java.lang.String versions,
                                      @QueryParam(value="regex") @DefaultValue(value="")
                                      java.lang.String regex,
                                      @QueryParam(value="fragment") @DefaultValue(value="")
                                      java.lang.String fragment)

listVersions

@Path(value="/{nameOrAlias}")
 @GET
java.util.List<TypeSummary> listVersions(@PathParam(value="nameOrAlias")
                                                                             java.lang.String nameOrAlias)

detail

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

icon

@Path(value="/{symbolicName}/{version}/icon")
 @GET
 @Produces(value="application/image")
javax.ws.rs.core.Response icon(@PathParam(value="symbolicName")
                                                                                                                         java.lang.String symbolicName,
                                                                                                                         @PathParam(value="version")
                                                                                                                         java.lang.String version)