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

Interface SRARouteService

All Superinterfaces:
org.apache.syncope.common.rest.api.service.JAXRSService
@Path("sraRoutes") public interface SRARouteService extends org.apache.syncope.common.rest.api.service.JAXRSService
REST operations for SRA routes.

  • Field Summary

    Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

    CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    create(@NotNull org.apache.syncope.common.lib.to.SRARouteTO routeTO)
    Creates a new route.
    void
    delete(@NotNull String key)
    Deletes route with matching key.
    List<org.apache.syncope.common.lib.to.SRARouteTO>
    list()
    Returns a list of all existing routes.
    void
    pushToSRA()
    Push all routes to SRA.
    org.apache.syncope.common.lib.to.SRARouteTO
    read(@NotNull String key)
    Returns route with matching key.
    void
    update(@NotNull org.apache.syncope.common.lib.to.SRARouteTO routeTO)
    Updates route with matching key.

  • Method Details

    • list

      @GET @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.SRARouteTO> list()
      Returns a list of all existing routes.
      Returns:
      paged list of existing routes matching the given query

    • create

      @POST @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response create(@NotNull @NotNull org.apache.syncope.common.lib.to.SRARouteTO routeTO)
      Creates a new route.
      Parameters:
      routeTO - route to be created
      Returns:
      Response object featuring Location header of created route

    • read

      @GET @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.SRARouteTO read(@NotNull @PathParam("key") @NotNull String key)
      Returns route with matching key.
      Parameters:
      key - key of route to be read
      Returns:
      route with matching key

    • update

      @PUT @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull org.apache.syncope.common.lib.to.SRARouteTO routeTO)
      Updates route with matching key.
      Parameters:
      routeTO - route to be stored

    • delete

      @DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes route with matching key.
      Parameters:
      key - route key

    • pushToSRA

      @POST @Path("push") @Produces({"application/json","application/yaml","application/xml"}) void pushToSRA()
      Push all routes to SRA.