Package adams.flow.dropwizard.echo

Class EchoServer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.dropwizard.AbstractRESTProvider

adams.flow.dropwizard.echo.EchoServer

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, RESTProvider, Serializable

public class EchoServer
extends AbstractRESTProvider

Only offers: adams.flow.dropwizard.echo.Echo

REST Class
- Path: @jakarta.ws.rs.Path(value="/echo/{input}")
- Produces: @jakarta.ws.rs.Produces(value={"text/plain"})

REST Method 'ping'
- Parameter #1: @jakarta.ws.rs.PathParam(value="input")
- Method(s): GET

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 

-config-file <adams.core.io.PlaceholderFile> (property: configFile)
    The YAML config file to use for the application, see here for details on
    the format: https://www.dropwizard.io/en/stable/manual/configuration.html
    default: ${CWD}
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EchoServer.EchoApplication

Field Summary

Fields inherited from class adams.flow.dropwizard.AbstractRESTProvider

m_Application, m_ConfigFile, m_Environment, m_Owner, m_Running

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
EchoServer()

Method Summary

Modifier and Type	Method	Description
protected com.github.fracpete.javautils.struct.Struct2<io.dropwizard.core.Application,io.dropwizard.core.setup.Environment>	doStart()	Performs the actual start of the service.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.dropwizard.AbstractRESTProvider

check, cleanUp, configFileTipText, defineOptions, doStop, getConfigFile, getFlowContext, isRunning, log, setConfigFile, setFlowContext, start, stop

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

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

EchoServer

public EchoServer()

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

doStart

protected com.github.fracpete.javautils.struct.Struct2<io.dropwizard.core.Application,io.dropwizard.core.setup.Environment> doStart()
                                                                                                                                   throws Exception

Performs the actual start of the service.

Specified by:

doStart in class AbstractRESTProvider

Returns:

the tuple of application and environment

Throws:

Exception - if start fails