Package adams.flow.standalone

Class RESTServer

  • 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<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.CallableActorUser, adams.flow.core.ErrorHandler, Serializable, Comparable
    public class RESTServer
extends adams.flow.standalone.AbstractStandalone
implements adams.flow.core.CallableActorUser
    Runs a REST webservice. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: RESTServer
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -web-service <adams.flow.rest.RESTProvider> (property: webService)
    The webservice to provide.
    default: adams.flow.rest.echo.EchoServer -in-interceptor adams.flow.rest.interceptor.incoming.NullGenerator -out-interceptor adams.flow.rest.interceptor.outgoing.NullGenerator
 
    -log <adams.flow.core.CallableActorReference> (property: log)
    The name of the callable log actor to use (logging disabled if actor not
    found).
    default: unknown
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.flow.core.CallableActorHelper m_Helper
      the helper class.
      protected adams.flow.core.CallableActorReference m_Log
      the callable name.
      protected adams.flow.core.Actor m_LogActor
      the callable log actor.
      protected RESTProvider m_WebService
      the webservice to run.

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Constructor Summary

      Constructors 
      Constructor Description
      RESTServer()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cleanUp()
      Cleans up after the execution has finished.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      protected adams.flow.core.Actor findCallableActor()
      Tries to find the callable actor referenced by its callable name.
      String getAdditionalInformation()
      Returns the additional information.
      adams.flow.core.Actor getCallableActor()
      Returns the currently set callable actor.
      adams.flow.core.CallableActorReference getLog()
      Returns the name of the callable log actor in use.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      RESTProvider getWebService()
      Returns the webservice in use.
      String globalInfo()
      Returns a string describing the object.
      boolean hasCallableActor()
      Checks whether a reference to the callable actor is currently available.
      protected void initialize()
      Initializes the members.
      void log​(String msg, String id)
      Logs an error message if a valid callable log actor has been set up.
      String logTipText()
      Returns the tip text for this property.
      void setLog​(adams.flow.core.CallableActorReference value)
      Sets the name of the callable log actor to use.
      String setUp()
      Initializes the item for flow execution.
      void setWebService​(RESTProvider value)
      Sets the webservice to use.
      String webServiceTipText()
      Returns the tip text for this property.
      void wrapUp()
      Cleans up after the execution has finished.

      • Methods inherited from class adams.flow.standalone.AbstractStandalone

        preExecute

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        toCommandLine

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

        getLoggingLevel, setLoggingLevel

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

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

    • Field Detail

      • m_WebService

        protected RESTProvider m_WebService
        the webservice to run.

      • m_Log

        protected adams.flow.core.CallableActorReference m_Log
        the callable name.

      • m_LogActor

        protected adams.flow.core.Actor m_LogActor
        the callable log actor.

      • m_Helper

        protected adams.flow.core.CallableActorHelper m_Helper
        the helper class.

    • Constructor Detail

      • RESTServer

        public RESTServer()

    • 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

      • getAdditionalInformation

        public String getAdditionalInformation()
        Returns the additional information.
        Specified by:
        getAdditionalInformation in interface adams.core.AdditionalInformationHandler
        Overrides:
        getAdditionalInformation in class adams.flow.core.AbstractActor
        Returns:
        the additional information, null or 0-length string for no information

      • 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.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.core.AbstractActor

      • setWebService

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

      • getWebService

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

      • 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.

      • setLog

        public void setLog​(adams.flow.core.CallableActorReference value)
        Sets the name of the callable log actor to use.
        Parameters:
        value - the callable name

      • getLog

        public adams.flow.core.CallableActorReference getLog()
        Returns the name of the callable log actor in use.
        Returns:
        the callable name

      • logTipText

        public String logTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • findCallableActor

        protected adams.flow.core.Actor findCallableActor()
        Tries to find the callable actor referenced by its callable name.
        Returns:
        the callable actor or null if not found

      • hasCallableActor

        public boolean hasCallableActor()
        Checks whether a reference to the callable actor is currently available.
        Returns:
        true if a reference is available
        See Also:
        getCallableActor()

      • getCallableActor

        public adams.flow.core.Actor getCallableActor()
        Returns the currently set callable actor.
        Specified by:
        getCallableActor in interface adams.flow.core.CallableActorUser
        Returns:
        the actor, can be null

      • setUp

        public String setUp()
        Initializes the item for flow execution.
        Specified by:
        setUp in interface adams.flow.core.Actor
        Overrides:
        setUp in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • log

        public void log​(String msg,
                String id)
        Logs an error message if a valid callable log actor has been set up.
        Parameters:
        msg - the message to log
        id - an optional ID of the data token that failed in the web service

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished. Graphical output is left untouched.
        Specified by:
        wrapUp in interface adams.flow.core.Actor
        Overrides:
        wrapUp in class adams.flow.core.AbstractActor

      • cleanUp

        public void cleanUp()
        Cleans up after the execution has finished.
        Specified by:
        cleanUp in interface adams.flow.core.Actor
        Specified by:
        cleanUp in interface adams.core.CleanUpHandler
        Overrides:
        cleanUp in class adams.flow.core.AbstractActor