io.apicurio.registry.rest

Interface RulesResource

All Known Subinterfaces:

RegistryService

@Path(value="/rules")
public interface RulesResource

A JAX-RS interface. An implementation of this interface must be provided.

Method Summary

Modifier and Type	Method and Description
void	createGlobalRule(Rule data) Adds a rule to the list of globally configured rules.
void	deleteAllGlobalRules() Deletes all globally configured rules.
void	deleteGlobalRule(RuleType rule) Deletes a single global rule.
Rule	getGlobalRuleConfig(RuleType rule) Returns information about the named globally configured rule.
List<RuleType>	listGlobalRules() Gets a list of all the currently configured global rules (if any).
Rule	updateGlobalRuleConfig(RuleType rule, Rule data) Updates the configuration for a globally configured rule.

Method Detail

getGlobalRuleConfig

@Path(value="/{rule}")
 @GET
 @Produces(value="application/json")
Rule getGlobalRuleConfig(@PathParam(value="rule")
                                                                                           RuleType rule)

Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`)

updateGlobalRuleConfig

@Path(value="/{rule}")
 @PUT
 @Produces(value="application/json")
 @Consumes(value="application/json")
Rule updateGlobalRuleConfig(@PathParam(value="rule")
                                                                                                                                   RuleType rule,
                                                                                                                                   Rule data)

Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`)

deleteGlobalRule

@Path(value="/{rule}")
 @DELETE
void deleteGlobalRule(@PathParam(value="rule")
                                                      RuleType rule)

Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. Default global rules that have been configured via `registry.rules.global` environment variables cannot be deleted. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Default rule with name/type `rule` cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`)

listGlobalRules

@GET
 @Produces(value="application/json")
List<RuleType> listGlobalRules()

Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)

createGlobalRule

@POST
 @Consumes(value="application/json")
void createGlobalRule(Rule data)

Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`)

deleteAllGlobalRules

@DELETE
void deleteAllGlobalRules()

Deletes all globally configured rules. Default global rules that have been configured via `registry.rules.global` environment variables cannot be deleted. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)