Interface DestinationService<T extends AbstractDestinationModel>

Type Parameters:
T - the type parameter which extends the AbstractDestinationModel type
All Known Implementing Classes:
DefaultDestinationService

public interface DestinationService<T extends AbstractDestinationModel>
Service layer interface for destinations
  • Method Details

    • getDestinationsByChannel

      @Deprecated(since="1905", forRemoval=true) List<T> getDestinationsByChannel(DestinationChannel channel)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find destinations for specific channel
      Parameters:
      channel - the channel of the destination
      Returns:
      List of destinations for the given channel
    • getDestinationsByDestinationTargetId

      List<T> getDestinationsByDestinationTargetId(String destinationTargetId)
      Find destinations for specific destinationTarget
      Parameters:
      destinationTargetId - the id of the DestinationTarget
      Returns:
      List of destinations for the given DestinationTarget
    • getActiveExposedDestinationsByClientId

      List<ExposedDestinationModel> getActiveExposedDestinationsByClientId(String clientId)
      Find the list of active destinations for specific clientId
      Parameters:
      clientId - The clientId of OAuthClientDetails
      Returns:
      a List of Destinations by the ExposedOAuthCredential clientId
    • getActiveExposedDestinationsByChannel

      @Deprecated(since="1905", forRemoval=true) List<ExposedDestinationModel> getActiveExposedDestinationsByChannel(DestinationChannel channel)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find the list of destinations for specific channel
      Parameters:
      channel - The channel assigned to Destinations
      Returns:
      a List of Destinations by the credential
    • getDestinationById

      @Deprecated(since="1905", forRemoval=true) T getDestinationById(String id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 1905, the id attribute of the destination is not unique, therefore, this gets the first item of the destinations for specific id.
      Parameters:
      id - the id of the destination
      Returns:
      The destination for the given id
    • getAllDestinations

      List<T> getAllDestinations()
      Get all destinations
      Returns:
      the list of destinations
    • getActiveExposedDestinationsByDestinationTargetId

      List<ExposedDestinationModel> getActiveExposedDestinationsByDestinationTargetId(String destinationTargetId)
      Get the list of active exposed destinations for a specific destination target
      Parameters:
      destinationTargetId - id of the destination target
      Returns:
      a list of exposed destinations
    • getDestinationByIdAndByDestinationTargetId

      T getDestinationByIdAndByDestinationTargetId(String destinationId, String destinationTargetId)
      Get the destination for a specific destination and a specific destination id
      Parameters:
      destinationId - id of the destination
      destinationTargetId - id of the destination target
      Returns:
      a destination
    • testDestinationUrl

      void testDestinationUrl(AbstractDestinationModel destinationModel) throws DestinationNotFoundException
      Testing the consumed destination url
      Parameters:
      destinationModel - given consumedDestination model or exposedDestination model
      Throws:
      DestinationNotFoundException - will be thrown in case of any exception during testing the consumed destination url
    • getAllConsumedDestinations

      List<ConsumedDestinationModel> getAllConsumedDestinations()
      Get all consumed destinations
      Returns:
      the list of consumed destinations
    • getExposedDestinationsByCredentialId

      List<ExposedDestinationModel> getExposedDestinationsByCredentialId(String credentialId)
      Get all exposed destinations by credential id
      Parameters:
      credentialId - id of the credential
      Returns:
      the list of exposed destinations
    • getAllDestinationsByCredentialId

      default List<T> getAllDestinationsByCredentialId(String credentialId)
      Get all DestinationModels by credential id
      Parameters:
      credentialId - id of AbstractCredentialModel
      Returns:
      list of destinations
    • getDeletableCredentialsByDestinationTargetId

      default Set<AbstractCredentialModel> getDeletableCredentialsByDestinationTargetId(String destinationTargetId)
      Get all credentials that can be deleted A credential can be deleted means it is consumed by one destination or multiple destinations with same destination target
      Parameters:
      destinationTargetId - id of DestinationTargetModel
      Returns:
      set of AbstractCredentialModel