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===-adapter/</del>
===Phase IX. Code Rewrite=Definitions ==
==== 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
</pre>
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. NexJ Express has two types of message parts, ''CompositeMessagePart'' and ''PrimitiveMessagePart''. ; CompositeMessagePart: 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 ; XMLJSONMessageMappingLoader: Used by the framework to autoload JSONMessagePartMapping for each of the message parts. ; JSONMessagePartMapping: Each node in the above picture ''may'' has a corresponding JSONMessagePartMapping. Each node may have its own mapping, with its own values initialized in XMLJSONMessageMappingLoader. In order to get the mapping, first cast MessagePart to a concrete class such as CompositeMessagePartInstance or PrimitiveMessagePart, then use part.getMapping(). The purpose of the mapping is metadata for each node. ; JSONMessageFormatter: Used to turn messages into JSON format. ; JSONMessageParser: Used to turn JSON into a message. ==== Algorithm ==== format(TransferObject tobj, Message message, Output out)Algorithm for format method is as follows# Retrieve the root of the message# Iterate through each of the parts of the root## If the part is a CompositeMessagePartInstance, it is a message node## If the part is a PrimitiveMessagePart, it is a value node## Validate the part against the MessagePartMapping. Different types of validation must be done if the part is a Composite versus if it is a Primitive.## 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]
== Resources ==
