Package org.apache.syncope.common.rest.api.service

Interface AnyObjectService

All Superinterfaces:
AnyService<AnyObjectTO>, JAXRSService
All Known Implementing Classes:
AnyObjectServiceImpl
@Path("anyObjects") public interface AnyObjectService extends AnyService<AnyObjectTO>
REST operations for anyObjects.

  • Method Details

    • read

      AnyObjectTO read(String key)
      Description copied from interface: AnyService
      Reads the any object matching the provided key.
      Specified by:
      read in interface AnyService<AnyObjectTO>
      Parameters:
      key - if value looks like a UUID then it is interpreted as key, otherwise as a (user)name
      Returns:
      any object with matching key

    • read

      @GET @Path("byName/{type}/{name}") @Produces({"application/json","application/yaml","application/xml"}) AnyObjectTO read(@NotNull @PathParam("type") @NotNull String type, @NotNull @PathParam("name") @NotNull String name)

    • search

      PagedResult<AnyObjectTO> search(AnyQuery anyQuery)
      Description copied from interface: AnyService
      Returns a paged list of any objects matching the given query.
      Specified by:
      search in interface AnyService<AnyObjectTO>
      Parameters:
      anyQuery - query conditions
      Returns:
      paged list of any objects matching the given query

    • create

      @POST @Produces({"application/json","application/yaml","application/xml"}) @Consumes({"application/json","application/yaml","application/xml"}) Response create(@NotNull @NotNull AnyObjectCR createReq)
      Creates a new any object.
      Parameters:
      createReq - any object create request
      Returns:
      Response object featuring Location header of created any object as well as the any object itself enriched with propagation status information

    • update

      @PATCH @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) @Consumes({"application/json","application/yaml","application/xml"}) Response update(@NotNull @NotNull AnyObjectUR updateReq)
      Updates any object matching the provided key.
      Parameters:
      updateReq - modification to be applied to any object matching the provided key
      Returns:
      Response object featuring the updated any object enriched with propagation status information