CatalogApi (Apache Brooklyn)

All Known Implementing Classes:: CatalogResource

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

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`create(java.lang.String yaml)`
`void`	`deleteApplication(java.lang.String symbolicName, java.lang.String version)`
`void`	`deleteEntity_0_7_0(java.lang.String entityId)` Deprecated. since 0.7.0 use `deleteEntity(String, String)`
`void`	`deleteEntity(java.lang.String symbolicName, java.lang.String version)`
`void`	`deleteLocation(java.lang.String locationId, java.lang.String version)`
`void`	`deletePolicy(java.lang.String policyId, java.lang.String version)`
`CatalogEntitySummary`	`getApplication_0_7_0(java.lang.String applicationId)` Deprecated. since 0.7.0 use `getEntity(String, String)`
`CatalogEntitySummary`	`getApplication(java.lang.String symbolicName, java.lang.String version)`
`CatalogEntitySummary`	`getEntity_0_7_0(java.lang.String entityId)` Deprecated. since 0.7.0 use `getEntity(String, String)`
`CatalogEntitySummary`	`getEntity(java.lang.String symbolicName, java.lang.String version)`
`javax.ws.rs.core.Response`	`getIcon_0_7_0(java.lang.String itemId)` Deprecated. since 0.7.0 use `getIcon(String, String)`
`javax.ws.rs.core.Response`	`getIcon(java.lang.String itemId, java.lang.String version)`
`CatalogItemSummary`	`getLocation_0_7_0(java.lang.String locationId)` Deprecated. since 0.7.0 use `getLocation(String, String)`
`CatalogItemSummary`	`getLocation(java.lang.String locationId, java.lang.String version)`
`CatalogItemSummary`	`getPolicy_0_7_0(java.lang.String policyId)` Deprecated. since 0.7.0 use `getPolicy(String, String)`
`CatalogPolicySummary`	`getPolicy(java.lang.String policyId, java.lang.String version)`
`java.util.List<CatalogItemSummary>`	`listApplications(java.lang.String regex, java.lang.String fragment, boolean includeAllVersions)`
`java.util.List<CatalogEntitySummary>`	`listEntities(java.lang.String regex, java.lang.String fragment, boolean includeAllVersions)`
`java.util.List<CatalogLocationSummary>`	`listLocations(java.lang.String regex, java.lang.String fragment, boolean includeAllVersions)`
`java.util.List<CatalogPolicySummary>`	`listPolicies(java.lang.String regex, java.lang.String fragment, boolean includeAllVersions)`
`javax.ws.rs.core.Response`	`resetXml(java.lang.String xml, boolean ignoreErrors)`
`void`	`setDeprecated(java.lang.String itemId, boolean deprecated)`
`void`	`setDeprecatedLegacy(java.lang.String itemId, boolean deprecated)` Deprecated. since 0.8.0; use "/entities/{itemId}/deprecated" with payload of true/false
`void`	`setDisabled(java.lang.String itemId, boolean disabled)`

Method Detail

create

@Consumes
@POST
javax.ws.rs.core.Response create(java.lang.String yaml)

resetXml

@POST
@Consumes(value="application/xml")
@Path(value="/reset")
javax.ws.rs.core.Response resetXml(java.lang.String xml,
                                                    @QueryParam(value="ignoreErrors")@DefaultValue(value="false")
                                                    boolean ignoreErrors)

deleteEntity_0_7_0

@Deprecated
@DELETE
@Path(value="/entities/{entityId}")
void deleteEntity_0_7_0(@PathParam(value="entityId")
                                             java.lang.String entityId)
                        throws java.lang.Exception

Deprecated. since 0.7.0 use deleteEntity(String, String)

Throws:: java.lang.Exception

deleteApplication

@DELETE
@Path(value="/applications/{symbolicName}/{version}")
void deleteApplication(@PathParam(value="symbolicName")
                                 java.lang.String symbolicName,
                                 @PathParam(value="version")
                                 java.lang.String version)
                       throws java.lang.Exception

Throws:: java.lang.Exception

deleteEntity

@DELETE
@Path(value="/entities/{symbolicName}/{version}")
void deleteEntity(@PathParam(value="symbolicName")
                            java.lang.String symbolicName,
                            @PathParam(value="version")
                            java.lang.String version)
                  throws java.lang.Exception

Throws:: java.lang.Exception

deletePolicy

@DELETE
@Path(value="/policies/{policyId}/{version}")
void deletePolicy(@PathParam(value="policyId")
                            java.lang.String policyId,
                            @PathParam(value="version")
                            java.lang.String version)
                  throws java.lang.Exception

Throws:: java.lang.Exception

deleteLocation

@DELETE
@Path(value="/locations/{locationId}/{version}")
void deleteLocation(@PathParam(value="locationId")
                              java.lang.String locationId,
                              @PathParam(value="version")
                              java.lang.String version)
                    throws java.lang.Exception

Throws:: java.lang.Exception

listEntities

@GET
@Path(value="/entities")
java.util.List<CatalogEntitySummary> listEntities(@QueryParam(value="regex")@DefaultValue(value="")
                                                         java.lang.String regex,
                                                         @QueryParam(value="fragment")@DefaultValue(value="")
                                                         java.lang.String fragment,
                                                         @QueryParam(value="allVersions")@DefaultValue(value="false")
                                                         boolean includeAllVersions)

listApplications

@GET
@Path(value="/applications")
java.util.List<CatalogItemSummary> listApplications(@QueryParam(value="regex")@DefaultValue(value="")
                                                           java.lang.String regex,
                                                           @QueryParam(value="fragment")@DefaultValue(value="")
                                                           java.lang.String fragment,
                                                           @QueryParam(value="allVersions")@DefaultValue(value="false")
                                                           boolean includeAllVersions)

getEntity_0_7_0

@Deprecated
@GET
@Path(value="/entities/{entityId}")
CatalogEntitySummary getEntity_0_7_0(@PathParam(value="entityId")
                                                       java.lang.String entityId)
                                     throws java.lang.Exception

Deprecated. since 0.7.0 use getEntity(String, String)

Throws:: java.lang.Exception

getEntity

@GET
@Path(value="/entities/{symbolicName}/{version}")
CatalogEntitySummary getEntity(@PathParam(value="symbolicName")
                                      java.lang.String symbolicName,
                                      @PathParam(value="version")
                                      java.lang.String version)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getApplication_0_7_0

@Deprecated
@GET
@Path(value="/applications/{applicationId}")
CatalogEntitySummary getApplication_0_7_0(@PathParam(value="applicationId")
                                                            java.lang.String applicationId)
                                          throws java.lang.Exception

Deprecated. since 0.7.0 use getEntity(String, String)

Throws:: java.lang.Exception

getApplication

@GET
@Path(value="/applications/{symbolicName}/{version}")
CatalogEntitySummary getApplication(@PathParam(value="symbolicName")
                                           java.lang.String symbolicName,
                                           @PathParam(value="version")
                                           java.lang.String version)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

listPolicies

@GET
@Path(value="/policies")
java.util.List<CatalogPolicySummary> listPolicies(@QueryParam(value="regex")@DefaultValue(value="")
                                                         java.lang.String regex,
                                                         @QueryParam(value="fragment")@DefaultValue(value="")
                                                         java.lang.String fragment,
                                                         @QueryParam(value="allVersions")@DefaultValue(value="false")
                                                         boolean includeAllVersions)

getPolicy_0_7_0

@Deprecated
@GET
@Path(value="/policies/{policyId}")
CatalogItemSummary getPolicy_0_7_0(@PathParam(value="policyId")
                                                     java.lang.String policyId)
                                   throws java.lang.Exception

Deprecated. since 0.7.0 use getPolicy(String, String)

Throws:: java.lang.Exception

getPolicy

@GET
@Path(value="/policies/{policyId}/{version}")
CatalogPolicySummary getPolicy(@PathParam(value="policyId")
                                      java.lang.String policyId,
                                      @PathParam(value="version")
                                      java.lang.String version)
                               throws java.lang.Exception

Throws:: java.lang.Exception

listLocations

@GET
@Path(value="/locations")
java.util.List<CatalogLocationSummary> listLocations(@QueryParam(value="regex")@DefaultValue(value="")
                                                            java.lang.String regex,
                                                            @QueryParam(value="fragment")@DefaultValue(value="")
                                                            java.lang.String fragment,
                                                            @QueryParam(value="allVersions")@DefaultValue(value="false")
                                                            boolean includeAllVersions)

getLocation_0_7_0

@Deprecated
@GET
@Path(value="/locations/{locationId}")
CatalogItemSummary getLocation_0_7_0(@PathParam(value="locationId")
                                                       java.lang.String locationId)
                                     throws java.lang.Exception

Deprecated. since 0.7.0 use getLocation(String, String)

Throws:: java.lang.Exception

getLocation

@GET
@Path(value="/locations/{locationId}/{version}")
CatalogItemSummary getLocation(@PathParam(value="locationId")
                                      java.lang.String locationId,
                                      @PathParam(value="version")
                                      java.lang.String version)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getIcon_0_7_0

@Deprecated
@GET
@Path(value="/icon/{itemId}")
@Produces(value="application/image")
javax.ws.rs.core.Response getIcon_0_7_0(@PathParam(value="itemId")@DefaultValue(value="")
                                                                   java.lang.String itemId)

Deprecated. since 0.7.0 use getIcon(String, String)

getIcon

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

setDeprecatedLegacy

@Deprecated
@POST
@Path(value="/entities/{itemId}/deprecated/{deprecated}")
void setDeprecatedLegacy(@PathParam(value="itemId")
                                            java.lang.String itemId,
                                            @PathParam(value="deprecated")
                                            boolean deprecated)

Deprecated. since 0.8.0; use "/entities/{itemId}/deprecated" with payload of true/false

setDeprecated

@POST
@Consumes(value={"application/json","application/octet-stream","text/plain"})
@Path(value="/entities/{itemId}/deprecated")
void setDeprecated(@PathParam(value="itemId")
                                    java.lang.String itemId,
                                    boolean deprecated)

setDisabled

@POST
@Consumes(value={"application/json","application/octet-stream","text/plain"})
@Path(value="/entities/{itemId}/disabled")
void setDisabled(@PathParam(value="itemId")
                                  java.lang.String itemId,
                                  boolean disabled)

Interface CatalogApi