OpenSSRF Reference Software Implementation v0.2.0

Copyright © 2014 Software Defined Radio Forum, Inc. All Rights
Wireless Innovation Forum Document Number WINNF-14-I-0018-V1.0.0
Committee: Spectrum Innovation Committee
Title: OpenSSRF Software Library V0.2
Source
Name: Jesse Caulfield
Organization: Key Bridge Global LLC
Address: 1600 Tysons Blvd., Suite 1100, McLean, VA 22102
Phone: +1 (703) 414-3500
Email: jesse.caulfield@keybridgeglobal.com
Date: September 15, 2014
Distribution: Public Release
Summary: This updates and supercedes the May 26 contribution
Impacts/Effects: Open Software Development Group
Action Desired: Public release
Action Required for Closure: None
Desired Disposition Date: 15 September 2014
Wireless Innovation Forum Contribution
Slide 1

OpenSSRF Software Library
V0.2
Document WINNF-14-I-0018
Version V1.0.0
15 September 2014
Slide 2

Terms and Conditions
Slide 3
This document and associated software source code package (the “reference design”) have been
prepared by Key Bridge Global LLC to assist The Software Defined Radio Forum Inc. (or its
successors or assigns, hereafter “the Forum”). It may be amended or withdrawn at a later time
and it is not binding on any member of the Forum or of Key Bridge Global LLC.
Contributors to this reference design have submitted copyrighted materials (the Submission) to
the Forum for use in this reference design retain copyright ownership of their original work,
while at the same time granting the Forum a non-exclusive, irrevocable, worldwide, perpetual,
royalty-free license under the Submitter’s copyrights in the Submission to reproduce, distribute,
publish, display, perform, and create derivative works of the Submission based on that original
work for under the Forum's own copyright.
Permission is granted to the Forum’s participants by Key Bridge Global to reuse the reference
design royalty free under the MIT License. Reuse is permitted within other proprietary software
developed by participants provided all copies of the licensed software include a copy of the MIT
License terms. Such proprietary software retains its proprietary nature even though it
incorporates software under the MIT License.

Intellectual Property Rights
Slide 4
THIS DOCUMENT IS BEING OFFERED WITHOUT ANY WARRANTY
WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NON-
INFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS
SPECIFICATION SHALL BE MADE ENTIRELY AT THE
IMPLEMENTER'S OWN RISK, AND NEITHER THE FORUM, NOR ANY
OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY
WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY
DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR
INDIRECTLY, ARISING FROM THE USE OF THIS DOCUMENT.
Recipients of this document are requested to submit, with their comments,
notification of any relevant patent claims or other intellectual property rights of
which they may be aware that might be infringed by any implementation of the
specification set forth in this document, and to provide supporting
documentation.

Domain TwoDomain One
SSRF includes information classification to limit distribution but …
SSRF is designed to convey details
IEEE 1900.5.2 Spectrum Consumption Model has compatibility with abstraction
Abstraction is helpful when crossing security domains
SSRF data input is required for a Spectrum Access System (SAS)
Expect to use SSRF within a domain and SCM to cross domains
Expect to use SSRF to convey details and SCM to determine compatibility
OpenSSRF In Context
Slide 5
SSRF
A
B
C SAS SSRF
E
F
DSASSCM

• Query & Provide Reference Data
• Table Of Allocation data, definitions and footnotes
• Codes and code definitions for pick-list categories
• Channel plan data & details used in a TOA
• Define Transmitters, Receivers and Antennas
• Define, store and exchange operating details and equipment parameters
• Spectrum Supportability Process
• Information pull to research existing occupancy
• SSRequest to request spectrum resources
• SSReply to provide supportability information
• Request & Provide Frequency Allotments & Assignments
• Allotments to enable decentralized frequency management
• Assignments to authorize a specific device
• Report Interference
SSRF Supported Business Processes
Slide 6
Included
Focus
Focus

Working towards a certifiably compliant reference
implementation of the Standard Spectrum Resource
Format (SSRF) specification (version 3.x)
The previous release (May 26, 2014) is Version 0.1
This release (September 15, 2014) is Version 0.2
• Updates and supercedes but is backwards compatible V0.1
• More tailored, customized and streamlined implementation
• Focus on usability and developer access
OpenSSRF Project Status
Slide 7

V 0.1 First compile
• Develop familiarity and start working with the data model
• Foster information exchange and collaboration
V 0.2 Usable software
• Build and manipulate SSRF data structures
• Read, write and validate SSRF data fields
V 0.3 Proof of concept
• Automated conversion of raw data source(s) to SSRF
• Programmatic management of indexes, serial numbers, etc.
…
V 1.0 Compliant reference implementation
• Automated read, write, validate SSRF data structures
• Incorporate automation and other utilities
OpenSSRF Development Roadmap
Slide 8

• 471 classes organized into 15 packages
• Each class is a structured software container for
different types data
• 1 class is the single point of entry: “SSRF”
• 22 “top level” classes under SSRF
You can use this software library to read,
write and manipulate SSRF data structures
from within your own application
• All known business processes supported
OpenSSRF V0.2 Release Overview
Slide 9

Strict data type field validation
• Ensure data types are valid and correctly formatted
Correct handling of pick lists
• Pick list support now matches the specification text: required where
required, optional where optional
Software packaging and organization
• 417 classes organized into 15 logical, hierarchical packages
Software abstraction and simplification
• Metadata and common attributes are consolidated and inherited by
implementation, making the code easier to understand and use
Developer features
• Single point of entry: “SSRF” enables automated processing
• Fluent-programming interface reduces the learning curve
OpenSSRF V0.2 Key Features
Slide 10

Content validation
• Each data field is validated but an aggregate SSRF data structure
may be malformed or incomplete
Patterned fields
• Serial numbers and other string patterns should be automatically
generated
Indexed cross-referencing
• Data element cross reference indices should be managed
programmatically
External references
• Software hooks needed to support third-party implementations
Metadata configuration
• Metadata should be assignable via a global preferences or
configuration resource
OpenSSRF V0.2 NOT in this Release
Slide 11

OpenSSRF V0.2 Highlights
SSRF ssrf = new SSRF()
.withContact(new Contact()
.withEMail(new EMail()
.withAddress("john.doe@internet.com"))
.withLastName("Doe")
.withFirstName("John")
.withTelephoneFax(new TelephoneFax()
.withNumber("(123)456.7890“)))
.withAssignment(new Assignment()
.withCaseNum(new CaseNum()
.withType("callsign")
.withIdentifier("CFDB-TV")
.withCountry(ListCAO.CAN)));
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ssrf xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:us="urn:us:gov:dod:standard:ssrf:3.0.0">
<us:Contact>
<us:FirstName>John</us:FirstName>
<us:LastName>Doe</us:LastName>
<us:TelephoneFax>
<Number>(123)456.7890</Number>
</us:TelephoneFax>
<us:EMail>
<Address>john.doe@internet.com</Address>
</us:EMail>
</us:Contact>
<us:Assignment>
<us:CaseNum>
<Country>Canada</Country>
<Type>callsign</Type>
<Identifier>CFDB-TV</Identifier>
</us:CaseNum>
</us:Assignment>
</ssrf>
Slide 12
Java Input: EASY XML Output: VALID

1: Automated Conversion of Raw Data
• JSC has produced a FCC ULS to SSRF translation matrix
• No public FCC ULS reference implementation
• Instead use CANADA broadcast database for reference
Key Bridge will contribute a CANADA to SSRF translation
utility, which includes:
• Reference software to read and manipulate Industry Canada BDBS data
• Web service to query and retrieve RAW BDBS data
• Web service to query and retrieve BDBS records in SSRF format
Suggestions and contributions for other data
sources welcome
OpenSSRF V0.3 Next Steps
Slide 13

2: Programmatic management of indexes,
serial numbers, etc.
• Key Bridge will start working on this as-we-go.
• Software contributions welcome – fork the code
3: Validate SSRF data structures
• Need additional guidance from JSC
• Implemented as post-processing software utility or XML
Validation rule
• Software contributions welcome – fork the code
OpenSSRF V0.3+ Next Steps
Slide 14

Published and available via the WinForum at:
http://groups.winnforum.org/reference_implementat
ions
OpenSSRF V0.2 Source Code
Slide 15

Industry Canada BDBS: Broadcast Data Extract (AM-FM-TV)
This data source provides a cleaned and normalized version of the Industry
Canada Broadcast (AM-FM-TV) database system, commonly called BDBS.
The BDBS database provides programmatic access to technical details for all
licensed AM, FM, TV and SDAR transmitters approved for operation within
Canada.
Key Bridge BDBS Web Service & Documentation:
https://keybridgeglobal.com/data/documentation/source/bdbs.xhtml
Key Bridge BDBS Software Library:
https://github.com/KeyBridge/lib-ic-broadcast
OpenSSRF Supporting Resources
Slide 16

OpenSSRF Reference Software Implementation v0.2.0

Recommended

Recommended

More Related Content

What's hot

What's hot (18)

Viewers also liked

Viewers also liked (18)

Similar to OpenSSRF Reference Software Implementation v0.2.0

Similar to OpenSSRF Reference Software Implementation v0.2.0 (20)

Recently uploaded

Recently uploaded (20)

OpenSSRF Reference Software Implementation v0.2.0