Interface AdminResource


  • @Path("/apis/registry/v2/admin")
    public interface AdminResource
    A JAX-RS interface. An implementation of this interface must be provided.
    • Method Detail

      • listGlobalRules

        @Path("/rules")
        @GET
        @Produces("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

        @Path("/rules")
        @POST
        @Consumes("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

        @Path("/rules")
        @DELETE
        void deleteAllGlobalRules()
        Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)
      • getGlobalRuleConfig

        @Path("/rules/{rule}")
        @GET
        @Produces("application/json")
        Rule getGlobalRuleConfig​(@PathParam("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("/rules/{rule}")
        @PUT
        @Produces("application/json")
        @Consumes("application/json")
        Rule updateGlobalRuleConfig​(@PathParam("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("/rules/{rule}")
        @DELETE
        void deleteGlobalRule​(@PathParam("rule")
                              RuleType rule)
        Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. 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`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`)
      • listLogConfigurations

        @Path("/loggers")
        @GET
        @Produces("application/json")
        List<NamedLogConfiguration> listLogConfigurations()
        List all of the configured logging levels. These override the default logging configuration.
      • getLogConfiguration

        @Path("/loggers/{logger}")
        @GET
        @Produces("application/json")
        NamedLogConfiguration getLogConfiguration​(@PathParam("logger")
                                                  String logger)
        Returns the configured logger configuration for the provided logger name, if no logger configuration is persisted it will return the current default log configuration in the system.
      • setLogConfiguration

        @Path("/loggers/{logger}")
        @PUT
        @Produces("application/json")
        @Consumes("application/json")
        NamedLogConfiguration setLogConfiguration​(@PathParam("logger")
                                                  String logger,
                                                  LogConfiguration data)
        Configures the logger referenced by the provided logger name with the given configuration.
      • removeLogConfiguration

        @Path("/loggers/{logger}")
        @DELETE
        @Produces("application/json")
        NamedLogConfiguration removeLogConfiguration​(@PathParam("logger")
                                                     String logger)
        Removes the configured logger configuration (if any) for the given logger.
      • exportData

        @Path("/export")
        @GET
        @Produces("application/zip")
        javax.ws.rs.core.Response exportData​(@QueryParam("forBrowser")
                                             Boolean forBrowser)
        Exports registry data as a ZIP archive.
      • importData

        @Path("/import")
        @POST
        @Consumes("application/zip")
        void importData​(InputStream data)
        Imports registry data that was previously exported using the `/admin/export` operation.
      • getRoleMapping

        @Path("/roleMappings/{principalId}")
        @GET
        @Produces("application/json")
        RoleMapping getRoleMapping​(@PathParam("principalId")
                                   String principalId)
        Gets the details of a single role mapping (by principalId). This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`)
      • updateRoleMapping

        @Path("/roleMappings/{principalId}")
        @PUT
        @Consumes("application/json")
        void updateRoleMapping​(@PathParam("principalId")
                               String principalId,
                               UpdateRole data)
        Updates a single role mapping for one user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`)
      • deleteRoleMapping

        @Path("/roleMappings/{principalId}")
        @DELETE
        void deleteRoleMapping​(@PathParam("principalId")
                               String principalId)
        Deletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`)
      • listRoleMappings

        @Path("/roleMappings")
        @GET
        @Produces("application/json")
        List<RoleMapping> listRoleMappings()
        Gets a list of all role mappings configured in the registry (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)
      • createRoleMapping

        @Path("/roleMappings")
        @POST
        @Consumes("application/json")
        void createRoleMapping​(RoleMapping data)
        Creates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)