Package org.apache.camel.component.azure.storage.queue

Class QueueConfiguration

java.lang.Object
org.apache.camel.component.azure.storage.queue.QueueConfiguration
All Implemented Interfaces:
Cloneable
@UriParams public class QueueConfiguration extends Object implements Cloneable

  • Constructor Details

    • QueueConfiguration

      public QueueConfiguration()

  • Method Details

    • getAccountName

      public String getAccountName()
      Azure account name to be used for authentication with azure queue services

    • setAccountName

      public void setAccountName(String accountName)

    • getCredentials

      public com.azure.storage.common.StorageSharedKeyCredential getCredentials()
      StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information

    • setCredentials

      public void setCredentials(com.azure.storage.common.StorageSharedKeyCredential credentials)

    • getServiceClient

      public com.azure.storage.queue.QueueServiceClient getServiceClient()
      Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account.

    • setServiceClient

      public void setServiceClient(com.azure.storage.queue.QueueServiceClient serviceClient)

    • getQueueName

      public String getQueueName()
      The queue resource name

    • setQueueName

      public void setQueueName(String queueName)

    • getAccessKey

      public String getAccessKey()
      Access key for the associated azure account name to be used for authentication with azure queue services

    • setAccessKey

      public void setAccessKey(String accessKey)

    • getTimeToLive

      public Duration getTimeToLive()
      How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: `PnDTnHnMn.nS.`, e.g: "PT20.345S" -- parses as "20.345 seconds", P2D" -- parses as "2 days" However, in case you are using EndpointDsl/ComponentDsl, you can do something like `Duration.ofSeconds()` since these Java APIs are typesafe.

    • setTimeToLive

      public void setTimeToLive(Duration timeToLive)

    • getVisibilityTimeout

      public Duration getVisibilityTimeout()
      The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: `PnDTnHnMn.nS.`, e.g: "PT20.345S" -- parses as "20.345 seconds", P2D" -- parses as "2 days" However, in case you are using EndpointDsl/ComponentDsl, you can do something like `Duration.ofSeconds()` since these Java APIs are typesafe.

    • setVisibilityTimeout

      public void setVisibilityTimeout(Duration visibilityTimeout)

    • getOperation

      public QueueOperationDefinition getOperation()
      Queue service operation hint to the producer

    • setOperation

      public void setOperation(QueueOperationDefinition operation)

    • isCreateQueue

      public boolean isCreateQueue()
      When is set to `true`, the queue will be automatically created when sending messages to the queue.

    • setCreateQueue

      public void setCreateQueue(boolean createQueue)

    • getMaxMessages

      public Integer getMaxMessages()
      Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.

    • setMaxMessages

      public void setMaxMessages(Integer maxMessages)

    • getTimeout

      public Duration getTimeout()
      An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown.

    • setTimeout

      public void setTimeout(Duration timeout)

    • getMessageId

      public String getMessageId()
      The ID of the message to be deleted or updated.

    • setMessageId

      public void setMessageId(String messageId)

    • getPopReceipt

      public String getPopReceipt()
      Unique identifier that must match for the message to be deleted or updated.

    • setPopReceipt

      public void setPopReceipt(String popReceipt)

    • getCredentialType

      public CredentialType getCredentialType()

    • setCredentialType

      public void setCredentialType(CredentialType credentialType)
      Determines the credential strategy to adopt

    • copy

      public QueueConfiguration copy()