org.ka2ddo.yaac.io

Class OuternetConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.TNCConnector

org.ka2ddo.yaac.io.OuternetConnector

public class OuternetConnector
extends TNCConnector

This class implements a polling file reader for files accessed over HTTP from a webserver such as an OUTERNET receiver, where the file contains APRS messages in TNC2 ASCII/UTF-8 format.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OuternetConnector.OuternetTestListener Interface for listeners (such as the Test Port button on the configuration GUI panel) to intercept the data read from the Outernet receiver.

Nested classes/interfaces inherited from class org.ka2ddo.yaac.io.PortConnector

PortConnector.PortStatsType

Nested classes/interfaces inherited from class org.ka2ddo.ax25.Connector

Connector.ConnectorType, Connector.PortStats

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_GUI The fully-qualified platform-wildcarded class name for the configuration editor for OuternetConnector.
static java.lang.String	TYPE_NAME The PortConnector type name for OuternetConnector.

Fields inherited from class org.ka2ddo.yaac.io.TNCConnector

RF_SEND_TIME_PER_BYTE_1200, RF_SEND_TIME_PER_BYTE_300, RF_SEND_TIME_PER_BYTE_9600, timeslotTimer

Fields inherited from class org.ka2ddo.yaac.io.PortConnector

currentCfg, portConfig

Fields inherited from class org.ka2ddo.ax25.Connector

CAP_ADSB, CAP_FAST_RF_9600, CAP_FULL_DUPLEX, CAP_GPS_DATA, CAP_HF, CAP_IGATE, CAP_KENWOOD_CMD, CAP_OPENTRAC, CAP_OTHER_TRANSPORT, CAP_RAW_AX25, CAP_RCV_PACKET_DATA, CAP_RF, CAP_SUBCLIENT, CAP_WAYPOINT_SENDER, CAP_WEATHER, CAP_XMT_PACKET_DATA, stats

Constructor Summary

Constructors

Constructor and Description
OuternetConnector()

Method Summary

Modifier and Type	Method and Description
void	close() Shut down this port connection.
void	configure(PortConfig config) Update the configuration of the connector to match the updated setup.
static void	fillinConfigDefaults(PortConfig.Cfg cfg) Set the correct defaults for a port in process of being created.
int	getAcceptableProtocolsMask() Get the bitmask of AX.25 protocols supported by this port.
int	getCapabilities() Specify what capabilities a port of this type has.
boolean	isOpen() Reports whether this Connector has an open connection to its port.
boolean	readMostRecentFile(OuternetConnector.OuternetTestListener listener) Attempt to read both files from the OUTERNET receiver, and extract the records from the most recent file and forward them to the AX25Stack.
java.lang.String	toString() Returns a string representation of the OuternetConnector object.

Methods inherited from class org.ka2ddo.yaac.io.TNCConnector

convertTNC2FormatToAX25Frame, getBitRate, getCallsign, getPortAddress, getRFSendTimePerByte, setPortAddress

Methods inherited from class org.ka2ddo.yaac.io.PortConnector

addPortEventListener, createPort, fillinConfigDefaultsForType, fireFailed, fireReceiving, fireTransmitting, getCollectedStatsTypes, getPortConfig, getPortConnectorClass, getPortConnectorInactivityTimer, getStats, portConnectorClasses, portTypeNames, registerPortConnectorType, removePortEventListener, setPortConfig

Methods inherited from class org.ka2ddo.ax25.Connector

addFrameListener, finalize, fireConsumeFrame, fireConsumeFrame, getStats, getType, hasCapability, removeFrameListener

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

The PortConnector type name for OuternetConnector.

See Also:

Constant Field Values

CONFIG_GUI

public static final java.lang.String CONFIG_GUI

The fully-qualified platform-wildcarded class name for the configuration editor for OuternetConnector.

See Also:

Constant Field Values

Constructor Detail

OuternetConnector

public OuternetConnector()

Method Detail

fillinConfigDefaults

public static void fillinConfigDefaults(PortConfig.Cfg cfg)

Set the correct defaults for a port in process of being created.

Parameters:

cfg - PortConfig.Cfg whose defaults should be adjusted

configure

public void configure(PortConfig config)
               throws java.io.IOException,
                      java.lang.IllegalArgumentException

Update the configuration of the connector to match the updated setup.

Specified by:

configure in class PortConnector

Parameters:

config - PortConfig defining new port settings

Throws:

java.io.IOException - if interface changes could not be applied

java.lang.IllegalArgumentException - if type information is invalid for changing the settings of this PortConnector

readMostRecentFile

public boolean readMostRecentFile(OuternetConnector.OuternetTestListener listener)
                           throws java.io.IOException

Attempt to read both files from the OUTERNET receiver, and extract the records from the most recent file and forward them to the AX25Stack.

Parameters:

listener - OuternetTestListener if receive is supposed to be redirected to a test widget, or null for normal operation

Returns:

boolean true if file read succeeded (even if old data)

Throws:

java.io.IOException - if web pages can't be read

isOpen

public boolean isOpen()

Reports whether this Connector has an open connection to its port.

Specified by:

isOpen in class Connector

Returns:

boolean true if Connector is open

close

public void close()

Shut down this port connection.

Overrides:

close in class Connector

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Overrides:

getCapabilities in class Connector

Returns:

bitmask of capability flags

See Also:

Connector.CAP_RCV_PACKET_DATA, Connector.CAP_RF

toString

public java.lang.String toString()

Returns a string representation of the OuternetConnector object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

getAcceptableProtocolsMask

public int getAcceptableProtocolsMask()

Get the bitmask of AX.25 protocols supported by this port.

Overrides:

getAcceptableProtocolsMask in class TNCConnector

Returns:

protocol bitmask, or 0 for no AX.25 protocols supported