Package org.gbif.api.service.registry

Interface EndpointService

All Known Subinterfaces:
DatasetService, InstallationService, NetworkEntityService<T>, NetworkService, NodeService, OrganizationService
public interface EndpointService
Service provides a set of operations on Endpoint.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    addEndpoint(@NotNull UUID targetEntityKey, @NotNull @Valid Endpoint endpoint)
    Add a new Endpoint to a target entity.
    void
    deleteEndpoint(@NotNull UUID targetEntityKey, int endpointKey)
    Delete an existing Endpoint from a target entity by endpoint key.
    List<Endpoint>
    listEndpoints(@NotNull UUID targetEntityKey)
    List all endpoints of a target entity.

  • Method Details

    • addEndpoint

      int addEndpoint(@NotNull @NotNull UUID targetEntityKey, @NotNull @Valid @NotNull @Valid Endpoint endpoint)
      Add a new Endpoint to a target entity.
      Parameters:
      targetEntityKey - key of target entity
      endpoint - Endpoint to add
      Returns:
      key of Endpoint added

    • deleteEndpoint

      void deleteEndpoint(@NotNull @NotNull UUID targetEntityKey, int endpointKey)
      Delete an existing Endpoint from a target entity by endpoint key.
      Parameters:
      targetEntityKey - key of target entity
      endpointKey - Endpoint key to delete

    • listEndpoints

      List<Endpoint> listEndpoints(@NotNull @NotNull UUID targetEntityKey)
      List all endpoints of a target entity.
      Parameters:
      targetEntityKey - key of target entity
      Returns:
      list of endpoints that belong to the entity