org.ka2ddo.yaac.io

Class AprsIsConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.TNCConnector

org.ka2ddo.yaac.io.AprsIsConnector

All Implemented Interfaces:

java.lang.Runnable, java.lang.Thread.UncaughtExceptionHandler, TransmittingConnector, HasRemoteAppIfc, NeedsAppVersionInfoIfc, PortFailureReportListener

public class AprsIsConnector
extends TNCConnector
implements java.lang.Runnable, java.lang.Thread.UncaughtExceptionHandler, PortFailureReportListener, NeedsAppVersionInfoIfc, TransmittingConnector, HasRemoteAppIfc

This class defines a potentially bidirectional connection to an APRS-IS server. New functionality includes support for SOCKS5 proxy server relay connections (RFC1928), supporting username/password authentication (RFC1929), and GSSAPI authentication (RFC1961).

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

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.util.Set<PortConfig.Fields>	BLANK_FIELDS Set of PortConfig field identifiers for fields that should not be copied from another system and should therefore be blanked out when copying configuration files.
static java.lang.String	CONFIG_GUI Specify the fully-qualified platform-wildcarded class name for the editor for AprsIsConnector.
static java.util.Map<PortConfig.Fields,PortConfig.RequireHints>	REQ_FIELDS List of PortConfig field identifiers that are mandated for this port type to work, and the ResourceBundle key to prompt for a value if missing.
static java.lang.String	TYPE_NAME Specify the PortConnector type name for AprsIsConnector.

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
AprsIsConnector() Create an uninitialized instance of AprsIsConnector.

Method Summary

Modifier and Type	Method and Description
void	close() Shut down this PortConnector.
void	configure(PortConfig config) Update the configuration of the connector to match the updated setup.
void	failureGuiCreated(PortFailureReporterIfc failureGui) Specify the lazily-created failure reporting GUI object for the reported failure.
void	failureGuiDismissed() The GUI object has been dismissed by the user and should not be used any more by the requesting I/O code.
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	getBitRate() Get the bit transmission rate on this port.
int	getCapabilities() Specify what capabilities a port of this type has.
java.net.InetSocketAddress	getCurrentConnectAddress() Return the address of the remote APRS-IS server this port is connected to.
long	getPortOpenTime() Return the time (in milliseconds since epoch) of when the connection to the remote application was opened.
java.lang.String[]	getRemoteAppAndVersion() Get the application and version thereof of the remote application this Connector is connected to.
boolean	isOpen() Reports whether this PortConnector has an open connection to its port.
void	run() Private internal method used to read the incoming APRS messages from the socket connection to the selected APRS-IS server.
void	sendFrame(AX25Frame frame) Transmit a AX.25 frame to the connected APRS-IS server.
void	setAppVersion(java.lang.String name, java.lang.String version) Sets the name and version of the containing application.
java.lang.String	toString() Returns a string representation of the AprsIsConnector object.
void	uncaughtException(java.lang.Thread t, java.lang.Throwable e) Method invoked when the given thread terminates due to the given uncaught exception.

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

convertTNC2FormatToAX25Frame, 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

Methods inherited from interface org.ka2ddo.ax25.TransmittingConnector

getCallsign, getStats, hasCapability

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

Specify the PortConnector type name for AprsIsConnector.

See Also:

Constant Field Values

CONFIG_GUI

public static final java.lang.String CONFIG_GUI

Specify the fully-qualified platform-wildcarded class name for the editor for AprsIsConnector.

See Also:

Constant Field Values

BLANK_FIELDS

public static final java.util.Set<PortConfig.Fields> BLANK_FIELDS

Set of PortConfig field identifiers for fields that should not be copied from another system and should therefore be blanked out when copying configuration files.

REQ_FIELDS

public static final java.util.Map<PortConfig.Fields,PortConfig.RequireHints> REQ_FIELDS

List of PortConfig field identifiers that are mandated for this port type to work, and the ResourceBundle key to prompt for a value if missing.

Constructor Detail

AprsIsConnector

public AprsIsConnector()

Create an uninitialized instance of AprsIsConnector.

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

setAppVersion

public void setAppVersion(java.lang.String name,
                          java.lang.String version)

Sets the name and version of the containing application.

Specified by:

setAppVersion in interface NeedsAppVersionInfoIfc

Parameters:

name - String name of the application (cannot contain whitespace)

version - String version of the application (cannot contain whitespace)

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

isOpen

public boolean isOpen()

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

Specified by:

isOpen in interface TransmittingConnector

Specified by:

isOpen in class Connector

Returns:

boolean true if PortConnector is open

run

public final void run()

Private internal method used to read the incoming APRS messages from the socket connection to the selected APRS-IS server.

Specified by:

run in interface java.lang.Runnable

getBitRate

public int getBitRate()

Get the bit transmission rate on this port.

Overrides:

getBitRate in class TNCConnector

Returns:

bit rate in bits per second

getRemoteAppAndVersion

public java.lang.String[] getRemoteAppAndVersion()

Get the application and version thereof of the remote application this Connector is connected to.

Specified by:

getRemoteAppAndVersion in interface HasRemoteAppIfc

Returns:

String of remote application name and version, or null if it is not known

failureGuiCreated

public void failureGuiCreated(PortFailureReporterIfc failureGui)

Specify the lazily-created failure reporting GUI object for the reported failure.

Specified by:

failureGuiCreated in interface PortFailureReportListener

Parameters:

failureGui - PortFailureReporterIfc object for the GUI

See Also:

GuiIfc.showIOFailureDialog(org.ka2ddo.yaac.io.PortConfig, String, org.ka2ddo.yaac.io.PortFailureReportListener)

failureGuiDismissed

public void failureGuiDismissed()

The GUI object has been dismissed by the user and should not be used any more by the requesting I/O code.

Specified by:

failureGuiDismissed in interface PortFailureReportListener

getCurrentConnectAddress

public java.net.InetSocketAddress getCurrentConnectAddress()

Return the address of the remote APRS-IS server this port is connected to.

Specified by:

getCurrentConnectAddress in interface HasRemoteAppIfc

Returns:

InetSocketAddress of remote server, or null if port is not open

getPortOpenTime

public long getPortOpenTime()

Return the time (in milliseconds since epoch) of when the connection to the remote application was opened.

Specified by:

getPortOpenTime in interface HasRemoteAppIfc

Returns:

time in milliseconds, or 0 if not open

uncaughtException

public final void uncaughtException(java.lang.Thread t,
                                    java.lang.Throwable e)

Method invoked when the given thread terminates due to the given uncaught exception.

Any exception thrown by this method will be ignored by the Java Virtual Machine.

Specified by:

uncaughtException in interface java.lang.Thread.UncaughtExceptionHandler

Parameters:

t - the thread

e - the exception

sendFrame

public void sendFrame(AX25Frame frame)

Transmit a AX.25 frame to the connected APRS-IS server. Note this will silently do nothing if the connection is not open or transmission is not enabled for this PortConnector.

Specified by:

sendFrame in interface TransmittingConnector

Parameters:

frame - AX25Frame to transmit

close

public void close()

Shut down this PortConnector.

Overrides:

close in class Connector

toString

public java.lang.String toString()

Returns a string representation of the AprsIsConnector object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Specified by:

getCapabilities in interface TransmittingConnector

Overrides:

getCapabilities in class Connector

Returns:

bitmask of capability flags

See Also:

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

getAcceptableProtocolsMask

public int getAcceptableProtocolsMask()

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

Specified by:

getAcceptableProtocolsMask in interface TransmittingConnector

Overrides:

getAcceptableProtocolsMask in class TNCConnector

Returns:

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