org.jsimpledb.spring.SnapshotJTransactionHttpMessageConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsimpledb-spring Show documentation
JSimpleDB classes for the Spring Framework.
There is a newer version: 3.6.1

/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package org.jsimpledb.spring;

import com.google.common.base.Preconditions;

import java.io.IOException;

import org.dellroad.stuff.validation.ValidationUtil;
import org.jsimpledb.JObject;
import org.jsimpledb.JSimpleDB;
import org.jsimpledb.SnapshotJTransaction;
import org.jsimpledb.ValidationException;
import org.jsimpledb.ValidationMode;
import org.jsimpledb.kv.util.NavigableMapKVStore;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;

/**
 * Spring {@link org.springframework.http.converter.HttpMessageConverter HttpMessageConverter} capable of
 * encoding and decoding a graph of {@link JObject}s contained in a {@link SnapshotJTransaction} that is
 * backed by a {@link NavigableMapKVStore}.
 *
 * 
 * The MIME type used is {@code application/x-jsimpledb-transaction}.
 *
 * 

 * Validation of all incoming objects is supported; see {@link #setValidationGroups setValidationGroups()}.
 *
 * @see JObjectHttpMessageConverter
 * @see KVStoreHttpMessageConverter
 */
public class SnapshotJTransactionHttpMessageConverter extends AbstractHttpMessageConverter {

    /**
     * MIME type supported by this class: {@code application/x-jsimpledb-transaction}.
     *
     * 

     * Can be overridden in the constructor.
     */
    public static final MediaType MIME_TYPE = new MediaType("application", "x-jsimpledb-transaction");

    private final JSimpleDB jdb;

    private Class[] validationGroups;

    /**
     * Constructor.
     *
     * @param jdb {@link JSimpleDB} instance defining the convertible types
     */
    public SnapshotJTransactionHttpMessageConverter(JSimpleDB jdb) {
        super(MIME_TYPE);
        Preconditions.checkArgument(jdb != null, "null jdb");
        this.jdb = jdb;
    }

    /**
     * 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 {@link javax.validation.groups.Default} if an empty is specified.
     *
     * 
     * By default, this is null.
     *
     * @param groups validation group(s) to use for validation; if empty, {@link javax.validation.groups.Default} is assumed;
     *  if null, no validation is performed
     */
    public void setValidationGroups(Class... groups) {
        this.validationGroups = groups;
    }

// AbstractHttpMessageConverter

    @Override
    protected Long getContentLength(SnapshotJTransaction jtx, MediaType contentType) {
        return KVStoreHttpMessageConverter.getKVStoreContentLength(jtx.getTransaction().getKVStore());
    }

    @Override
    protected boolean supports(Class clazz) {
        return clazz == SnapshotJTransaction.class;
    }

    @Override
    protected SnapshotJTransaction readInternal(Class clazz, HttpInputMessage input)
      throws IOException {
        return clazz.cast(SnapshotJTransactionHttpMessageConverter.readSnapshotTransaction(this.jdb, input, this.validationGroups));
    }

    @Override
    protected void writeInternal(SnapshotJTransaction jtx, HttpOutputMessage output) throws IOException {
        KVStoreHttpMessageConverter.writeKVStore(jtx.getTransaction().getKVStore(), output);
    }

// Utility methods

    static SnapshotJTransaction readSnapshotTransaction(JSimpleDB jdb, HttpInputMessage input, Class[] validationGroups)
      throws IOException {

        // Decode key/value store
        final NavigableMapKVStore kvstore = new NavigableMapKVStore();
        KVStoreHttpMessageConverter.readKVStore(kvstore, input);

        // Create snapshot transaction
        final SnapshotJTransaction jtx = jdb.createSnapshotTransaction(kvstore, true,
          validationGroups != null ? ValidationMode.MANUAL : ValidationMode.DISABLED);

        // Optionally validate
        if (validationGroups != null) {
            for (JObject jobj : jtx.getAll(JObject.class))
                jobj.revalidate(validationGroups);
            try {
                jtx.validate();
            } catch (ValidationException e) {
                throw new HttpMessageNotReadableException("incoming object graph failed validation: "
                  + ValidationUtil.describe(e.getViolations()));
            }
        }

        // Done
        return jtx;
    }
}