com.apicatalog.jcs

Class JsonCanonicalizer

java.lang.Object

com.apicatalog.jcs.JsonCanonicalizer

public final class JsonCanonicalizer
extends Object

An implementation of the RFC 8785 JSON Canonicalization Scheme (JCS) specification in Java.

This class utilizes Jakarta JSON Processing as input for canonicalization. The canonicalized JSON output is written to a provided Writer.

Usage:

 canonize(JsonValue, Writer)
 

Constructor Summary

Constructors

Constructor and Description
JsonCanonicalizer()

Method Summary

Modifier and Type	Method and Description
static String	canonize(jakarta.json.JsonValue value) Canonicalizes a JSON value according to the RFC 8785 JSON Canonicalization Scheme (JCS) and returns the canonicalized JSON as a string.
static void	canonize(jakarta.json.JsonValue value, Writer writer) Canonicalizes a JSON according to the RFC 8785 JSON Canonicalization Scheme (JCS).
static void	canonizeArray(jakarta.json.JsonArray value, Writer writer) Canonicalizes a JSON array according to the RFC 8785 JSON Canonicalization Scheme (JCS).
static void	canonizeNumber(jakarta.json.JsonNumber number, Writer writer) Canonicalizes a JSON number according to the RFC 8785 JSON Canonicalization Scheme (JCS).
static String	escape(String value) Escapes special characters in a JSON property name according to JSON canonicalization rules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonCanonicalizer

public JsonCanonicalizer()

Method Detail

canonize

public static final String canonize(jakarta.json.JsonValue value)

Canonicalizes a JSON value according to the RFC 8785 JSON Canonicalization Scheme (JCS) and returns the canonicalized JSON as a string.

This method serializes the given JsonValue in a deterministic and standardized manner, ensuring a consistent output regardless of formatting differences. It handles all JSON value types, including objects, arrays, numbers, strings, and literals (true, false, null).

Parameters:

value - the JSON value to be canonicalized

Returns:

a string containing the canonicalized JSON representation of the input value

canonize

public static final void canonize(jakarta.json.JsonValue value,
                                  Writer writer)
                           throws IOException

Canonicalizes a JSON according to the RFC 8785 JSON Canonicalization Scheme (JCS).

This method serializes the given JsonValue in a deterministic and standardized manner, ensuring a consistent output regardless of formatting differences. The canonicalized JSON is written to the provided Writer.

This method handles different JSON value types, including objects, arrays, numbers, strings, and literals (true, false, null).

Parameters:

value - the JSON value to be canonicalized

writer - the writer to which the canonicalized JSON output is written

Throws:

IOException - if an I/O error occurs while writing to the writer

canonizeNumber

public static final void canonizeNumber(jakarta.json.JsonNumber number,
                                        Writer writer)
                                 throws IOException

Canonicalizes a JSON number according to the RFC 8785 JSON Canonicalization Scheme (JCS).

This method serializes the given JsonNumber in a deterministic and standardized manner, ensuring a consistent numeric representation. The canonicalized number is written to the provided Writer.

Parameters:

number - the JSON number to be canonicalized

writer - the writer to which the canonicalized JSON output is written

Throws:

IOException - if an I/O error occurs while writing to the writer

canonizeArray

public static final void canonizeArray(jakarta.json.JsonArray value,
                                       Writer writer)
                                throws IOException

Canonicalizes a JSON array according to the RFC 8785 JSON Canonicalization Scheme (JCS).

This method serializes the given JsonArray in a deterministic and standardized manner, ensuring a consistent output. The canonicalized JSON array is written to the provided Writer.

Parameters:

value - the JSON array to be canonicalized

writer - the writer to which the canonicalized JSON output is written

Throws:

IOException - if an I/O error occurs while writing to the writer

escape

public static final String escape(String value)

Escapes special characters in a JSON property name according to JSON canonicalization rules.

This method ensures that control characters and other necessary characters are properly escaped to maintain a valid and consistent JSON representation.

Parameters:

value - the JSON property name to escape

Returns:

the escaped property name