Interface RealmService

    • Method Detail

      • search

        @GET
        @Produces({"application/json","application/yaml","application/xml"})
        PagedResult<RealmTO> search​(@BeanParam
                                    RealmQuery query)
        Returns a paged list of existing realms matching the given query.
        Parameters:
        query - query conditions
        Returns:
        paged list of existing realms matching the given query
      • create

        @POST
        @Path("{parentPath:.*}")
        @Consumes({"application/json","application/yaml","application/xml"})
        @Produces({"application/json","application/yaml","application/xml"})
        javax.ws.rs.core.Response create​(@NotNull @PathParam("parentPath")
                                         @NotNull String parentPath,
                                         @NotNull
                                         @NotNull RealmTO realmTO)
        Creates a new realm under the given path.
        Parameters:
        parentPath - full path of the parent realm
        realmTO - new realm
        Returns:
        Response object featuring Location header of created realm as well as the realm itself enriched with propagation status information
      • update

        @PUT
        @Path("{fullPath:.*}")
        @Consumes({"application/json","application/yaml","application/xml"})
        @Produces({"application/json","application/yaml","application/xml"})
        javax.ws.rs.core.Response update​(@NotNull
                                         @NotNull RealmTO realmTO)
        Updates the realm under the given path.
        Parameters:
        realmTO - realm to be stored
        Returns:
        Response object featuring the updated realm enriched with propagation status information
      • delete

        @DELETE
        @Path("{fullPath:.*}")
        @Produces({"application/json","application/yaml","application/xml"})
        javax.ws.rs.core.Response delete​(@NotNull @PathParam("fullPath")
                                         @NotNull String fullPath)
        Deletes the realm under the given path.
        Parameters:
        fullPath - realm path
        Returns:
        Response object featuring the deleted realm enriched with propagation status information