Package adams.flow.webservice.text

Class RatsTextServiceWS

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.webservice.AbstractWebServiceProvider

adams.flow.webservice.text.RatsTextServiceWS

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, RatInputUser, WebServiceProvider, Serializable

public class RatsTextServiceWS
extends AbstractWebServiceProvider
implements RatInputUser

Webservice for RATS Text.

Version:

$Revision: 2085 $

Author:

Fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.cxf.jaxws.EndpointImpl	m_Endpoint	end point for the web service
protected RatsTextService	m_Implementation	the webservice implementation to use.
protected RatInput	m_RatInput	the associated rat input.

Fields inherited from class adams.flow.webservice.AbstractWebServiceProvider

m_InInterceptor, m_OutInterceptor, m_Owner, m_Running, 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
RatsTextServiceWS()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doStart()	Performs the actual start of the service.
protected void	doStop()	Performs the actual stop of the service.
String	getDefaultURL()	Returns the default URL for the service.
RatsTextService	getImplementation()	Returns the webservice implementation to use.
RatInput	getRatInput()	Returns the Rat input associated with this webservice.
String	globalInfo()	Returns a string describing the object.
String	implementationTipText()	Description of this option.
void	setImplementation(RatsTextService value)	Sets the webservice implementation to use.
void	setRatInput(RatInput value)	Sets the Rat input associated with this webservice.

Methods inherited from class adams.flow.webservice.AbstractWebServiceProvider

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

protected transient org.apache.cxf.jaxws.EndpointImpl m_Endpoint

end point for the web service

m_Implementation

protected RatsTextService m_Implementation

the webservice implementation to use.

m_RatInput

protected RatInput m_RatInput

the associated rat input.

Constructor Detail

RatsTextServiceWS

public RatsTextServiceWS()

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 AbstractWebServiceProvider

getDefaultURL

public String getDefaultURL()

Returns the default URL for the service.

Specified by:

getDefaultURL in class AbstractWebServiceProvider

Returns:

the URL

setRatInput

public void setRatInput(RatInput value)

Sets the Rat input associated with this webservice.

Specified by:

setRatInput in interface RatInputUser

Parameters:

value - the rat input

getRatInput

public RatInput getRatInput()

Returns the Rat input associated with this webservice.

Specified by:

getRatInput in interface RatInputUser

Returns:

the rat input

setImplementation

public void setImplementation(RatsTextService value)

Sets the webservice implementation to use.

Parameters:

value - the implementation

getImplementation

public RatsTextService getImplementation()

Returns the webservice implementation to use.

Returns:

the implementation

implementationTipText

public String implementationTipText()

Description of this option.

Returns:

the description for the GUI

doStart

protected void doStart()
                throws Exception

Performs the actual start of the service.

Specified by:

doStart in class AbstractWebServiceProvider

Throws:

Exception - if start fails

doStop

protected void doStop()
               throws Exception

Performs the actual stop of the service.

Specified by:

doStop in class AbstractWebServiceProvider

Throws:

Exception - if stopping fails