JSON RPC Adapter Project

From CDOT Wiki
(Redirected from JSON Adapter Project)
Jump to: navigation, search
This page may be obsolete.
It contains historical information.

Project Goal

Develop an adapter to expose NexJ Express Server objects using JSON
- Final Project Proposal


Current Status

Project Completed

Project Phases

Phase 1: Design Proposal (Done)

  • Get requirements from NexJ
  • Incorporate requirements from NexJ into Design of JSON Adapater
  • Proposal proposal for review, make changes as by NexJ until approved

- Final Project Proposal

Phase 2: Coding (Done)

  • JSONMarshaller
    • Develop marshaller to transform NexJ Server Objects into JSON representation
  • JSONUnmarshaller
    • Develop an marshaller to transform JSON representation into NexJ Server Objects
  • JSON Server
    • Develop a JSON Server to expose NexJ Server objects in JSON
  • Demo application that interacts with the Server using JSON
    • Read Server Objects
    • Update Server Objects
    • Create Server objects

Phase 3: Code Review 1 (Done)

  • Send patch to NexJ for review

Phase 4: Make Changes as per Code Review 1 (Done)

  • Refactor JSONSever and TextServer to inherit from GenericCharacterStreamHTTPServer
  • Optimize marshaling of nested Pair objects
  • Rename variables and methods as per NexJ Developer's Guide

Phase 5: Code Review 2(Done)

  • Send patch to NexJ for review

Phase 6: Apply Changes per Code Review 2 (Done)

  • Minor Clean Up
    • Removed unnecessary files
    • Ensure all files use CRLF line-endings
  • Add Servlet Mapping to cert/web.xml
  • GenericCharacterStreamServer
    • Use abstract String getType() for creating error codes
    • Use getLogger() for lazy initialization of logger
  • TextServer
    • Members should be protected
  • JSONWriter
    • Methods names should start with "write"
  • JSONMarshaller
    • Remove unused methods
    • Remove isReferencable(), do lookup in TransferObject Marshaller
  • JSONUnmarshaller
    • Use JSONLookup to find unmarshllers
    • Create DetachableByteArrayOutputStream
    • Change logic in Base64Util.decode(String)
    • Use Base64Util.decode(String) to decode 64 streams
    • Only TO unmarshaller should use remove() otherwise use get() on m_jsonMap
    • Change instances of Collection.toArray() to use toArray(new Object[size])

Phase 7: Code Review 3 (Done)

  • Send patch to NexJ for review

Phase 8: Apply Changes per Code Review 3 (Done)

  • JSONWriter.java:
    • Can a StringBuilder be used instead of a StringBuffer? Maybe the same change can be done in TextMarshaller as well? The member field can still be called m_buffer. Using StringBuilder instead of StringBuffer avoids the synchronization overhead.
    • writeString: remove the unnecessary conversion to a character array; the length can be accessed via String.length().
  • JSONMarshaller.java
    • Can you fill in the comment for parameter "writer" on method "marshal" of interface Marshaller? It is currently marked with TODO.
    • You can use the string id err.rpc.mshType instead of err.rpc.json.mshType
    • Can you define the Timestamp marshaller first, then the java.util.Date marshaller? Vassiliy wanted the default framework type’s marshaller first, followed by its synonyms.
  • JSONParser.java
    • Putting parts of the error message in the error arguments Object array that is passed to fail() isn’t localizable. The error message should be part of the value of the string id. String ids are stored in the *.strings files. For string ids used by Java code, the .strings files are in core/src/nexj/core/meta/sys. You need to ensure that there is an entry in this file for each id that you use. These are then translated into French (and possibly other languages) by people who specialize in translating software interfaces. The only things passed in the error arguments Object array should be data.
    • There should be a blank line before break and return statements.
  • JSONUnmarshaller.java
    • For the castTo* methods, can you rename them to get* and have them take a String sKey argument, which is the key to lookup in m_valueMap? This will more closely follow what Vassiliy intended when he said “Rather than directly type casting values retrieved from json map, you can have unmsh accessor methods for the common types, which can also do error checking, so that one does not get a generic type cast error and wonder what went wrong and where.”
    • parseObject(): I don’t think you need separate branches of code for handling the first key in the iterator and subsequent keys. Also, for iteration, prefer for() to while().
  • JSONUnmarshallerException.java
    • The overload with (String sExpected, Class actual) isn’t localizable. Remove this overload and use the (String sErrCode, Object[] argArray) constructor. In JSONUnmarshaller get* methods, pass an Object[] of length two for the argArray. Ensure that both are strings.
    • Please add a string for err.rpc.json.unmsh.CastException to en.strings in core/src/nexj/core/meta/sys. The various parts of the string id should all start with lowercase letters, e.g. CastException à castException. Use a meaningful name instead of “CastException”—CastException is what it is, not what the error is.
  • JSONTests.java
    • testSerializeException doesn’t need to initialize the marshaller and unmarshaller: they are initialized already by setUp(), which is run before each test*() method.
    • please remove the parts of tests that are duplicated. For example, in testServerObjects() you test the serialization of a Symbol called sym, a PrivilegeSet of “480000”, and a PCodeFunction with code 0, 1, 2. But these have already been tested by the testSerializeRequestCheckJSON which uses the m_request object initialized by the superclass.
    • Use Primitive.createInteger, Primitive.createLong, etc. instead of new Integer(…), new Long(…), etc. where possible.

Phase 9: Code Review 4 (Done)

  • Send patch to NexJ for review

Phase 10: Apply Changes per Code Review 4 (Done)

  • The m_tokenValue used in some of the error messages won’t always be populated. For example, in parseArray(), m_tokenValue is used, but it will only be valid if the current token is TOKEN_ATOM.
  • The boolean.invalidToken error message can be removed and you can use just err.parse.unexpectedToken instead, as one doesn’t know for certain that the input is a Boolean. Same for null.invalidToken and number.invalidToken.
  • parseObject(): the if (sKey == null) check can never succeed, because instanceof should return false if its argument is null.

Phase 11: Code Review 5 (Done)

  • Send code for review