Package org.ka2ddo.yaac.webserver

The package contains the classes that implement YAAC's mini webserver, which allows other users on the YAAC computer's LAN to effectively "look over the shoulder" of the YAAC operator, seeing the main views of YAAC as browsable web pages.

See: Description

Interface Summary

Interface	Description
AttributedPage	This is a tagging interface to specify that the page has cleared the requestHeaders map and reloaded it with attributes for the response.
CacheablePage	This is a tagging interface to mark that the webpage produced by its implementing class may be cached by the browser or intervening proxy servers.

Class Summary

Class	Description
BulletinsPage	This generates an HTML page representing the current state of the Bulletin Board view in YAAC.
FavIcon	This class exports the YAAC icon in taskbar size as the website's favicon.ico file.
FileCopierPage	This class defines a HTTP page for copying a file from this YAAC installation to another.
HistoryPage	This generates a page representing the message history for a particular station or object.
HttpConnectionThread	This class processes one inbound HTTP connection.
HttpServer	This class implements a very simple HTTP server.
IconPage	This "page" delivers the PNG encoding of a APRS symbol icon.
IndexPage	This class generates the home page for the mini webserver inside YAAC.
LayoutControls	Helper class containing per-table-column formatting information for producing HTML tables in one of the dynamic web pages.
MapPage	This class dynamically generates a PNG image of the current map as seen on the YAAC GUI.
MessagesPage	This generates an HTML page representing the Messages view in YAAC.
MonitorDigiPage	This generates an HTML page representing the digipeater and I-gate stations monitored for health by this station.
MonitorStationsPage	This generates an HTML page representing the stations monitored for health by this station.
MonitorWxPage	This generates an HTML page representing the weather stations monitored for health by this station.
PathHandler	This is the generic web page generator class which should be subclassed to produce a particular page.
RobotsTxtPage	This page produces a robots.txt file contents to try to prevent web spiders from navigating the entire website in YAAC.
StationsPage	This generates an HTML page representing the Stations/Objects view in YAAC.
WeatherPage	This page displays the current status from the local weather station (if any) attached to this APRS station.

Enum Summary

Enum	Description
FileCopierPage.PathType	Enumeration specifying the base directory for the relative path of the exported file.

Package org.ka2ddo.yaac.webserver Description

The package contains the classes that implement YAAC's mini webserver, which allows other users on the YAAC computer's LAN to effectively "look over the shoulder" of the YAAC operator, seeing the main views of YAAC as browsable web pages.

The HttpServer class is the main thread that accepts inbound connections from browsers, defaulting to listening on TCP port 8008 (because the normal HTTP port 80 is often considered as "privileged" and therefore not allocatable by non-administrator users).

HttpConnectionThread serves one browser connection, and can launch a page for any registered URL that is provided by a class extending the PathHandler abstract class; any URL that doesn't match a registered PathHandler's URL causes the HttpConnectionThread to properly return an HTTP 404 (Not Found) error. Pages currently implemented in core YAAC include:

URLs of defined pages in mini-webserver

URL	Class	Function
/	IndexPage	home page displaying a title, the default map, and links to other pages
/favicon.ico	FavIcon	return the YAAC icon image in Windows BMP format
/map.png	MapPage	return the actual map image in PNG format at its current pan and zoom
/stations	StationsPage	display the Stations/Objects list as an HTML table
/icon/*	IconPage	return a PNG file of one of the APRS symbol images as specified by the following path
/bulletins	BulletinsPage	display the Bulletin Board view as an HTML table
/messages	MessagesPage	display the Raw messages (not Raw Packets) view as an HTML table
/history/callsign	HistoryPage	display the per-station raw packets view as an HTML table
/monitor/digi	MonitorDigiPage	display a page of health-monitored digipeater and I-gate stations as an HTML table
/monitor/stations	MonitorStationsPage	display a page of health-monitored stations of all types as an HTML table
/monitor/wx	MonitorWxPage	display a page of health-monitored weather stations as an HTML table
/wx	WeatherPage	page showing the current weather at the local station
/robots.txt	RobotsTxtPage	robots.txt page to block web spiders from surfing the entire mini-webserver
/special.nodes /special.ways	FileCopierPage	download this YAAC instance's special OSM files for supplementing the OSM map rendering

Adding other pages will require obtaining the HttpServer instance to register the new page handlers with appropriate URLs. Some plugins either do this with the core YAAC HttpServer instance (obtainable with the CoreProvider's CoreProvider.getCoreWebServer() method), or with another instance of HttpServer created for that plugin's own purposes.