[tor-bugs] #12869 [Onionoo]: protocol api separation

[Tor Bug Tracker & Wiki]

#12869: protocol api separation
-------------------------+----------------------
     Reporter:  iwakeh   |      Owner:  iwakeh
         Type:  task     |     Status:  assigned
     Priority:  normal   |  Milestone:
    Component:  Onionoo  |    Version:
   Resolution:           |   Keywords:
Actual Points:           |  Parent ID:
       Points:           |
-------------------------+----------------------

Comment (by iwakeh):

 This is a really long issue discussion, but it might come to a close soon:

 === little survey of other java/javascript clients ===
 **Atlas** and **Globe** use javascript and access the JSON protocol
 directly;
 Globe defines its own javascript objects for the protocol.

 The code of **Nos Oignons** I couldn't find.

 **AnOnionooid** the android java client accesses the protocol
 directly using org.json api.

 Well, for koninoo it's also direct access and no special objects
 for the protocol using javax.json. (And, I think I'll stick with
 that in order to keep it simple. In addition java 9 promises a lightweight
 json api (in java.util).)

 In total, the 'market' for an onionoo-protocol-api is not that big yet.

 === suggestion ===
 Onionoo could provide an interface api for the onionoo protocol, as you
 suggested in your comment above.

 This would be the more technical java description of the onionoo protocol.
 With sufficient Javadoc inside it could replace the contents of
 [https://onionoo.torproject.org/protocol.html protocol.html].

 This also provides some more modularization and abstraction, which
 could be helpful when switching to a db.
 If the need arises, a protocol library could be designed either in the
 Onionoo project
 or be provided by someone else using the interface api.

 So, what about creating an interface api for the onionoo protocol
 (for example in org.toproject.onionoo.protocol) and providing it as a
 separate jar?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/12869#comment:12>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online