@Path(value="/catalog")
@Consumes(value="application/json")
@Produces(value="application/json")
public interface CatalogApi
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
create(java.lang.String yaml,
boolean forceUpdate)
Deprecated.
since 0.11.0 use
#createFromYaml(String) instead |
javax.ws.rs.core.Response |
createFromArchive(byte[] archive,
boolean detail,
boolean forceUpdate) |
javax.ws.rs.core.Response |
createFromUpload(byte[] item,
boolean forceUpdate) |
javax.ws.rs.core.Response |
createFromYaml(java.lang.String yaml,
boolean forceUpdate) |
void |
deleteApplication(java.lang.String symbolicName,
java.lang.String version)
Deprecated.
since 1.0.0 delete the bundle via DELETE /catalog/bundles/xxx
|
void |
deleteEnricher(java.lang.String enricherId,
java.lang.String version)
Deprecated.
since 1.0.0 delete the bundle via DELETE /catalog/bundles/xxx
|
void |
deleteEntity(java.lang.String symbolicName,
java.lang.String version)
Deprecated.
since 1.0.0 delete the bundle via DELETE /catalog/bundles/xxx
|
void |
deleteLocation(java.lang.String locationId,
java.lang.String version)
Deprecated.
since 1.0.0 delete the bundle via DELETE /catalog/bundles/xxx
|
void |
deletePolicy(java.lang.String policyId,
java.lang.String version)
Deprecated.
since 1.0.0 delete the bundle via DELETE /catalog/bundles/xxx
|
CatalogEntitySummary |
getApplication(java.lang.String symbolicName,
java.lang.String version)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
CatalogEnricherSummary |
getEnricher(java.lang.String enricherId,
java.lang.String version)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
CatalogEntitySummary |
getEntity(java.lang.String symbolicName,
java.lang.String version)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
javax.ws.rs.core.Response |
getIcon(java.lang.String itemId,
java.lang.String version) |
CatalogItemSummary |
getLocation(java.lang.String locationId,
java.lang.String version)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
CatalogPolicySummary |
getPolicy(java.lang.String policyId,
java.lang.String version)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
java.util.List<CatalogItemSummary> |
listApplications(java.lang.String regex,
java.lang.String fragment,
boolean includeAllVersions)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
java.util.List<CatalogEnricherSummary> |
listEnrichers(java.lang.String regex,
java.lang.String fragment,
boolean includeAllVersions)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
java.util.List<CatalogEntitySummary> |
listEntities(java.lang.String regex,
java.lang.String fragment,
boolean includeAllVersions)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
java.util.List<CatalogLocationSummary> |
listLocations(java.lang.String regex,
java.lang.String fragment,
boolean includeAllVersions)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
java.util.List<CatalogPolicySummary> |
listPolicies(java.lang.String regex,
java.lang.String fragment,
boolean includeAllVersions)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...
|
void |
setDeprecated(java.lang.String itemId,
boolean deprecated)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...;
deprecation/disabling needs to be done in the bundle, and we might support deprecating/disabling bundles
|
void |
setDisabled(java.lang.String itemId,
boolean disabled)
Deprecated.
since 1.0.0 use /catalog/bundles and /catalog/types?supertype=...;
deprecation/disabling needs to be done in the bundle, and we might support deprecating/disabling bundles
|
@Deprecated @Consumes(value="application/json-deprecated") @POST javax.ws.rs.core.Response create(java.lang.String yaml, @QueryParam(value="forceUpdate") @DefaultValue(value="false") boolean forceUpdate)
#createFromYaml(String)
instead@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="forceUpdate") @DefaultValue(value="false") boolean forceUpdate)
@POST @Consumes(value={"application/x-zip","application/x-jar"}) javax.ws.rs.core.Response createFromArchive(byte[] archive, @QueryParam(value="detail") @DefaultValue(value="false") boolean detail, @QueryParam(value="forceUpdate") @DefaultValue(value="false") boolean forceUpdate)
@POST @Consumes javax.ws.rs.core.Response createFromUpload(byte[] item, @QueryParam(value="forceUpdate") @DefaultValue(value="false") boolean forceUpdate)
@Deprecated @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
java.lang.Exception
@Deprecated @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
java.lang.Exception
@Deprecated @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
java.lang.Exception
@Deprecated @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
java.lang.Exception
@Deprecated @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)
@Deprecated @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)
@Deprecated @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
java.lang.Exception
@Deprecated @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
java.lang.Exception
@Deprecated @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)
@Deprecated @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
java.lang.Exception
@Deprecated @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)
@Deprecated @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
java.lang.Exception
@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)
@Deprecated @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)
@Deprecated @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)
@Deprecated @GET @Path(value="/enrichers") java.util.List<CatalogEnricherSummary> listEnrichers(@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)
@Deprecated @GET @Path(value="/enrichers/{enricherId}/{version}") CatalogEnricherSummary getEnricher(@PathParam(value="enricherId") java.lang.String enricherId, @PathParam(value="version") java.lang.String version) throws java.lang.Exception
java.lang.Exception
@Deprecated @DELETE @Path(value="/enrichers/{enricherId}/{version}") void deleteEnricher(@PathParam(value="enricherId") java.lang.String enricherId, @PathParam(value="version") java.lang.String version) throws java.lang.Exception
java.lang.Exception