Giter Club home page Giter Club logo

yongwang / fns-client Goto Github PK

View Code? Open in Web Editor NEW

This project forked from faa-swim/fns-client

0.0 1.0 0.0 59.26 MB

The System Wide Information Service (SWIM) Federal NOTAM System (FNS) Java Messaging Service (JMS) Reference Implementation (FnsClient) provides an example implementation on how to establish and maintain a local instance of the FNS NOTAM Database through the use of the FNS Initial Load (FIL) and SWIM FNS JMS services. FIL provides all active NOTAMS, via SFTP, that is required to initialize a NOTAM database and the SWIM JMS service provides, via JMS, NOTAM updates to keep the NOTAM database current. FIL also provides for re-initialization of a NOTAM database in the case of JMS service interruption.

License: Apache License 2.0

HTML 13.91% JavaScript 7.10% Java 78.98%

fns-client's Introduction

SWIM FNS JMS Reference Implementation (FnsClient)

Overview

The System Wide Information Service (SWIM) Federal NOTAM System (FNS) Java Messaging Service (JMS) Reference Implementation (FnsClient) provides an example implementation on how to establish and maintain a local instance of the FNS NOTAM Database through the use of the FNS Initial Load (FIL) and SWIM FNS JMS services. FIL provides all active NOTAMS, via SFTP, that is required to initialize a NOTAM database and the SWIM JMS service provides, via JMS, NOTAM updates to keep the NOTAM database current. FIL also provides for re-initialization of a NOTAM database in the case of JMS service interruption.

FnsClient Diagram

Contents

This repository includes the java source code for the FnsClient which consists of the following classes:

  • FnsClient: Main entry for the application.
  • FilClient: Obtains the FIL file via SFTP.
  • NotamDb: Provides all methods to create, put, and query the NOTAM database; supports H2 and PostgreSQL.
  • FnsJmsMessageWorker: Implementation of a JMS Message Worker used to process FNS Messages received from the SWIM AIM FNS JMS service and load into the NOTAM Database.
  • FnsMessage: Provides methods to marshal and unmarshal AIXM NOTAMs into a workable java object.
  • FnsRestApi: Implementation of a basic REST API to query the NOTAM Database.

Prerequisites

A SWIM subscription to the AIM FNS JMS service and credentials to access the AIM FIL service are required to run the FnsClient. These can be obtained via the SWIM Cloud Distribution Service (SCDS) by visiting scds.faa.gov, creating an account, and requesting a subscription for the AIM FNS service. In order for the FnsClient to run properly it is necessary to set up an AIM FNS subscription that receives all messages - any filters limiting which messages are received will cause the FnsClient to falsely identify missed messages. Once the subscription has been approved you will receive an email with instructions on how to request FIL credentials.

  • Built using JDK 11 and Maven

Building and Running

  1. Clone this repository including submodules
  2. Install submodule dependencies to your local maven repo
    • mvn clean install -f ./aixm-5.1/pom.xml
    • mvn clean install -f ./jms-client/pom.xml
    • mvn clean install -f ./swim-utilities/pom.xml
  3. Run mvn clean package
  4. Change to the target directory; cd target/FnsClient
  5. Modify the fnsClient.conf file and add the SWIM AIM FNS JMS and FIL connection details - FIL Cert needs to be in RSA (aka pem) format; conversion can been done via: ssh-keygen -p -N "" -m pem -f /path/to/key’
  6. Run the FnsClient; java -jar FnsClient.jar

Once the FnsClient has started and initialized, NOTAMS can be queried directly from the NOTAM database, via calling the rest api, or by the web ui as localhost:8080

Rest API

The FnsClient includes a basic REST API that can be used to query NOTAMS from the database. The API includes the following methods:

fns-client's People

Contributors

armfaactr avatar felixruble-faa-ctr avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.