Package com.oracle.cloud.spring.queue

Class QueueImpl

java.lang.Object
com.oracle.cloud.spring.queue.QueueImpl
All Implemented Interfaces:
Queue
public class QueueImpl extends Object implements Queue
Implementation for the OCI Queue module.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QueueImpl(com.oracle.bmc.queue.QueueAdminClient queueAdminClient, com.oracle.bmc.queue.QueueClient queueClient)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createQueue(String queueName, String compartmentId, Integer deadLetterQueueDeliveryCount, Integer retentionInSeconds)
    Creates a queue in a compartment.
    com.oracle.bmc.queue.responses.DeleteMessageResponse
    deleteMessage(String queueId, String messageReceipt)
    Delete the message by the receipt from a queue
    com.oracle.bmc.queue.responses.DeleteQueueResponse
    deleteQueue(String queueId)
    Delete the queue by id.
    com.oracle.bmc.queue.responses.GetMessagesResponse
    getMessages(String queueId, Integer visibilityInSeconds, Integer timeoutInSeconds, Integer limit)
    Get/consume messages from a queue.
    com.oracle.bmc.queue.responses.GetQueueResponse
    getQueue(String queueId)
    Get the queue resource.
    com.oracle.bmc.queue.QueueAdminClient
    getQueueAdminClient()
    Direct instance of OCI Java SDK QueueAdminClient.
    com.oracle.bmc.queue.QueueClient
    getQueueClient()
    Direct instance of OCI Java SDK QueueClient.
    com.oracle.bmc.queue.responses.ListQueuesResponse
    listQueues(String queueName, String compartmentId)
    List the queues by name and/or in a compartment.
    com.oracle.bmc.queue.responses.PutMessagesResponse
    putMessages(String queueId, String[] messages)
    Put messages into a queue.
    com.oracle.bmc.queue.responses.UpdateMessagesResponse
    updateMessages(String queueId, String[] messageReceipts, Integer visibilityInSeconds)
    Update the messages by their receipt in a queue.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • QueueImpl

      public QueueImpl(com.oracle.bmc.queue.QueueAdminClient queueAdminClient, com.oracle.bmc.queue.QueueClient queueClient)

  • Method Details

    • getQueueAdminClient

      public com.oracle.bmc.queue.QueueAdminClient getQueueAdminClient()
      Direct instance of OCI Java SDK QueueAdminClient.
      Specified by:
      getQueueAdminClient in interface Queue
      Returns:
      QueueAdminClient

    • getQueueClient

      public com.oracle.bmc.queue.QueueClient getQueueClient()
      Direct instance of OCI Java SDK QueueClient.
      Specified by:
      getQueueClient in interface Queue
      Returns:
      QueueClient

    • putMessages

      public com.oracle.bmc.queue.responses.PutMessagesResponse putMessages(String queueId, String[] messages)
      Put messages into a queue.
      Specified by:
      putMessages in interface Queue
      Parameters:
      queueId - OCID of the queue
      messages - list of messages
      Returns:
      PutMessagesResponse

    • getMessages

      public com.oracle.bmc.queue.responses.GetMessagesResponse getMessages(String queueId, Integer visibilityInSeconds, Integer timeoutInSeconds, Integer limit)
      Get/consume messages from a queue.
      Specified by:
      getMessages in interface Queue
      Parameters:
      queueId - OCID of the queue
      visibilityInSeconds - Messages will be hidden and won't be consumable by other consumers for this time
      timeoutInSeconds - Timeout for the request
      limit - The maximum number of messages returned
      Returns:
      GetMessagesResponse

    • updateMessages

      public com.oracle.bmc.queue.responses.UpdateMessagesResponse updateMessages(String queueId, String[] messageReceipts, Integer visibilityInSeconds)
      Update the messages by their receipt in a queue.
      Specified by:
      updateMessages in interface Queue
      Parameters:
      queueId - OCID of the queue
      messageReceipts - List of message receipts to be updated
      visibilityInSeconds - Messages will be hidden and won't be consumable by other consumers for this time
      Returns:
      UpdateMessagesResponse

    • deleteMessage

      public com.oracle.bmc.queue.responses.DeleteMessageResponse deleteMessage(String queueId, String messageReceipt)
      Delete the message by the receipt from a queue
      Specified by:
      deleteMessage in interface Queue
      Parameters:
      queueId - OCID of the queue
      messageReceipt - The receipt of the message to be deleted
      Returns:
      DeleteMessageResponse

    • createQueue

      public String createQueue(String queueName, String compartmentId, Integer deadLetterQueueDeliveryCount, Integer retentionInSeconds)
      Creates a queue in a compartment.
      Specified by:
      createQueue in interface Queue
      Parameters:
      queueName - Name of the queue to be created
      compartmentId - Compartment OCID where the Queue needs to be created
      deadLetterQueueDeliveryCount - The number of times a message is delivered before its moved to the dead letter queue
      retentionInSeconds - The time a message remains in the queue before its deleted by the service if it is not deleted by a consumer
      Returns:
      String OCID of the queue

    • getQueue

      public com.oracle.bmc.queue.responses.GetQueueResponse getQueue(String queueId)
      Get the queue resource.
      Specified by:
      getQueue in interface Queue
      Parameters:
      queueId - OCID of the queue
      Returns:
      GetQueueResponse

    • listQueues

      public com.oracle.bmc.queue.responses.ListQueuesResponse listQueues(String queueName, String compartmentId)
      List the queues by name and/or in a compartment.
      Specified by:
      listQueues in interface Queue
      Parameters:
      queueName - Name of the queue to list them
      compartmentId - Compartment OCID where to list the Queues
      Returns:
      ListQueuesResponse

    • deleteQueue

      public com.oracle.bmc.queue.responses.DeleteQueueResponse deleteQueue(String queueId)
      Delete the queue by id.
      Specified by:
      deleteQueue in interface Queue
      Parameters:
      queueId - OCID of the queue
      Returns:
      DeleteQueueResponse