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

Interface DomainService

All Superinterfaces:
Serializable
@Path("domains") public interface DomainService extends Serializable
REST operations for Self Keymaster's domains.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    adjustPoolSize(@NotNull String key, int poolMaxActive, int poolMinIdle)
    Adjusts the connection pool to the domain database.
    void
    changeAdminPassword(@NotNull String key, String password, org.apache.syncope.common.lib.types.CipherAlgorithm cipherAlgorithm)
    Change admin's password for the given domain.
    jakarta.ws.rs.core.Response
    create(org.apache.syncope.common.keymaster.client.api.model.Domain domain)
    Creates a new domain.
    void
    delete(@NotNull String key)
    Deletes the domain matching the provided key.
    void
    deployed(@NotNull String key)
    Notify that the given domain is deployed.
    List<org.apache.syncope.common.keymaster.client.api.model.Domain>
    list()
    Returns the list of defined domains.
    org.apache.syncope.common.keymaster.client.api.model.Domain
    read(@NotNull String key)
    Returns the domain matching the given key.

  • Method Details

    • list

      @GET @Produces("application/json") List<org.apache.syncope.common.keymaster.client.api.model.Domain> list()
      Returns the list of defined domains.
      Returns:
      list of defined domains

    • read

      @GET @Path("{key}") @Produces("application/json") org.apache.syncope.common.keymaster.client.api.model.Domain read(@NotNull @PathParam("key") @NotNull String key)
      Returns the domain matching the given key.
      Parameters:
      key - key of the domain to be read
      Returns:
      domain matching the given key

    • create

      @POST @Consumes("application/json") @Produces("application/json") jakarta.ws.rs.core.Response create(org.apache.syncope.common.keymaster.client.api.model.Domain domain)
      Creates a new domain.
      Parameters:
      domain - domain to be created
      Returns:
      Response object featuring Location header of created domain

    • deployed

      @POST @Path("{key}/deployed") @Produces("application/json") void deployed(@NotNull @PathParam("key") @NotNull String key)
      Notify that the given domain is deployed.
      Parameters:
      key - key of domain to be updated

    • changeAdminPassword

      @POST @Path("{key}/changeAdminPassword") @Produces("application/json") void changeAdminPassword(@NotNull @PathParam("key") @NotNull String key, @QueryParam("password") String password, @QueryParam("cipherAlgorithm") org.apache.syncope.common.lib.types.CipherAlgorithm cipherAlgorithm)
      Change admin's password for the given domain.
      Parameters:
      key - key of domain to be updated
      password - encoded password value
      cipherAlgorithm - password cipher algorithm

    • adjustPoolSize

      @POST @Path("{key}/adjustPoolSize") @Produces("application/json") void adjustPoolSize(@NotNull @PathParam("key") @NotNull String key, @QueryParam("poolMaxActive") int poolMaxActive, @QueryParam("poolMinIdle") int poolMinIdle)
      Adjusts the connection pool to the domain database.
      Parameters:
      key - key of domain to be updated
      poolMaxActive - database pool max size
      poolMinIdle - database pool max size

    • delete

      @DELETE @Path("{key}") @Produces("application/json") void delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes the domain matching the provided key.
      Parameters:
      key - key of domain to be deleted