io.permazen.spring

Class SnapshotJTransactionHttpMessageConverter

java.lang.Object

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

io.permazen.spring.SnapshotJTransactionHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<SnapshotJTransaction>

public class SnapshotJTransactionHttpMessageConverter
extends AbstractHttpMessageConverter<SnapshotJTransaction>

Spring HttpMessageConverter capable of encoding and decoding a graph of JObjects contained in a SnapshotJTransaction that is backed by a NavigableMapKVStore.

The MIME type used is application/x-permazen-transaction.

Validation of all incoming objects is supported; see setValidationGroups().

See Also:

JObjectHttpMessageConverter, KVStoreHttpMessageConverter

Field Summary

Fields

Modifier and Type	Field and Description
static MediaType	MIME_TYPE MIME type supported by this class: application/x-permazen-transaction.

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

logger

Constructor Summary

Constructors

Constructor and Description
SnapshotJTransactionHttpMessageConverter(Permazen jdb) Constructor.
SnapshotJTransactionHttpMessageConverter(Permazen jdb, MediaType... supportedMediaTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Long	getContentLength(SnapshotJTransaction jtx, MediaType contentType)
protected SnapshotJTransaction	readInternal(Class<? extends SnapshotJTransaction> clazz, HttpInputMessage input)
void	setValidationGroups(Class<?>... groups) Set validation groups used to validate all incoming objects.
protected boolean	supports(Class<?> clazz)
protected void	writeInternal(SnapshotJTransaction jtx, HttpOutputMessage output)

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 Detail

MIME_TYPE

public static final MediaType MIME_TYPE

MIME type supported by this class: application/x-permazen-transaction.

Can be overridden in the constructor.

Constructor Detail

SnapshotJTransactionHttpMessageConverter

public SnapshotJTransactionHttpMessageConverter(Permazen jdb)

Constructor.

Parameters:

jdb - Permazen instance defining the convertible types

SnapshotJTransactionHttpMessageConverter

public SnapshotJTransactionHttpMessageConverter(Permazen jdb,
                                                MediaType... supportedMediaTypes)

Constructor.

Parameters:

jdb - Permazen instance defining the convertible types

supportedMediaTypes - supported media types

Method Detail

setValidationGroups

public void setValidationGroups(Class<?>... groups)

Set validation groups used to validate all incoming objects.

If set to null, no validation is performed. Otherwise, all incoming objects in the transaction are validated, using the specified validation groups, or Default if an empty is specified.

By default, this is null.

Parameters:

groups - validation group(s) to use for validation; if empty, Default is assumed; if null, no validation is performed

getContentLength

protected Long getContentLength(SnapshotJTransaction jtx,
                                MediaType contentType)

Overrides:

getContentLength in class AbstractHttpMessageConverter<SnapshotJTransaction>

supports

protected boolean supports(Class<?> clazz)

Specified by:

supports in class AbstractHttpMessageConverter<SnapshotJTransaction>

readInternal

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

Specified by:

readInternal in class AbstractHttpMessageConverter<SnapshotJTransaction>

Throws:

IOException

writeInternal

protected void writeInternal(SnapshotJTransaction jtx,
                             HttpOutputMessage output)
                      throws IOException

Specified by:

writeInternal in class AbstractHttpMessageConverter<SnapshotJTransaction>

Throws:

IOException