io.permazen.spring

Class JObjectHttpMessageConverter

java.lang.Object

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

io.permazen.spring.JObjectHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<JObject>

public class JObjectHttpMessageConverter
extends AbstractHttpMessageConverter<JObject>

Spring HttpMessageConverter capable of encoding and decoding one or more JObjects contained in a SnapshotJTransaction.

The payload MIME type is set to application/x-permazen-transaction with an additional root parameter specifying the root JObject in the encoded transaction. There may of course be arbitrarily many other supporting JObjects riding along with it.

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

See Also:

SnapshotJTransactionHttpMessageConverter, KVStoreHttpMessageConverter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT_OBJECT_ID_PARAMETER_NAME Name of the object ID parameter incluced in the MIME type.

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

logger

Constructor Summary

Constructors

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

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_OBJECT_ID_PARAMETER_NAME

public static final String ROOT_OBJECT_ID_PARAMETER_NAME

Name of the object ID parameter incluced in the MIME type.

See Also:

Constant Field Values

Constructor Detail

JObjectHttpMessageConverter

public JObjectHttpMessageConverter(Permazen jdb)

Constructor.

Parameters:

jdb - Permazen instance

Throws:

IllegalArgumentException - if jdb is null

JObjectHttpMessageConverter

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

Constructor.

Parameters:

jdb - Permazen instance

supportedMediaTypes - supported media types

Throws:

IllegalArgumentException - if jdb is null

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; this is the default behavior.

Otherwise, validation of all incoming objects (not just the root object) is performed using the specified validation groups, or Default if an empty array is specified.

Parameters:

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

getContentLength

protected Long getContentLength(JObject jobj,
                                MediaType contentType)

Overrides:

getContentLength in class AbstractHttpMessageConverter<JObject>

canRead

public boolean canRead(Class<?> clazz,
                       MediaType mediaType)

Specified by:

canRead in interface HttpMessageConverter<JObject>

Overrides:

canRead in class AbstractHttpMessageConverter<JObject>

supports

protected boolean supports(Class<?> target)

Specified by:

supports in class AbstractHttpMessageConverter<JObject>

getDefaultContentType

protected MediaType getDefaultContentType(JObject jobj)

Overrides:

getDefaultContentType in class AbstractHttpMessageConverter<JObject>

readInternal

protected JObject readInternal(Class<? extends JObject> type,
                               HttpInputMessage input)
                        throws IOException

Specified by:

readInternal in class AbstractHttpMessageConverter<JObject>

Throws:

IOException

writeInternal

protected void writeInternal(JObject jobj,
                             HttpOutputMessage output)
                      throws IOException

Specified by:

writeInternal in class AbstractHttpMessageConverter<JObject>

Throws:

IOException