Package com.veeva.vault.sdk.api.queue

Interface QueueService

All Superinterfaces:
Service
public interface QueueService extends Service
Provides methods to create and put messages in a queue.

  • Method Details

    • newMessage

      Message newMessage(String queueName)
      Creates a new instance of a Message to be sent on a queue with putMessage(Message), in order to set message attributes and items.
      Parameters:
      queueName - The public name of the queue to put the message into. Must be a valid queue.
      Returns:
      A new instance of a Message

    • newMessage

      Message newMessage(String queueName, List<String> connectionNames)
      Creates a new instance of a Message to be sent on a queue with putMessage(Message), in order to set message attributes and items. Message will only be sent to connections specified
      Parameters:
      queueName - The public name of the queue to put the message into. Must be a valid outbound queue.
      connectionNames - Must be non-null and non-empty and all the connections specified must be associated with the given queue.
      Returns:
      A new instance of a Message

    • putMessage

      PutMessageResponse putMessage(Message message)
      Puts a Message onto a queue specified by newMessage(String). The message will be sent to all connections referenced by the queue.
      Parameters:
      message - Message to send to the queue's connections
      Returns:
      a PutMessageResponse which contains identifiers for the messages and the connections they were sent to, or any encountered errors