Package adams.flow.standalone.rats.input

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 <adams.flow.rest.RESTProvider> (property: webService)
    The REST webservice provider to use.
    default: adams.flow.rest.RatsServer -in-interceptor adams.flow.rest.interceptor.incoming.NullGenerator -out-interceptor adams.flow.rest.interceptor.outgoing.NullGenerator -plugin adams.flow.rest.text.RatsTextUpload
    Author:
    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
        Returns:
        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
        Overrides:
        defineOptions in class AbstractBufferedRatInput

      • getDefaultWebService

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

      • setWebService

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

      • getWebService

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

      • webServiceTipText

        public String webServiceTipText()
        Returns the tip text for this property.
        Returns:
        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
        Returns:
        null if successful, otherwise error message