Package io.permazen.spring

Class KVStoreHttpMessageConverter

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<KVStore>

io.permazen.spring.KVStoreHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<KVStore>

public class KVStoreHttpMessageConverter
extends AbstractHttpMessageConverter<KVStore>

Spring HttpMessageConverter capable of encoding and decoding a KVStore. The KeyListEncoder class is used to compress common prefixes of consecutive keys.

See PermazenObjectHttpMessageConverter for a higher level API.

See Also:

• DetachedPermazenTransactionHttpMessageConverter
• PermazenObjectHttpMessageConverter

Field Summary

Fields

Modifier and Type	Field	Description
static final MediaType	DEFAULT_MIME_TYPE	Default MIME type supported by this instance: application/x-permazen-kvstore.

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor	Description
KVStoreHttpMessageConverter()	Constructor.
KVStoreHttpMessageConverter(MediaType... mimeTypes)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Long	getContentLength(KVStore kvstore, MediaType mediaType)
static Long	getKVStoreContentLength(KVStore kvstore)	Determine the content length of the given key/value store when encoded as payload.
protected KVStore	readInternal(Class<? extends KVStore> clazz, HttpInputMessage input)
static void	readKVStore(KVStore kvstore, HttpInputMessage input)	Decode a key/value store HTTP payload.
protected boolean	supports(Class<?> clazz)
protected void	writeInternal(KVStore kvstore, HttpOutputMessage output)
static void	writeKVStore(KVStore kvstore, HttpOutputMessage output)	Encode a key/value store HTTP payload.

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canRead, canWrite, canWrite, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter

getSupportedMediaTypes

Field Details

DEFAULT_MIME_TYPE

public static final MediaType DEFAULT_MIME_TYPE

Default MIME type supported by this instance: application/x-permazen-kvstore.

Constructor Details

KVStoreHttpMessageConverter

public KVStoreHttpMessageConverter()

Constructor.

Configures this instance for the DEFAULT_MIME_TYPE.

KVStoreHttpMessageConverter

public KVStoreHttpMessageConverter(MediaType... mimeTypes)

Constructor.

Parameters:

mimeTypes - supported MIME type(s)

Method Details

getContentLength

protected Long getContentLength(KVStore kvstore,
 MediaType mediaType)

Overrides:

getContentLength in class AbstractHttpMessageConverter<KVStore>

supports

protected boolean supports(Class<?> clazz)

Specified by:

supports in class AbstractHttpMessageConverter<KVStore>

readInternal

protected KVStore readInternal(Class<? extends KVStore> clazz,
 HttpInputMessage input)
                        throws IOException

Specified by:

readInternal in class AbstractHttpMessageConverter<KVStore>

Throws:

IOException

writeInternal

protected void writeInternal(KVStore kvstore,
 HttpOutputMessage output)
                      throws IOException

Specified by:

writeInternal in class AbstractHttpMessageConverter<KVStore>

Throws:

IOException

getKVStoreContentLength

public static Long getKVStoreContentLength(KVStore kvstore)

Determine the content length of the given key/value store when encoded as payload.

Parameters:

kvstore - key/value store to encode

Returns:

payload content length

Throws:

IllegalArgumentException - if kvstore is null

readKVStore

public static void readKVStore(KVStore kvstore,
 HttpInputMessage input)
                        throws IOException

Decode a key/value store HTTP payload.

Parameters:

kvstore - key/value store to populate from input

input - HTTP payload input

Throws:

HttpMessageNotReadableException - if input contains invalid content

IOException - if an I/O error occurs

IllegalArgumentException - if either parameter is null

writeKVStore

public static void writeKVStore(KVStore kvstore,
 HttpOutputMessage output)
                         throws IOException

Encode a key/value store HTTP payload.

Parameters:

kvstore - key/value store to encode

output - HTTP payload output

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if either parameter is null