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

Interface WAConfigService

  • All Superinterfaces:
    org.apache.syncope.common.rest.api.service.JAXRSService
    @Path("wa/config")
public interface WAConfigService
extends org.apache.syncope.common.rest.api.service.JAXRSService
    REST operations for WA Configuration.

    • 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(@NotNull String schema)
      Deletes the configuration parameter with matching schema.
      org.apache.syncope.common.lib.Attr get​(@NotNull String schema)
      Returns configuration parameter with matching schema.
      List<org.apache.syncope.common.lib.Attr> list()  
      void pushToWA​(@NotNull WAConfigService.PushSubject subject, List<String> services)
      Push to WA according to the provided parameters.
      void set​(@NotNull org.apache.syncope.common.lib.Attr value)
      Creates / updates the configuration parameter with the given schema.

    • Method Detail

      • list

        @GET
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
List<org.apache.syncope.common.lib.Attr> list()

      • get

        @GET
@Path("{schema}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
org.apache.syncope.common.lib.Attr get​(@NotNull @PathParam("schema")
                                       @NotNull String schema)
        Returns configuration parameter with matching schema.
        Parameters:
        schema - identifier of configuration to be read
        Returns:
        configuration parameter with matching schema

      • set

        @PUT
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
@Path("{schema}")
void set​(@NotNull
         @NotNull org.apache.syncope.common.lib.Attr value)
        Creates / updates the configuration parameter with the given schema.
        Parameters:
        value - parameter value

      • delete

        @DELETE
@Path("{schema}")
@Produces({"application/json","application/yaml","application/xml"})
void delete​(@NotNull @PathParam("schema")
            @NotNull String schema)
        Deletes the configuration parameter with matching schema.
        Parameters:
        schema - configuration parameter schema

      • pushToWA

        @POST
@Path("push/{subject}")
@Produces({"application/json","application/yaml","application/xml"})
void pushToWA​(@NotNull @PathParam("subject")
              @NotNull WAConfigService.PushSubject subject,
              @QueryParam("service")
              List<String> services)
        Push to WA according to the provided parameters.
        Parameters:
        subject - what is to be triggered for refresh on WA
        services - WA instances to trigger; all if none specified