Package com.tangosol.net.management

Interface MapJsonBodyHandler

All Superinterfaces:

com.tangosol.internal.http.BaseHttpHandler.BodyWriter<Map<String,Object>>, Comparable<MapJsonBodyHandler>

public interface MapJsonBodyHandler
extends com.tangosol.internal.http.BaseHttpHandler.BodyWriter<Map<String,Object>>, Comparable<MapJsonBodyHandler>

A class that can serialize and deserialize Maps to and from json.

Since:

22.06

Author:

Jonathan Knight 2022.01.25

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PRIORITY	The default priority.

Method Summary

Modifier and Type	Method	Description
default int	compareTo(MapJsonBodyHandler o)
static MapJsonBodyHandler	ensureMapJsonBodyHandler()	Load a MapJsonBodyHandler using the JVM's ServiceLoader mechanism.
default int	getPriority()	Return the priority of this MapJsonBodyHandler.
default boolean	isEnabled()	Return true if this MapJsonBodyHandler is enabled.
Map<String,Object>	readMap(InputStream in)	Read a json InputStream and deserialize into a Map.
void	write(Map<String,Object> body, OutputStream out)	Write the specified Object to the OutputStream.

Field Detail

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

The default priority.

See Also:

Constant Field Values

Method Detail

write

void write(Map<String,Object> body,
           OutputStream out)

Description copied from interface: com.tangosol.internal.http.BaseHttpHandler.BodyWriter

Write the specified Object to the OutputStream.

Specified by:

write in interface com.tangosol.internal.http.BaseHttpHandler.BodyWriter<Map<String,Object>>

Parameters:

body - the object to write

out - the OutputStream to write to

readMap

Map<String,Object> readMap(InputStream in)

Read a json InputStream and deserialize into a Map.

Parameters:

in - the InputStream containing json data

Returns:

a Map of the deserialized json data

isEnabled

default boolean isEnabled()

Return true if this MapJsonBodyHandler is enabled.

Returns:

true if this MapJsonBodyHandler is enabled

getPriority

default int getPriority()

Return the priority of this MapJsonBodyHandler.

The priority is used to determine which instance to use if multiple implementations are loaded by the service loader. The implementation that returns the lowest priority will be used.

The default implementation of this method returns DEFAULT_PRIORITY.

Returns:

the priority of this MapJsonBodyHandler

compareTo

default int compareTo(MapJsonBodyHandler o)

Specified by:

compareTo in interface Comparable<MapJsonBodyHandler>

ensureMapJsonBodyHandler

static MapJsonBodyHandler ensureMapJsonBodyHandler()

Load a MapJsonBodyHandler using the JVM's ServiceLoader mechanism.

Returns:

a MapJsonBodyHandler loaded via the ServiceLoader

Throws:

IllegalStateException - if no MapJsonBodyHandler can be loaded