brooklyn.rest.resources
[Java] Class CatalogResource

java.lang.Object
  brooklyn.rest.resources.AbstractBrooklynRestResource
      brooklyn.rest.resources.CatalogResource

@Path("/v1/catalog")
@Apidoc("Catalog")
@Produces(MediaType.APPLICATION_JSON)
public class CatalogResource
extends AbstractBrooklynRestResource

create

@POST
@ApiOperation(value = "Add a new entity or policy type by uploading a Groovy script", responseClass = "String")
public Response create(@ApiParam(name = "groovyCode", value = "Groovy code for the entity or policy", required = true) @Valid java.lang.String groovyCode)

createFromMultipart

@POST
@ApiOperation(value = "Add a new entity or policy type to the catalog by uploading a Groovy script from browser using multipart/form-data",
        responseClass = "String")
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response createFromMultipart(@ApiParam(name = "groovyCode", value = "multipart/form-data file input field") @FormDataParam("groovyCode") java.io.InputStream uploadedInputStream, @FormDataParam("groovyCode") FormDataContentDisposition fileDetail)

getEntity

@SuppressWarnings("unchecked")
@GET
@Path("/entities/{entityId}")
@ApiOperation(value = "Fetch an entity's definition from the catalog", responseClass = "CatalogEntitySummary", multiValueResponse = true)
@ApiErrors(value = {
        @ApiError(code = 404, reason = "Entity not found")
    })
public CatalogEntitySummary getEntity(@ApiParam(name = "entityId", value = "The ID of the entity or template to retrieve", required = true) @PathParam("entityId") java.lang.String entityId)

getPolicy

@GET
@Path("/policies/{policyId}")
@ApiOperation(value = "Fetch a policy's definition from the catalog", responseClass = "CatalogItemSummary", multiValueResponse = true)
@ApiErrors(value = {
        @ApiError(code = 404, reason = "Entity not found")
    })
public CatalogItemSummary getPolicy(@ApiParam(name = "policyId", value = "The ID of the policy to retrieve", required = true) @PathParam("policyId") java.lang.String policyId)

listApplications

@GET
@Path("/applications")
@ApiOperation(value = "Fetch a list of application templates optionally matching a query", responseClass = "CatalogItemSummary", multiValueResponse = true)
public java.util.List listApplications(@ApiParam(name = "regex", value = "Regular expression to search for") @QueryParam("regex") @DefaultValue("") java.lang.String regex, @ApiParam(name = "fragment", value = "Substring case-insensitive to search for") @QueryParam("fragment") @DefaultValue("") java.lang.String fragment)

listEntities

@GET
@Path("/entities")
@ApiOperation(value = "List available entity types optionally matching a query", responseClass = "CatalogItemSummary", multiValueResponse = true)
public java.util.List listEntities(@ApiParam(name = "regex", value = "Regular expression to search for") @QueryParam("regex") @DefaultValue("") java.lang.String regex, @ApiParam(name = "fragment", value = "Substring case-insensitive to search for") @QueryParam("fragment") @DefaultValue("") java.lang.String fragment)

listPolicies

@GET
@Path("/policies")
@ApiOperation(value = "List available policies optionally matching a query", responseClass = "CatalogItemSummary", multiValueResponse = true)
public java.util.List listPolicies(@ApiParam(name = "regex", value = "Regular expression to search for") @QueryParam("regex") @DefaultValue("") java.lang.String regex, @ApiParam(name = "fragment", value = "Substring case-insensitive to search for") @QueryParam("fragment") @DefaultValue("") java.lang.String fragment)

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.