Skip to content

Commit f54b644

Browse files
ts5746ts5746
committed
Additional testing and improvements
1 parent 72ce720 commit f54b644

14 files changed

Lines changed: 137 additions & 58 deletions

File tree

‎docs/javadoc/index-all.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -804,14 +804,14 @@ <h2 class="title" id="I:I">I</h2>
804804
<dd>
805805
<div class="block">Infrastructure Sign message type</div>
806806
</dd>
807-
<dt><a href="org/whiteflagprotocol/java/util/WfJsonValidator.html#inspectJsonNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">inspectJsonNode(JsonNode)</a> - Static method in class org.whiteflagprotocol.java.util.<a href="org/whiteflagprotocol/java/util/WfJsonValidator.html" title="class in org.whiteflagprotocol.java.util">WfJsonValidator</a></dt>
808-
<dd>
809-
<div class="block">Inspects a JSON node for errors against the Whiteflag JSON message schema</div>
810-
</dd>
811807
<dt><a href="org/whiteflagprotocol/java/util/WfJsonValidator.html#inspectMessage(org.whiteflagprotocol.java.util.WfJsonMessage)" class="member-name-link">inspectMessage(WfJsonMessage)</a> - Static method in class org.whiteflagprotocol.java.util.<a href="org/whiteflagprotocol/java/util/WfJsonValidator.html" title="class in org.whiteflagprotocol.java.util">WfJsonValidator</a></dt>
812808
<dd>
813809
<div class="block">Inspects a Whiteflag JSON message for errors against the Whiteflag JSON message schema</div>
814810
</dd>
811+
<dt><a href="org/whiteflagprotocol/java/util/WfJsonValidator.html#inspectNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">inspectNode(JsonNode)</a> - Static method in class org.whiteflagprotocol.java.util.<a href="org/whiteflagprotocol/java/util/WfJsonValidator.html" title="class in org.whiteflagprotocol.java.util">WfJsonValidator</a></dt>
812+
<dd>
813+
<div class="block">Inspects a JSON node for errors against the Whiteflag JSON message schema</div>
814+
</dd>
815815
<dt><a href="org/whiteflagprotocol/java/core/WfBinaryBuffer.html#isComplete()" class="member-name-link">isComplete()</a> - Method in class org.whiteflagprotocol.java.core.<a href="org/whiteflagprotocol/java/core/WfBinaryBuffer.html" title="class in org.whiteflagprotocol.java.core">WfBinaryBuffer</a></dt>
816816
<dd>
817817
<div class="block">Checks if the buffer is marked as complete and cannot be altered</div>
@@ -1264,14 +1264,14 @@ <h2 class="title" id="I:V">V</h2>
12641264
<dd>
12651265
<div class="block">Validates the JSON representation of the Whiteflag message</div>
12661266
</dd>
1267-
<dt><a href="org/whiteflagprotocol/java/util/WfJsonValidator.html#validateJsonNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">validateJsonNode(JsonNode)</a> - Static method in class org.whiteflagprotocol.java.util.<a href="org/whiteflagprotocol/java/util/WfJsonValidator.html" title="class in org.whiteflagprotocol.java.util">WfJsonValidator</a></dt>
1268-
<dd>
1269-
<div class="block">Validates a JSON node against the Whiteflag JSON message schema</div>
1270-
</dd>
12711267
<dt><a href="org/whiteflagprotocol/java/util/WfJsonValidator.html#validateMessage(org.whiteflagprotocol.java.util.WfJsonMessage)" class="member-name-link">validateMessage(WfJsonMessage)</a> - Static method in class org.whiteflagprotocol.java.util.<a href="org/whiteflagprotocol/java/util/WfJsonValidator.html" title="class in org.whiteflagprotocol.java.util">WfJsonValidator</a></dt>
12721268
<dd>
12731269
<div class="block">Validates a Whiteflag JSON message against the Whiteflag JSON message schema</div>
12741270
</dd>
1271+
<dt><a href="org/whiteflagprotocol/java/util/WfJsonValidator.html#validateNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">validateNode(JsonNode)</a> - Static method in class org.whiteflagprotocol.java.util.<a href="org/whiteflagprotocol/java/util/WfJsonValidator.html" title="class in org.whiteflagprotocol.java.util">WfJsonValidator</a></dt>
1272+
<dd>
1273+
<div class="block">Validates a JSON node against the Whiteflag JSON message schema</div>
1274+
</dd>
12751275
<dt><a href="org/whiteflagprotocol/java/core/WfMessageCodec.Encoding.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class org.whiteflagprotocol.java.core.<a href="org/whiteflagprotocol/java/core/WfMessageCodec.Encoding.html" title="enum class in org.whiteflagprotocol.java.core">WfMessageCodec.Encoding</a></dt>
12761276
<dd>
12771277
<div class="block">Returns the enum constant of this class with the specified name.</div>

‎docs/javadoc/member-search-index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/javadoc/org/whiteflagprotocol/java/util/WfJsonValidator.html‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -99,25 +99,25 @@ <h2>Method Summary</h2>
9999
<div class="table-header col-first">Modifier and Type</div>
100100
<div class="table-header col-second">Method</div>
101101
<div class="table-header col-last">Description</div>
102-
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;com.networknt.schema.ValidationMessage&gt;</code></div>
103-
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#inspectJsonNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">inspectJsonNode</a><wbr>(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</code></div>
102+
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
103+
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#inspectMessage(org.whiteflagprotocol.java.util.WfJsonMessage)" class="member-name-link">inspectMessage</a><wbr>(<a href="WfJsonMessage.html" title="class in org.whiteflagprotocol.java.util">WfJsonMessage</a>&nbsp;jsonMessage)</code></div>
104104
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
105-
<div class="block">Inspects a JSON node for errors against the Whiteflag JSON message schema</div>
105+
<div class="block">Inspects a Whiteflag JSON message for errors against the Whiteflag JSON message schema</div>
106106
</div>
107-
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;com.networknt.schema.ValidationMessage&gt;</code></div>
108-
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#inspectMessage(org.whiteflagprotocol.java.util.WfJsonMessage)" class="member-name-link">inspectMessage</a><wbr>(<a href="WfJsonMessage.html" title="class in org.whiteflagprotocol.java.util">WfJsonMessage</a>&nbsp;jsonMessage)</code></div>
107+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
108+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#inspectNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">inspectNode</a><wbr>(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</code></div>
109109
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
110-
<div class="block">Inspects a Whiteflag JSON message for errors against the Whiteflag JSON message schema</div>
110+
<div class="block">Inspects a JSON node for errors against the Whiteflag JSON message schema</div>
111111
</div>
112112
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final boolean</code></div>
113-
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateJsonNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">validateJsonNode</a><wbr>(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</code></div>
113+
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateMessage(org.whiteflagprotocol.java.util.WfJsonMessage)" class="member-name-link">validateMessage</a><wbr>(<a href="WfJsonMessage.html" title="class in org.whiteflagprotocol.java.util">WfJsonMessage</a>&nbsp;jsonMessage)</code></div>
114114
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
115-
<div class="block">Validates a JSON node against the Whiteflag JSON message schema</div>
115+
<div class="block">Validates a Whiteflag JSON message against the Whiteflag JSON message schema</div>
116116
</div>
117117
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final boolean</code></div>
118-
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateMessage(org.whiteflagprotocol.java.util.WfJsonMessage)" class="member-name-link">validateMessage</a><wbr>(<a href="WfJsonMessage.html" title="class in org.whiteflagprotocol.java.util">WfJsonMessage</a>&nbsp;jsonMessage)</code></div>
118+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateNode(com.fasterxml.jackson.databind.JsonNode)" class="member-name-link">validateNode</a><wbr>(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</code></div>
119119
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
120-
<div class="block">Validates a Whiteflag JSON message against the Whiteflag JSON message schema</div>
120+
<div class="block">Validates a JSON node against the Whiteflag JSON message schema</div>
121121
</div>
122122
</div>
123123
</div>
@@ -150,9 +150,9 @@ <h3>validateMessage</h3>
150150
</section>
151151
</li>
152152
<li>
153-
<section class="detail" id="validateJsonNode(com.fasterxml.jackson.databind.JsonNode)">
154-
<h3>validateJsonNode</h3>
155-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">validateJsonNode</span><wbr><span class="parameters">(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</span></div>
153+
<section class="detail" id="validateNode(com.fasterxml.jackson.databind.JsonNode)">
154+
<h3>validateNode</h3>
155+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">validateNode</span><wbr><span class="parameters">(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</span></div>
156156
<div class="block">Validates a JSON node against the Whiteflag JSON message schema</div>
157157
<dl class="notes">
158158
<dt>Parameters:</dt>
@@ -165,7 +165,7 @@ <h3>validateJsonNode</h3>
165165
<li>
166166
<section class="detail" id="inspectMessage(org.whiteflagprotocol.java.util.WfJsonMessage)">
167167
<h3>inspectMessage</h3>
168-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;com.networknt.schema.ValidationMessage&gt;</span>&nbsp;<span class="element-name">inspectMessage</span><wbr><span class="parameters">(<a href="WfJsonMessage.html" title="class in org.whiteflagprotocol.java.util">WfJsonMessage</a>&nbsp;jsonMessage)</span></div>
168+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">inspectMessage</span><wbr><span class="parameters">(<a href="WfJsonMessage.html" title="class in org.whiteflagprotocol.java.util">WfJsonMessage</a>&nbsp;jsonMessage)</span></div>
169169
<div class="block">Inspects a Whiteflag JSON message for errors against the Whiteflag JSON message schema</div>
170170
<dl class="notes">
171171
<dt>Parameters:</dt>
@@ -176,9 +176,9 @@ <h3>inspectMessage</h3>
176176
</section>
177177
</li>
178178
<li>
179-
<section class="detail" id="inspectJsonNode(com.fasterxml.jackson.databind.JsonNode)">
180-
<h3>inspectJsonNode</h3>
181-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;com.networknt.schema.ValidationMessage&gt;</span>&nbsp;<span class="element-name">inspectJsonNode</span><wbr><span class="parameters">(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</span></div>
179+
<section class="detail" id="inspectNode(com.fasterxml.jackson.databind.JsonNode)">
180+
<h3>inspectNode</h3>
181+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">inspectNode</span><wbr><span class="parameters">(com.fasterxml.jackson.databind.JsonNode&nbsp;jsonNode)</span></div>
182182
<div class="block">Inspects a JSON node for errors against the Whiteflag JSON message schema</div>
183183
<dl class="notes">
184184
<dt>Parameters:</dt>

‎docs/uml/errors.png‎

5.67 KB
Loading

‎docs/uml/errors.puml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ package org.whiteflagprotocol.java.core {
99

1010
package org.whiteflagprotocol.java {
1111
class WfException <<Throwable>>
12-
enum WfException.ErrorType {
12+
enum ErrorType {
1313
WF_PROTOCOL_ERROR
1414
WF_METADATA_ERROR
1515
WF_FORMAT_ERROR
@@ -18,20 +18,21 @@ package org.whiteflagprotocol.java {
1818
WF_SIGN_ERROR
1919
WF_ENCRYPTION_ERROR
2020
}
21-
WfException +-- WfException.ErrorType
21+
WfException +-- ErrorType
2222
}
2323

2424
package org.whiteflagprotocol.java.crypto {
2525
class WfCryptoException <<Throwable>>
2626
}
2727

2828
package org.whiteflagprotocol.java.util {
29+
class WfUtilRuntimeException <<Throwable>>
2930
class WfUtilException <<Throwable>>
30-
enum WfUtilException.ErrorType {
31+
enum ErrorType {
3132
WF_UTIL_ERROR
3233
WF_JSON_ERROR
3334
}
34-
WfUtilException +-- WfUtilException.ErrorType
35+
WfUtilException +-- ErrorType
3536
}
3637

3738
@enduml

‎docs/uml/messages.png‎

361 Bytes
Loading

‎docs/uml/messages.puml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,8 @@ WfJsonMessage <. WfMessage
156156
WfMessage *-- WfBasicMessage
157157
WfMessage ..> WfMessageCreator
158158

159+
WfBinaryBuffer <.. WfMessage
160+
159161
WfBasicMessage -- "1" WfMessageType
160162
WfBasicMessage *-- "2" WfMessageSegment
161163
WfMessageSegment *-- "*" WfMessageField

‎docs/uml/overview.png‎

14.4 KB
Loading

‎docs/uml/overview.puml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,17 @@ package org.whiteflagprotocol.java.crypto {
7373
package org.whiteflagprotocol.java.util {
7474
class WfJsonMessage {}
7575
class WfJsonSchema {}
76+
class WfJsonValidator {}
7677
}
7778

7879
WfMessage *-- "1" WfBasicMessage
7980
WfBasicMessage -- "1" WfMessageType
8081
WfBasicMessage *-- "2" WfMessageSegment
8182
WfMessageSegment *-- "*" WfMessageField
8283

83-
WfAccount -- WfMessage
84+
WfAccount --o WfMessage
85+
WfAccount --o WfMessage
86+
WfMessage <-- WfValidator
8487

8588
WfAccount --> WfAuthToken
8689
WfAccount --> WfEncryptionKey
@@ -89,6 +92,7 @@ WfAccount --> WfECDHKeyPair
8992
WfMessage ..> WfCipher
9093
WfJsonMessage <.. WfMessage
9194

92-
WfJsonSchema <.. WfValidator
95+
WfJsonSchema .. WfJsonValidator
96+
WfJsonValidator <.. WfValidator
9397

9498
@enduml

‎src/main/java/org/whiteflagprotocol/java/util/WfJsonMessage.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import com.fasterxml.jackson.annotation.JsonGetter;
1313
import com.fasterxml.jackson.annotation.JsonProperty;
1414
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
15+
import com.fasterxml.jackson.annotation.JsonInclude;
1516

1617
/* Required error types */
1718
import static org.whiteflagprotocol.java.util.WfUtilException.ErrorType.WF_JSON_ERROR;
@@ -29,6 +30,7 @@
2930
*
3031
* @since 1.0
3132
*/
33+
@JsonInclude(JsonInclude.Include.NON_NULL)
3234
@JsonPropertyOrder({ "MetaHeader", "MessageHeader", "MessageBody" })
3335
public class WfJsonMessage {
3436

0 commit comments

Comments
 (0)