Interface ConfigurationEndpoint

  • All Known Implementing Classes:
    ConfigurationEndpointImpl

    @Path("/configuration")
    @Consumes("application/json")
    @Produces("application/json")
    public interface ConfigurationEndpoint
    Contains methods for loading and configuring Windup.
    Author:
    Jesse Sightler
    • Method Detail

      • getGlobalConfiguration

        @GET
        Configuration getGlobalConfiguration()
        Returns the Windup configuration.
      • getConfigurationByProject

        @GET
        @Path("by-project/{projectId}")
        Configuration getConfigurationByProject​(@PathParam("projectId")
                                                long projectId)
        Returns the Windup configuration for a single project.
      • getCustomRulesetPaths

        @GET
        @Path("/{id}/custom-rulesets")
        Set<RulesPath> getCustomRulesetPaths​(@PathParam("id")
                                             long id)
        Returns only rulespath collection for custom registered ruleset paths
        Returns:
      • getCustomLabelsetPaths

        @GET
        @Path("/{id}/custom-labelsets")
        Set<LabelsPath> getCustomLabelsetPaths​(@PathParam("id")
                                               long id)
        Returns only labelspath collection for custom registered ruleset paths
        Returns:
      • saveConfiguration

        @PUT
        @Path("/{id}")
        Configuration saveConfiguration​(@PathParam("id")
                                        long id,
                                        @Valid
                                        @Valid Configuration configuration)
        Persists the given configuration.
      • reloadConfiguration

        @POST
        @Path("/{id}/reload")
        Configuration reloadConfiguration​(@PathParam("id")
                                          long id)