CoreProvider

java.lang.Object
- org.ka2ddo.yaac.pluginapi.Provider
- - org.ka2ddo.yaac.core.provider.CoreProvider

```
public class CoreProvider
extends Provider
```
This class defines the core functionality to be provided by the YAAC application. In essence, this is the root plugin that all other plugins augment and extend. This is the only Provider subclass explicitly coded into YAAC; all others are loaded from JAR files as defined by the Provider class's documentation.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CoreProvider.TransmitGeneratedObjectReport` Helper class for transmitting a locally generated Object or Item Report packet and keeping it registered in the local object list.
`static class`	`CoreProvider.ViewAutoCenter` Control whether map is auto-centered on the local station, using its updated GPS coordinates to pan the map.
`static class`	`CoreProvider.ViewSelectLayers` Launch the layer selection dialog to control which OpenStreetMap features (road types, business types, etc.) are rendered in the map.
`static class`	`CoreProvider.ViewSelfAsPointer` Control whether the local station is rendered as a pointer in its direction of motion.
`static class`	`CoreProvider.ViewSelfAsSymbol` Control whether the local station is rendered using its beacon symbol.
`static class`	`CoreProvider.ViewSelfOff` Control whether the local station is suppressed from rendering on the map.
`static class`	`CoreProvider.ViewShowAge` Control whether the age of each station or object is plotted next to the station symbol.
`static class`	`CoreProvider.ViewShowAliasInsteadOfCallsign` Control whether stations/objects with assigned tactical names (aliases) should display the alias instead of the callsign.
`static class`	`CoreProvider.ViewShowAlohaCircle` Control whether the local station's Aloha circle(s) are drawn on the map.
`static class`	`CoreProvider.ViewShowAmbiguity` Control whether position ambiguity circles are drawn for stations and objects on the map.
`static class`	`CoreProvider.ViewShowCallsign` Control whether station callsigns or object names are rendered next to the station/object symbol on the map.
`static class`	`CoreProvider.ViewShowDeadObjects` Control whether map displays APRS Objects that have been declared to be dead.
`static class`	`CoreProvider.ViewShowDeadReckoning` Control whether moving station position updates are estimated (dead-reckoned) until a new position report is received.
`static class`	`CoreProvider.ViewShowDF` Control whether APRS direction finding information is plotted if present in the station position reports.
`static class`	`CoreProvider.ViewShowDigipeatHops` Control whether digipeat paths between RF-linked stations are drawn on the map.
`static class`	`CoreProvider.ViewShowGraticule` Control whether the map graticule (lat/lon grid) is rendered on the map.
`static class`	`CoreProvider.ViewShowHeatMap` Control whether stations are rendered merely as a "heat map" of dots on the map (all other information suppressed).
`static class`	`CoreProvider.ViewShowItemStatus` Control whether generic item status (station versus object, fixed versus moving, emergency, old, etc.) is drawn for each station/object on the map.
`static class`	`CoreProvider.ViewShowMicEStatus` Control whether Mic-E status (off duty, en route, committed, returning, etc.) is drawn for stations reporting such information.
`static class`	`CoreProvider.ViewShowNWSMultiline` Control whether NWS multilines are drawn if included in a position report.
`static class`	`CoreProvider.ViewShowRangeCircles` Control whether estimated range circles are drawn around stations on the map.
`static class`	`CoreProvider.ViewShowSevereWeatherZones` Control whether the boundaries of active severe weather forecast zones are drawn.
`static class`	`CoreProvider.ViewShowSpeed` Control whether the speed of moving stations/objects is displayed next to the station symbol on the map.
`static class`	`CoreProvider.ViewShowTrackStripes` Control whether station motion stripes are drawn on the map.
`static class`	`CoreProvider.ViewShowWeatherSymbols` Control whether weather stations are rendered using old-style weather map notation.

Nested classes/interfaces inherited from class org.ka2ddo.yaac.pluginapi.Provider
Provider.PortEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static AbstractMenuAction`	`EXIT_ACTION` This Action performs the operations needed to cleanly shut down YAAC and free up the system resources it is using.
`static java.lang.String`	`MENU_VIEW_DRAW_TOOLBAR` The menu tag name for View->View Draw Toolbar, so that other closers of the toolbar can inform the menu item to clear its checkbox.
`static java.lang.String[]`	`PRE_LOCALIZED_FILE_LOAD_MENU` This menu tag hierarchy covers the File->Load menu.
`static java.lang.String[]`	`PRE_LOCALIZED_FILE_SAVE_MENU` This menu tag hierarchy covers the File->Save menu.
`static java.lang.String[]`	`PRE_LOCALIZED_FILTER_MENU` Menu tag hierarchy for the Filter menu.
`static java.lang.String[]`	`PRE_LOCALIZED_LOCATE_MENU` This menu tag hierarchy covers the Locate menu.
`static java.lang.String[]`	`PRE_LOCALIZED_VIEW_LAYERS_MENU` This menu tag hierarchy covers the View->Layers sub-menu.
`static java.lang.String[]`	`PRE_LOCALIZED_VIEW_MENU` This menu tag hierarchy covers the View menu.
`static java.lang.String[]`	`PRE_LOCALIZED_VIEW_OBJECTS_MENU` This menu tag hierarchy covers the View->Objects sub-menu.
`static java.lang.String[]`	`PRE_LOCALIZED_VIEW_PACKETS_MENU` This menu tag hierarchy covers the View->Packets sub-menu.
`static java.lang.String[]`	`PRE_LOCALIZED_VIEW_STATIONS_MENU` This menu tag hierarchy covers the View->Stations sub-menu.
`static java.lang.String[]`	`TOP_MENU` The pre-localization hierarchy of sub-menu names for a menu at the top level, made available for use by plugins creating new menus.

Fields inherited from class org.ka2ddo.yaac.pluginapi.Provider
AFTERINSTALL_FULLY_READY, AFTERINSTALL_MAY_NEED_CONFIGURE, AFTERINSTALL_MUST_CONFIGURE, AFTERINSTALL_MUST_RESTART, AFTERINSTALL_ONLY_NEW_MAPS, PLUGIN_NEEDS_NEWER_YAAC_PROTOCOL, PLUGIN_UNKNOWN_INCOMPATIBILITY, PROVIDER_API_VERSION

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getAboutAttributions()` Specify attributions, credits/acknowledgements, and license references to be displayed in the About dialog box.
`java.util.Map<java.lang.String,java.lang.String>`	`getConfigurationPanels()` Get any panels needed by this Provider to provision or configure the services offered by the Provider.
`HttpServer`	`getCoreWebServer()` Get the web server instance associated with the core services of YAAC.
`Filter[]`	`getFilters()` Get any filters to add to the main CumulativeBooleanAndFilter in the main class of YAAC.
`javax.help.HelpSet`	`getHelpSet()` Provide the base HelpSet for complete online documentation.
`java.lang.String`	`getImageIconPath()` Return an icon image associated with this Provider.
`static CoreProvider`	`getInstance()` Get the core instance of Provider for YAAC.
`static java.util.ArrayList<java.lang.String>`	`getListOfServerTileDirs()` Get the list of older tile directories available on the YAAC author's web server that use a `ChangeSet.YAAC_STRUCTURE_VERSION` acceptable to this version of YAAC.
`static ChangeSet`	`getLocalOSMChangeSet(boolean announceErrors)` Get the local OSM ChangeSet record for the versions of the OpenStreetMap data stored locally.
`AbstractMenuAction[]`	`getMenuItems()` Get Actions to define new menu items from this Provider.
`Provider.PortEntry[]`	`getPortConnectorTypes()` Get PortConnector drivers provided by this Provider.
`static ChangeSet`	`getServerOSMChangeSet(java.lang.String webTileDir)` Query the author's website for the currently available changeset of the pre-imported OpenStreetMap tile files.
`java.lang.String`	`getUserAgent()` Return a standard string for identifying this installation of YAAC to a web server in the User-Agent HTTP header property.
`boolean`	`hasRXTX()` Report whether this plugin was able to load the (now obsolete) RXTX native library for accessing serial ports.
`static boolean`	`isIPv4Forced()` Indicate if YAAC is configured to support Internet networks supporting IPv6.
`boolean`	`isNonencryptedHTTPForced()` Indicate if YAAC is configured to support Internet networks prohibiting encrypted traffic (such as the Amateur Radio HSMM [High-Speed MultiMedia] networks).
`static void`	`main(java.lang.String[] args)` Method to allow printing out version of YAAC (alternative to `YAAC` class's `-version` command-line option).
`void`	`runInitializersAfter()` Execute this function after calling all of the other functions of the CoreProvider.
`static void`	`setIPv4Forced(boolean onlyIPv4)` Specify if YAAC is configured to support Internet networks supporting IPv6.
`void`	`setNonencryptedHTTPForced(boolean onlyHTTP)` Specify if YAAC is configured to support Internet networks prohibiting encrypted traffic.

Methods inherited from class org.ka2ddo.yaac.pluginapi.Provider
buildNewerYaacNeededMsg, consumeXMLPreferenceData, findHelpSet, getAuthor, getInfo, getInitFailureReason, getName, getVersion, runInitializersBefore, willPluginWorkAfterLiveInstallation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TOP_MENU
```
public static final java.lang.String[] TOP_MENU
```
    The pre-localization hierarchy of sub-menu names for a menu at the top level, made available for use by plugins creating new menus.
  - EXIT_ACTION
```
public static final AbstractMenuAction EXIT_ACTION
```
    This Action performs the operations needed to cleanly shut down YAAC and free up the system resources it is using.
  - PRE_LOCALIZED_FILE_LOAD_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_FILE_LOAD_MENU
```
    This menu tag hierarchy covers the File->Load menu.
    
    Since:
    
    PROVIDER_API_VERSION == 47
  - PRE_LOCALIZED_FILE_SAVE_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_FILE_SAVE_MENU
```
    This menu tag hierarchy covers the File->Save menu.
    
    Since:
    
    PROVIDER_API_VERSION == 47
  - PRE_LOCALIZED_VIEW_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_VIEW_MENU
```
    This menu tag hierarchy covers the View menu.
    
    Since:
    
    PROVIDER_API_VERSION == 47
  - PRE_LOCALIZED_VIEW_PACKETS_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_VIEW_PACKETS_MENU
```
    This menu tag hierarchy covers the View->Packets sub-menu.
    
    Since:
    
    PROVIDER_API_VERSION == 52
  - PRE_LOCALIZED_VIEW_STATIONS_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_VIEW_STATIONS_MENU
```
    This menu tag hierarchy covers the View->Stations sub-menu.
    
    Since:
    
    PROVIDER_API_VERSION == 52
  - PRE_LOCALIZED_VIEW_OBJECTS_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_VIEW_OBJECTS_MENU
```
    This menu tag hierarchy covers the View->Objects sub-menu.
    
    Since:
    
    PROVIDER_API_VERSION == 52
  - PRE_LOCALIZED_VIEW_LAYERS_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_VIEW_LAYERS_MENU
```
    This menu tag hierarchy covers the View->Layers sub-menu.
    
    Since:
    
    PROVIDER_API_VERSION == 47
  - PRE_LOCALIZED_FILTER_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_FILTER_MENU
```
    Menu tag hierarchy for the Filter menu.
    
    Since:
    
    PROVIDER_API_VERSION == 57
  - PRE_LOCALIZED_LOCATE_MENU
```
public static final java.lang.String[] PRE_LOCALIZED_LOCATE_MENU
```
    This menu tag hierarchy covers the Locate menu.
    
    Since:
    
    PROVIDER_API_VERSION == 47
  - MENU_VIEW_DRAW_TOOLBAR
```
public static final java.lang.String MENU_VIEW_DRAW_TOOLBAR
```
    The menu tag name for View->View Draw Toolbar, so that other closers of the toolbar can inform the menu item to clear its checkbox.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static CoreProvider getInstance()
```
    Get the core instance of Provider for YAAC.
    
    Returns:
    
    singleton CoreProvider
  - getPortConnectorTypes
```
public Provider.PortEntry[] getPortConnectorTypes()
```
    Get PortConnector drivers provided by this Provider.
    
    Overrides:
    
    getPortConnectorTypes in class Provider
    
    Returns:
    
    array of PortEntry objects pairing port type names to drivers
  - getConfigurationPanels
```
public java.util.Map<java.lang.String,java.lang.String> getConfigurationPanels()
```
    Get any panels needed by this Provider to provision or configure the services offered by the Provider. The class names are expected to have a wildcard '*' in then to indicate where a platform-specific package variation should be plugged in (such as 'gui' for a conventional Java AWT/Swing GUI, or 'android' for an Android configuration view.
    
    Overrides:
    
    getConfigurationPanels in class Provider
    
    Returns:
    
    Map of localized tab names to class names of GUI-displayable components to add to the expert-mode ConfigurationDialog when it is invoked (usually, a LinkedHashMap, so the tabs can be provided in a specific order)
    
    See Also:
    
    Localizer.getMsg(String), Localizer.getMsg(String, String), Localizer.getMsgBundle(), Localizer.getMsgBundle(String)
  - getFilters
```
public Filter[] getFilters()
```
    Get any filters to add to the main CumulativeBooleanAndFilter in the main class of YAAC.
    
    Overrides:
    
    getFilters in class Provider
    
    Returns:
    
    array of Filter implementations
  - getLocalOSMChangeSet
```
public static ChangeSet getLocalOSMChangeSet(boolean announceErrors)
```
    Get the local OSM ChangeSet record for the versions of the OpenStreetMap data stored locally.
    
    Parameters:
    
    announceErrors - boolean true if this method should raise GUI displays to announce fatal errors
    
    Returns:
    
    local ChangeSet record
  - getListOfServerTileDirs
```
public static java.util.ArrayList<java.lang.String> getListOfServerTileDirs()
```
    Get the list of older tile directories available on the YAAC author's web server that use a ChangeSet.YAAC_STRUCTURE_VERSION acceptable to this version of YAAC.
    
    Returns:
    
    ArrayList of Strings containing the tile directory names (may be empty)
  - getServerOSMChangeSet
```
public static ChangeSet getServerOSMChangeSet(java.lang.String webTileDir)
```
    Query the author's website for the currently available changeset of the pre-imported OpenStreetMap tile files.
    
    Parameters:
    
    webTileDir - String of subdirectory on webserver where tile files are located, or null to use default of "tiledir"
    
    Returns:
    
    ChangeSet, or null if server could not be reached or changeset file could not be read
  - getMenuItems
```
public AbstractMenuAction[] getMenuItems()
```
    Get Actions to define new menu items from this Provider. Actions define the following properties:
    - PRE_LOCALIZE_MENU_TAG_NAME - the pre-ResourceBundle.getString() lookup of NAME that potential overriding menu entries can be identified (i.e., "menu.View.Weather.Wind")
    - PRE_LOCALIZED_MENU_HIERARCHY - the array of localization tag names for the menu names in hierarchical order to contain this menu entry (i.e., { "menu.View", "menu.View.Weather" })
    - SMALL_ICON (optional) - to label the menu entry
    Other properties defined by Action or this class may also be specified. In particular, "selected" triggers use of JCheckBoxMenuItem or JRadioButtonMenuItem, and "BUTTON_GROUP_NAME" differentiates between them (JRadioButtonMenuItems are always associated with ButtonGroups).
    Overrides:
    
    getMenuItems in class Provider
    
    Returns:
    
    array of Action objects
    
    See Also:
    
    AbstractMenuAction, AbstractPopupMenuAction
  - getAboutAttributions
```
public java.lang.String[] getAboutAttributions()
```
    Specify attributions, credits/acknowledgements, and license references to be displayed in the About dialog box. This method is called when the Help->About menu choice is selected.
    
    Overrides:
    
    getAboutAttributions in class Provider
    
    Returns:
    
    array of localized Strings, each containing one attribution or acknowledgement
  - getHelpSet
```
public javax.help.HelpSet getHelpSet()
```
    Provide the base HelpSet for complete online documentation.
    
    Overrides:
    
    getHelpSet in class Provider
    
    Returns:
    
    a JavaHelp HelpSet to merge if this Provider has one
  - getImageIconPath
```
public java.lang.String getImageIconPath()
```
    Return an icon image associated with this Provider.
    
    Overrides:
    
    getImageIconPath in class Provider
    
    Returns:
    
    String relative pathname for this Provider's icon image, or null for no icon
  - runInitializersAfter
```
public void runInitializersAfter()
```
    Execute this function after calling all of the other functions of the CoreProvider. This allows any Provider-specific initialization to run after menus and drivers are loaded, such as registering the standard query handlers, starting the mini-webserver, and connecting some of the core event listeners to their\ event generators.
    
    Overrides:
    
    runInitializersAfter in class Provider
    
    See Also:
    
    APRSStack.addAprsMessageListener(org.ka2ddo.aprs.AprsMessageListener), AX25Stack.addAX25FrameListener(org.ka2ddo.ax25.AX25FrameListener), MsgEventDispatcher.addMsgEventListener(org.ka2ddo.yaac.ax25.MsgEventListener), StationTracker.addTrackerListener(org.ka2ddo.yaac.ax25.TrackerListener)
  - getCoreWebServer
```
public HttpServer getCoreWebServer()
```
    Get the web server instance associated with the core services of YAAC.
    
    Returns:
    
    HttpServer instance
  - hasRXTX
```
public boolean hasRXTX()
```
    Report whether this plugin was able to load the (now obsolete) RXTX native library for accessing serial ports. Note this will only report a meaningful value after the getPortConnectorTypes() method has been called.
    
    Returns:
    
    boolean true if RXTX native library was loaded successfully
    
    See Also:
    
    getPortConnectorTypes()
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    Return a standard string for identifying this installation of YAAC to a web server in the User-Agent HTTP header property. This will provide operating system, Java runtime version, and locale information to the author to help him direct internationalization support for future YAAC development; the personal identity of the user in that country using that operating system will not be reported.
    
    Returns:
    
    String to specify as the value of User-Agent
  - isNonencryptedHTTPForced
```
public boolean isNonencryptedHTTPForced()
```
    Indicate if YAAC is configured to support Internet networks prohibiting encrypted traffic (such as the Amateur Radio HSMM [High-Speed MultiMedia] networks). If so, only plain HTTP will be used instead of HTTPS; if the requested service only operates over HTTPS, the user will be informed that encrypted requests cannot be made.
    
    Returns:
    
    boolean true if only unencrypted HTTP may be used for web requests
  - setNonencryptedHTTPForced
```
public void setNonencryptedHTTPForced(boolean onlyHTTP)
```
    Specify if YAAC is configured to support Internet networks prohibiting encrypted traffic. If so, only plain HTTP will be used instead of HTTPS; if the requested service only operates over HTTPS, the user will be informed that encrypted requests cannot be made.
    
    Parameters:
    
    onlyHTTP - boolean true if only unencrypted HTTP may be used for web requests
  - isIPv4Forced
```
public static boolean isIPv4Forced()
```
    Indicate if YAAC is configured to support Internet networks supporting IPv6. Some Internet Service Providers are not up-to-date and only support IPv4 network addresses and protocols.
    
    Returns:
    
    boolean true if only IPv4 addresses will be used for socket connections
    
    Since:
    
    PROVIDER_API_VERSION == 22
  - setIPv4Forced
```
public static void setIPv4Forced(boolean onlyIPv4)
```
    Specify if YAAC is configured to support Internet networks supporting IPv6. Some Internet Service Providers are not up-to-date and only support IPv4 network addresses and protocols.
    
    Parameters:
    
    onlyIPv4 - boolean true if only IPv4 addresses will be used for socket connections
    
    Since:
    
    PROVIDER_API_VERSION == 22
  - main
```
public static void main(java.lang.String[] args)
```
    Method to allow printing out version of YAAC (alternative to YAAC class's -version command-line option).
    
    Parameters:
    
    args - ignored

Class CoreProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.pluginapi.Provider

Field Summary

Fields inherited from class org.ka2ddo.yaac.pluginapi.Provider

Method Summary

Methods inherited from class org.ka2ddo.yaac.pluginapi.Provider

Methods inherited from class java.lang.Object

Field Detail

TOP_MENU

EXIT_ACTION

PRE_LOCALIZED_FILE_LOAD_MENU

PRE_LOCALIZED_FILE_SAVE_MENU

PRE_LOCALIZED_VIEW_MENU

PRE_LOCALIZED_VIEW_PACKETS_MENU

PRE_LOCALIZED_VIEW_STATIONS_MENU

PRE_LOCALIZED_VIEW_OBJECTS_MENU

PRE_LOCALIZED_VIEW_LAYERS_MENU

PRE_LOCALIZED_FILTER_MENU

PRE_LOCALIZED_LOCATE_MENU

MENU_VIEW_DRAW_TOOLBAR

Method Detail

getInstance

getPortConnectorTypes

getConfigurationPanels

getFilters

getLocalOSMChangeSet

getListOfServerTileDirs

getServerOSMChangeSet

getMenuItems

getAboutAttributions

getHelpSet

getImageIconPath

runInitializersAfter

getCoreWebServer

hasRXTX

getUserAgent

isNonencryptedHTTPForced

setNonencryptedHTTPForced

isIPv4Forced

setIPv4Forced

main