Package adams.flow.rest.echo

Class EchoServer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.AbstractRESTProvider

adams.flow.rest.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.rest.echo.Echo

REST Method 'ping'
- Path: @javax.ws.rs.Path(value=/echo/{input})
- Produces: @javax.ws.rs.Produces(value=[text/plain])
- 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
 

-url <java.lang.String> (property: URL)
    The URL of the service.
    default: http://localhost:8080/
 

-in-interceptor <adams.flow.rest.interceptor.incoming.AbstractInInterceptorGenerator> (property: inInterceptor)
    The interceptor to use for incoming messages.
    default: adams.flow.rest.interceptor.incoming.NullGenerator
 

-out-interceptor <adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator> (property: outInterceptor)
    The interceptor to use for outgoing messages.
    default: adams.flow.rest.interceptor.outgoing.NullGenerator
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.rest.AbstractRESTProvider

m_InInterceptor, m_OutInterceptor, m_Owner, m_Running, m_Server, 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

Constructor Summary

Constructors

Constructor	Description
EchoServer()

Method Summary

Modifier and Type	Method	Description
protected org.apache.cxf.endpoint.Server	doStart()	Performs the actual start of the service.
String	getDefaultURL()	Returns the default URL for the service.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.rest.AbstractRESTProvider

check, cleanUp, configureInterceptors, configureTLS, defineOptions, doStop, 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 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

getDefaultURL

public String getDefaultURL()

Returns the default URL for the service.

Specified by:

getDefaultURL in class AbstractRESTProvider

Returns:

the URL

doStart

protected org.apache.cxf.endpoint.Server doStart()
                                          throws Exception

Performs the actual start of the service.

Specified by:

doStart in class AbstractRESTProvider

Returns:

the server instance

Throws:

Exception - if start fails