Package adams.flow.rest.dex

Class DataExchangeServer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.AbstractRESTProvider

adams.flow.rest.dex.DataExchangeServer

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 DataExchangeServer
extends AbstractRESTProvider

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractAuthentication	m_Authentication	the authentication scheme.
protected AbstractBackend	m_Backend	the backend in use.

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

Method Summary

Modifier and Type	Method	Description
String	authenticationTipText()	Returns the tip text for this property.
String	backendTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected org.apache.cxf.endpoint.Server	doStart()	Performs the actual start of the service.
AbstractAuthentication	getAuthentication()	Returns the authentication scheme.
AbstractBackend	getBackend()	Returns the backend scheme.
String	getDefaultURL()	Returns the default URL for the service.
String	globalInfo()	Returns a string describing the object.
void	setAuthentication(AbstractAuthentication value)	Sets the authentication scheme.
void	setBackend(AbstractBackend value)	Sets the backend scheme.

Methods inherited from class adams.flow.rest.AbstractRESTProvider

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

Field Detail

m_Authentication

protected AbstractAuthentication m_Authentication

the authentication scheme.

m_Backend

protected AbstractBackend m_Backend

the backend in use.

Constructor Detail

DataExchangeServer

public DataExchangeServer()

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 AbstractRESTProvider

setAuthentication

public void setAuthentication(AbstractAuthentication value)

Sets the authentication scheme.

Parameters:

value - the scheme

getAuthentication

public AbstractAuthentication getAuthentication()

Returns the authentication scheme.

Returns:

the scheme

authenticationTipText

public String authenticationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setBackend

public void setBackend(AbstractBackend value)

Sets the backend scheme.

Parameters:

value - the scheme

getBackend

public AbstractBackend getBackend()

Returns the backend scheme.

Returns:

the scheme

backendTipText

public String backendTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

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