1,234
edits
Changes
no edit summary
{{Admon/obsolete}} [[category: NexJ Current Past Projects]]
[[category: NexJ Express JSON Message Adapter]]
== Project Goal==
To create an adapter for the NexJ Core similar in methodology and design of existing message adapters (XML, Fixed, CSV etc.) but using the JSON format
* [[User:Gbatumbya|Grace Batumbya]]
* [[User:Brianlim | Brian Lim]]
== Current Status==
* '''Completed''' (February 02, 2012)
==Project PhasesRepository == JSON Integration Adapter Phases ===Phase IBitBucket : https://bitbucket. Research (DONE)=== # Complete Fundamentals of NexJ Studio tutorial# Complete NexJ Integration tutorial# Install NexJ Studio Express from sourceorg/gbatumbya/nexjexpress-jsonintergrationadapter/===Phase II<br/>Deprecated: <del>https://bitbucket. Planning and Approval (DONE)=== # Receive general approval for project# Receive approval for JSON encoding options# Receive approval for JSON formatting options ===Phase III. Message Formatter (80% DONE)=== # Add JSON to .XSD base types# Create sample JSON .message # Parse sample JSON .message with JUnit Test# Create first set of unit tests for Message Formatter# Code Message Formatter first draft# Resolve issues with first set of unit tests# Create second set of unit tests# Resolve issues with second set of unit tests# Refactor and code message formatter ===Phase IV. Message Parser === # Discover how to connect JSON RPC parser with Message Parser# Create first set of trivial unit tests for Message Parser# Code Message Parser skeleton# Pass first set of trivial unit tests# Create second set of unit tests (nonorg/b_lim/nexj-express-json-trivial) for Message Parser# Code Message Formatter first draft# Resolve issues with second set of unit tests# Refactor ===Phase V. Integration and Stress Tests=== # Test Message Formatter and Message Parser with integration and stress tests# Test through NexJ Studio Express GUI (manual testing) ===Phase VI. Internal Code Review=== # Internally review code at CDOT ===Phase VII. Optimization=== # Find more code optimizations relevant to Enterprise environments ===Phase VIII. First Code Review at NexJ=== # Date TBA ===Phase IX. Code Rewrite=== # Rewrite code to conform with NexJ suggestions and standards-adapter/</del>
{| class="wikitable" border==Phase XI"1"|-! Term! Description|-| Formatter| Turns data into JSON|-| Parser| Turns JSON into data|-| Message| The metadata to be used when formatting and parsing a message. The grammar. It is a tree-like structure. Project Completion===|-| MessageInstance| The information to be parsed or formatted|}
==== Message Fundamentals ====
Message - Messages can contain values or other messages. The red nodes are messages, the green nodes are values.
{
part = (MessagePart)it.next());
if (isCompositeMessagePartInstance(part)instanceof CompositeMessagePartInstance)
{
// This part is a message
}
else if (isPrimitiveMessagePart(part)instanceof PrimitiveMessagePart)
{
// This part is a value
NOTE: THE MESSAGE PARAMETER DOES NOT CONTAIN THE MESSAGE VALUES. THE MESSAGE PARAMETER CONTAINS THE MESSAGE METADATA. THE TRANSFER OBJECT CONTAINS THE MESSAGE VALUES WHICH MUST BE VALIDATED AGAINST THE MESSAGE TO ENSURE CORRECT FORMAT.
; MessagePart.java - :Parts of a message. Messages can contain values or other messages. Currently NexJ Express has two types of message parts, ''CompositeMessagePart.java '' and ''PrimitiveMessagePart.java ''.
; CompositeMessagePart.java : implementation is CompositeMessagePartInstance . The relationship between CompositeMessagePartInstance and PrimitiveMessagePart with the above picture is as follows : - CompositeMessagePartInstance are messages (the red nodes) and PrimitiveMessagePart are values (the green nodes).To determine multiplicity of MessageParts, use isCollection() method of MessagePart. Note that multiplicity of the above screenshot are all '''[0..1]''', that is zero or one instance. Possible node multiplicities:; '''[0..1]''' : zero or one instance (i.e. an optional entry); '''[1..1]''' : exactly one instance (i.e. required); '''[1..N]''' : collection of at least one, at most N instances; '''[0..0]''' : collection of zero to infinite instances (displayed as '''[*]'''); '''[1..0]''' : collection of at least one, possibly unlimited instances
==== Algorithm ====
## If the part is a CompositeMessagePartInstance, recursively call the format method with TransferObject set to the part. Suggested to overload the format method to format(TransferObject tobj, MessagePart message, Output out) and pass in the part, since retrieving a message root with getRoot() will always get the highest root of the message but what you want is the parent.
## If the part is a PrimitiveMessagePart, write the message part to the output.
==Project Phases==
===Phase 1. Research (DONE)===
# Complete Fundamentals of NexJ Studio tutorial
# Complete NexJ Integration tutorial
# Install NexJ Studio Express from source
===Phase 2. Design Proposal (DONE)===
# Receive general approval for project
# Receive approval for JSON encoding options
# Receive approval for JSON formatting options
# [https://docs.google.com/document/d/1wAjG-xSJi227GBPUZtADAROSydIn3KuimoZarqO7xDQ/edit?hl=en_US Final Project Proposal]
===Phase 3. Create Classes (DONE)===
# JSONMessagePartMapping
# XMLJSONMessageMappingLoader
# JSONMessageFormatter
# JSONMessageParser
# JSONMessageFormatterTest
===Phase 4. Internal Code Review (DONE)===
# Internally review code at CDOT
===Phase 5. Code Review 1 (DONE)===
# August 9, 2011
# Code review took place at NexJ with [[User:Gbatumbya|Grace Batumbya]], [[User:Brianlim | Brian Lim]] and Andrew Borzenko (NexJ Developer) in attendance.
===Phase 6. Apply Changes from Code Review 1===
# Estimated Duration: 3 Weeks (August 29, 2011)
# [[JSON_Integration_Adapter_Code_Review_1_Changes | Changes to make]]
'''Summary of [[JSON_Integration_Adapter_Code_Review_1_Changes | changes]]'''
# Allowing modes for all Composite message parts, not just the root.
# Refactoring methods to check for != right condition instead of checking for the wrong condition to throw an exception. (whitelist instead of blacklist)
# Formatting all primitives before writing or storing them (e.g. timestamps, decimal numbers.)
# Creating a RootJSONMessagePartMapping extending JSONMessagePartMapping
===Phase 7. Code Review 2===
* Proposed Date: Week of <del>September 23</del> October 15
===Phase 8. Apply Changes from Code Review 2===
*[[JSON_Integration_Adapter_Code_Review_2_Changes | Changes to make]]
===Phase 9. Code Review 3===
* Week of November 14
===Phase 10. Apply Changes from Code Review 3===
*[[JSON_Integration_Adapter_Code_Review_3_Changes | Changes to make]]
== Resources ==