Class RESTTextReception

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, BufferedRatInput, RatInput, Serializable

    public class RESTTextReception
    extends AbstractBufferedRatInput
    Uses a REST webservice for receiving text. Internally polls whether data has arrived.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -max-buffer <int> (property: maxBuffer)
        The maximum number of items to buffer.
        default: 65535
        minimum: 1
    -web-service <> (property: webService)
        The REST webservice provider to use.
        default: -in-interceptor -out-interceptor -plugin
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_WebService

        protected RESTProvider m_WebService
        the webservice to run.
    • Constructor Detail

      • RESTTextReception

        public RESTTextReception()
    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        a description suitable for displaying in the gui
      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        defineOptions in class AbstractBufferedRatInput
      • getDefaultWebService

        protected RESTProvider getDefaultWebService()
        Returns the default webservice provider to use.
        the default provider
      • setWebService

        public void setWebService​(RESTProvider value)
        Sets the webservice provider to use.
        value - the provider
      • getWebService

        public RESTProvider getWebService()
        Returns the webservice provider in use.
        the provider
      • webServiceTipText

        public String webServiceTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • doReceive

        protected String doReceive()
        Performs the actual reception of data.
        Specified by:
        doReceive in class AbstractRatInput
        null if successful, otherwise error message