org.openksavi.sponge.gsmmodem

Class SerialPortGsmModemPlugin

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.plugin.BasePlugin

org.openksavi.sponge.java.JPlugin

org.openksavi.sponge.gsmmodem.SerialPortGsmModemPlugin

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.plugin.Plugin, org.openksavi.sponge.util.Descriptive, org.openksavi.sponge.util.HasEngine, org.openksavi.sponge.util.Manageable

@Experimental
public class SerialPortGsmModemPlugin
extends JPlugin

A GSM modem plugin that uses a serial port.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PLUGIN_NAME The default name of this plugin.

Constructor Summary

Constructors

Constructor and Description
SerialPortGsmModemPlugin() Creates a new GSM modem plugin.
SerialPortGsmModemPlugin(String name) Creates a new GSM modem plugin.

Method Summary

Modifier and Type	Method and Description
SerialPortGsmModem	getModem()
SerialPortGsmModemConfiguration	getModemConfiguration()
void	onConfigure(org.openksavi.sponge.config.Configuration configuration) Applies the XML configuration to this plugin.
void	onShutdown() Shuts down the plugin.
void	onStartup() Starts up this plugin.
void	setModem(SerialPortGsmModem modem)
void	setModemConfiguration(SerialPortGsmModemConfiguration modemConfiguration)

Methods inherited from class org.openksavi.sponge.core.plugin.BasePlugin

doShutdown, doStartup, getConfiguration, getEngineOperations, getKnowledgeBase, getLogger, getSponge, onAfterReload, onBeforeReload, onInit, setConfiguration, setKnowledgeBase, shutdown, startup, toString

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getDescription, getEngine, getInternalService, getLabel, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setEngine, setLabel, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Field Detail

DEFAULT_PLUGIN_NAME

public static final String DEFAULT_PLUGIN_NAME

The default name of this plugin.

See Also:

Constant Field Values

Constructor Detail

SerialPortGsmModemPlugin

public SerialPortGsmModemPlugin()

Creates a new GSM modem plugin.

SerialPortGsmModemPlugin

public SerialPortGsmModemPlugin(String name)

Creates a new GSM modem plugin.

Parameters:

name - the plugin name.

Method Detail

onConfigure

public void onConfigure(org.openksavi.sponge.config.Configuration configuration)

Applies the XML configuration to this plugin.

Specified by:

onConfigure in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onConfigure in class BasePlugin

onStartup

public void onStartup()

Starts up this plugin.

Specified by:

onStartup in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onStartup in class BasePlugin

onShutdown

public void onShutdown()

Shuts down the plugin. Closes the modem port.

Specified by:

onShutdown in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onShutdown in class BasePlugin

getModemConfiguration

public SerialPortGsmModemConfiguration getModemConfiguration()

setModemConfiguration

public void setModemConfiguration(SerialPortGsmModemConfiguration modemConfiguration)

getModem

public SerialPortGsmModem getModem()

setModem

public void setModem(SerialPortGsmModem modem)