Class WebserviceInput

  • 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, WebServiceClientProducerResponseDataListener, BufferedRatInput, RatInput, Serializable

    public class WebserviceInput
    extends AbstractBufferedRatInput
    implements WebServiceClientProducerResponseDataListener
    Uses a webservice for retrieving data from a webservice. Needs to be wrapped in poller.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -client <adams.flow.webservice.WebServiceClient> (property: client)
        The webservice client to use.
        default: com.example.customerservice.flow.CustomersByName
    $Revision: 2086 $
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

    • Constructor Detail

      • WebserviceInput

        public WebserviceInput()
    • 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
      • getDefaultClient

        protected WebServiceClientConsumer getDefaultClient()
        Returns the default client to use.
        the client
      • checkClient

        protected String checkClient​(WebServiceClient value)
        Checks the client.
        value - the client to check
        null if accepted, otherwise error message
      • setClient

        public void setClient​(WebServiceClient value)
        Sets the webservice client to use.
        value - the webservice client to use
      • getClient

        public WebServiceClient getClient()
        Returns the webservice client in use.
        the webservice client in use
      • clientTipText

        public String clientTipText()
        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
      • cleanUp

        public void cleanUp()
        Cleans up data structures, frees up memory.
        Specified by:
        cleanUp in interface adams.core.CleanUpHandler
        cleanUp in class AbstractBufferedRatInput