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

Interface WAClientAppService

  • All Superinterfaces:
    org.apache.syncope.common.rest.api.service.JAXRSService
    @Path("wa/clientApps")
public interface WAClientAppService
extends org.apache.syncope.common.rest.api.service.JAXRSService
    REST operations for WA to read client applications.

    • 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
      List<org.apache.syncope.common.lib.wa.WAClientApp> list()
      Returns a list of all client applications available.
      org.apache.syncope.common.lib.wa.WAClientApp read​(@NotNull Long clientAppId, org.apache.syncope.common.lib.types.ClientAppType type)
      Returns client application with matching type and clientAppId, if found.
      org.apache.syncope.common.lib.wa.WAClientApp read​(@NotNull String name, org.apache.syncope.common.lib.types.ClientAppType type)
      Returns client application with matching type and name, if found.

    • Method Detail

      • list

        @GET
@Produces("application/json")
List<org.apache.syncope.common.lib.wa.WAClientApp> list()
        Returns a list of all client applications available.
        Returns:
        list of all client applications.

      • read

        @GET
@Path("{clientAppId}")
@Produces("application/json")
org.apache.syncope.common.lib.wa.WAClientApp read​(@NotNull @PathParam("clientAppId")
                                                  @NotNull Long clientAppId,
                                                  @QueryParam("type")
                                                  org.apache.syncope.common.lib.types.ClientAppType type)
        Returns client application with matching type and clientAppId, if found.
        Parameters:
        clientAppId - registered client application ID to be read
        type - client application type
        Returns:
        client application with matching type and clientAppId

      • read

        @GET
@Path("byName/{name}")
@Produces("application/json")
org.apache.syncope.common.lib.wa.WAClientApp read​(@NotNull @PathParam("name")
                                                  @NotNull String name,
                                                  @QueryParam("type")
                                                  org.apache.syncope.common.lib.types.ClientAppType type)
        Returns client application with matching type and name, if found.
        Parameters:
        name - registered client application name to be read
        type - client application type
        Returns:
        client application with matching type and name