Package adams.flow.rest.control

Class StopFlow

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.AbstractRESTPlugin

adams.flow.rest.AbstractRegisteredFlowRESTPlugin

adams.flow.rest.control.StopFlow

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, RESTPlugin, Serializable

public class StopFlow
extends AbstractRegisteredFlowRESTPlugin

Allows to stop a (registered) flow via its ID.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
StopFlow()

Method Summary

Modifier and Type	Method	Description
String	globalInfo()	Returns a string describing the object.
String	restart(int id)	Stops the flow with the specified ID.

Methods inherited from class adams.flow.rest.AbstractRegisteredFlowRESTPlugin

getFlow

Methods inherited from class adams.flow.rest.AbstractRESTPlugin

getAdditionalInformation

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Constructor Detail

StopFlow

public StopFlow()

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

restart

@GET
@Path("/flow/control/stop/{id}")
public String restart(@PathParam("id")
                      int id)

Stops the flow with the specified ID. You can use -1 as shortcut for the only running flow.

Parameters:

id - the flow ID, use -1 for only one running

Returns:

"OK" or error message