Package com.thingworx.queueproviders

Interface IQueueProvider

All Known Implementing Classes:
QueueProvider
@ThingworxExtensionApiClass(since={10,0}) public interface IQueueProvider

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IQueueProvider.IQueueEntryPublisher
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    QUEUE_NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    initializeQueue(String queueName, ConfigurationTable queueConfig)
    Perform necessary actions to prepare queue for future writes/reads.

  • Field Details

  • Method Details

    • initializeQueue

      @ThingworxExtensionApiMethod(since={10,0}) void initializeQueue(String queueName, ConfigurationTable queueConfig) throws Exception
      Perform necessary actions to prepare queue for future writes/reads. Could be actions such as creating new queue or validation of existing queue access, etc. Will throw an exception on initialization failure.
      Parameters:
      queueName - queue name (if queue not declared, will throw an exception)
      queueConfig - queue configuration
      Throws:
      Exception