Package adams.flow.websocket.server

Class AbstractWebSocketServerGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.websocket.server.AbstractWebSocketServerGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, WebSocketServerGenerator, Serializable

Direct Known Subclasses:

EchoServerGenerator

public abstract class AbstractWebSocketServerGenerator
extends AbstractOptionHandler
implements WebSocketServerGenerator, QuickInfoSupporter

Ancestor for server generators.

Version:

$Revision$

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

Method Summary

Modifier and Type	Method	Description
protected String	check()	Hook method for performing checks.
protected abstract com.pusher.java_websocket.server.WebSocketServer	doGenerate()	Generates the server.
com.pusher.java_websocket.server.WebSocketServer	generateServer()	Generates the server.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractWebSocketServerGenerator

public AbstractWebSocketServerGenerator()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check()

Hook method for performing checks.
Default implementation returns null.

Returns:

null if successful, otherwise error message

doGenerate

protected abstract com.pusher.java_websocket.server.WebSocketServer doGenerate()

Generates the server.

Returns:

the server

generateServer

public com.pusher.java_websocket.server.WebSocketServer generateServer()

Generates the server.

Specified by:

generateServer in interface WebSocketServerGenerator

Returns:

the generated server instance

Throws:

IllegalStateException - if checks failed

See Also:

check()