Package io.permazen.spring

Class PermazenObjectHttpMessageConverter

java.lang.Object

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

io.permazen.spring.PermazenObjectHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<PermazenObject>

public class PermazenObjectHttpMessageConverter
extends AbstractHttpMessageConverter<PermazenObject>

Spring HttpMessageConverter capable of encoding and decoding one or more PermazenObjects contained in a DetachedPermazenTransaction.

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

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

See Also:

• DetachedPermazenTransactionHttpMessageConverter
• KVStoreHttpMessageConverter

Field Summary

Fields

Modifier and Type	Field	Description
static final 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	Description
PermazenObjectHttpMessageConverter(Permazen pdb)	Constructor.
PermazenObjectHttpMessageConverter(Permazen pdb, MediaType... supportedMediaTypes)	Constructor.

Method Summary

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

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

getSupportedMediaTypes

Field Details

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 Details

PermazenObjectHttpMessageConverter

public PermazenObjectHttpMessageConverter(Permazen pdb)

Constructor.

Parameters:

pdb - Permazen instance

Throws:

IllegalArgumentException - if pdb is null

PermazenObjectHttpMessageConverter

public PermazenObjectHttpMessageConverter(Permazen pdb,
 MediaType... supportedMediaTypes)

Constructor.

Parameters:

pdb - Permazen instance

supportedMediaTypes - supported media types

Throws:

IllegalArgumentException - if pdb is null

Method Details

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(PermazenObject jobj,
 MediaType contentType)

Overrides:

getContentLength in class AbstractHttpMessageConverter<PermazenObject>

canRead

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

Specified by:

canRead in interface HttpMessageConverter<PermazenObject>

Overrides:

canRead in class AbstractHttpMessageConverter<PermazenObject>

supports

protected boolean supports(Class<?> target)

Specified by:

supports in class AbstractHttpMessageConverter<PermazenObject>

getDefaultContentType

protected MediaType getDefaultContentType(PermazenObject jobj)

Overrides:

getDefaultContentType in class AbstractHttpMessageConverter<PermazenObject>

readInternal

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

Specified by:

readInternal in class AbstractHttpMessageConverter<PermazenObject>

Throws:

IOException

writeInternal

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

Specified by:

writeInternal in class AbstractHttpMessageConverter<PermazenObject>

Throws:

IOException