Package adams.flow.webservice

Class SpectralTransformServiceWS

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.flow.core.FlowContextHandler, adams.flow.webservice.WebServiceProvider, Serializable
    public class SpectralTransformServiceWS
extends adams.flow.webservice.AbstractWebServiceProvider
    Webservice for Spectral.
    Version:
    $Revision: 2095 $
    Author:
    Fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apache.cxf.jaxws.EndpointImpl m_Endpoint
      end point for the web service
      protected SpectralTransformService m_Implementation
      the webservice implementation to use.

      • Fields inherited from class adams.flow.webservice.AbstractWebServiceProvider

        m_InInterceptor, m_OutInterceptor, m_Owner, m_Running, m_URL

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected void doStart()
      Performs the actual start of the service.
      protected void doStop()
      Performs the actual stop of the service.
      String getDefaultURL()
      Returns the default URL for the service.
      SpectralTransformService getImplementation()
      Returns the webservice implementation to use.
      String globalInfo()
      Returns a string describing the object.
      String implementationTipText()
      Description of this option.
      void setImplementation​(SpectralTransformService value)
      Sets the webservice implementation to use.

      • Methods inherited from class adams.flow.webservice.AbstractWebServiceProvider

        check, cleanUp, configureInterceptors, configureTLS, getDefaultInInterceptor, getDefaultOutInterceptor, getFlowContext, getInInterceptor, getOutInterceptor, getURL, inInterceptorTipText, isRunning, log, outInterceptorTipText, setFlowContext, setInInterceptor, setOutInterceptor, setURL, start, stop, URLTipText

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Endpoint

        protected transient org.apache.cxf.jaxws.EndpointImpl m_Endpoint
        end point for the web service

    • Constructor Detail

      • SpectralTransformServiceWS

        public SpectralTransformServiceWS()

    • 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 adams.flow.webservice.AbstractWebServiceProvider

      • getDefaultURL

        public String getDefaultURL()
        Returns the default URL for the service.
        Specified by:
        getDefaultURL in class adams.flow.webservice.AbstractWebServiceProvider
        Returns:
        the URL

      • setImplementation

        public void setImplementation​(SpectralTransformService value)
        Sets the webservice implementation to use.
        Parameters:
        value - the implementation

      • getImplementation

        public SpectralTransformService getImplementation()
        Returns the webservice implementation to use.
        Returns:
        the implementation

      • implementationTipText

        public String implementationTipText()
        Description of this option.
        Returns:
        the description for the GUI

      • doStart

        protected void doStart()
                throws Exception
        Performs the actual start of the service.
        Specified by:
        doStart in class adams.flow.webservice.AbstractWebServiceProvider
        Throws:
        Exception - if start fails

      • doStop

        protected void doStop()
               throws Exception
        Performs the actual stop of the service.
        Specified by:
        doStop in class adams.flow.webservice.AbstractWebServiceProvider
        Throws:
        Exception - if stopping fails