Skip to content

Commit

Permalink
Use SimpleJsonSerializer
Browse files Browse the repository at this point in the history
  • Loading branch information
@garyrussell
garyrussell committed Feb 23, 2017
1 parent 726bc81 commit 019946b
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 286 deletions.
17 changes: 1 addition & 16 deletions ...core/src/main/java/org/springframework/integration/support/json/BoonJsonObjectMapper.java
View file
@@ -1,5 +1,5 @@
/*
* Copyright 2014-2017 the original author or authors.
* Copyright 2014-2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,7 +28,6 @@
import java.util.Collection;
import java.util.Map;
import java.util.concurrent.Executors;
import java.util.function.Consumer;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
Expand All @@ -38,7 +37,6 @@
import org.boon.json.JsonSerializerFactory;
import org.boon.json.JsonSlurper;
import org.boon.json.ObjectMapper;
import org.boon.json.implementation.ObjectMapperImpl;

import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.integration.mapping.support.JsonHeaders;
Expand All @@ -48,7 +46,6 @@
* The Boon (@link https://github.com/RichardHightower/boon) {@link JsonObjectMapper} implementation.
*
* @author Artem Bilan
* @author Gary Russell
* @since 4.1
*/
public class BoonJsonObjectMapper extends JsonObjectMapperAdapter<Map<String, Object>, Object>
Expand All @@ -70,18 +67,6 @@ public BoonJsonObjectMapper() {
this.objectMapper = JsonFactory.create();
}

public BoonJsonObjectMapper(Consumer<JsonParserFactory> jpfConfig, Consumer<JsonSerializerFactory> jsfConfig) {
JsonParserFactory jpf = new JsonParserFactory();
if (jpfConfig != null) {
jpfConfig.accept(jpf);
}
JsonSerializerFactory jsf = new JsonSerializerFactory();
if (jsfConfig != null) {
jsfConfig.accept(jsf);
}
this.objectMapper = new ObjectMapperImpl(jpf, jsf);
}

public BoonJsonObjectMapper(JsonParserFactory parserFactory, JsonSerializerFactory serializerFactory) {
this.objectMapper = JsonFactory.create(parserFactory, serializerFactory);
}
Expand Down
10 changes: 9 additions & 1 deletion ...ion-core/src/main/java/org/springframework/integration/support/json/JacksonJsonUtils.java
View file
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -38,8 +38,16 @@ private JacksonJsonUtils() {
ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", classLoader) &&
ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", classLoader);

private static final boolean jacksonPresent =
ClassUtils.isPresent("org.codehaus.jackson.map.ObjectMapper", classLoader) &&
ClassUtils.isPresent("org.codehaus.jackson.JsonGenerator", classLoader);

public static boolean isJackson2Present() {
return jackson2Present;
}

public static boolean isJacksonPresent() {
return jacksonPresent;
}

}
100 changes: 1 addition & 99 deletions .../src/main/java/org/springframework/integration/support/json/JsonObjectMapperProvider.java
View file
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -19,13 +19,6 @@

import org.springframework.util.ClassUtils;

import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
* Simple factory to provide {@linkplain JsonObjectMapper}
* instances dependently of jackson-databind or boon libs in the classpath.
Expand Down Expand Up @@ -67,25 +60,6 @@ else if (boonPresent) {
}
}

/**
* Return an object mapper builder if available.
* @param preferBoon true to prefer boon if available.
* @return the mapper builder.
* @throws IllegalStateException if an implementation is not available.
* @since 5.0
*/
public static JsonObjectMapperBuilder<?> newInstanceBuilder(boolean preferBoon) {
if (JacksonJsonUtils.isJackson2Present() && (!preferBoon || !boonPresent)) {
return new JacksonJsonObjectMapperBuilder();
}
else if (boonPresent) {
return new BoonJsonObjectMapperBuilder();
}
else {
throw new IllegalStateException("Neither jackson-databind.jar, nor boon.jar is present in the classpath.");
}
}

/**
* Returns true if a supported JSON implementation is on the class path.
* @return true if {@link #newInstance()} will return a mapper.
Expand All @@ -95,76 +69,4 @@ public static boolean jsonAvailable() {
return JacksonJsonUtils.isJackson2Present() || boonPresent;
}

public static abstract class JsonObjectMapperBuilder<B extends JsonObjectMapperBuilder<B>> {

protected boolean usePropertyOnly = true; // NOSONAR

protected boolean includeAllValues = true; // NOSONAR

public B usePropertyOnly(boolean use) {
this.usePropertyOnly = use;
return _this();
}

public B includeAllValues(boolean include) {
this.includeAllValues = include;
return _this();
}

@SuppressWarnings("unchecked")
protected final B _this() {
return (B) this;
}

public abstract JsonObjectMapper<?, ?> build();

}

private static class JacksonJsonObjectMapperBuilder
extends JsonObjectMapperBuilder<JacksonJsonObjectMapperBuilder> {

JacksonJsonObjectMapperBuilder() {
super();
}

@Override
public JsonObjectMapper<?, ?> build() {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(MapperFeature.DEFAULT_VIEW_INCLUSION, false);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
if (this.usePropertyOnly) {
objectMapper.setVisibility(PropertyAccessor.GETTER, Visibility.PUBLIC_ONLY);
objectMapper.setVisibility(PropertyAccessor.FIELD, Visibility.NONE);
}
if (this.includeAllValues) {
objectMapper.setSerializationInclusion(JsonInclude.Include.ALWAYS);
}
return new Jackson2JsonObjectMapper(objectMapper);
}

}

private static class BoonJsonObjectMapperBuilder extends JsonObjectMapperBuilder<BoonJsonObjectMapperBuilder> {

BoonJsonObjectMapperBuilder() {
super();
}

@Override
public JsonObjectMapper<?, ?> build() {
return new BoonJsonObjectMapper(null, f -> {
f.useAnnotations();
if (this.usePropertyOnly) {
f.usePropertyOnly();
}
if (this.includeAllValues) {
f.includeDefaultValues()
.includeNulls()
.includeEmpty();
}
});
}

}

}
12 changes: 11 additions & 1 deletion ...tion-file/src/main/java/org/springframework/integration/file/remote/AbstractFileInfo.java
View file
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -18,6 +18,8 @@

import java.util.Date;

import org.springframework.integration.json.SimpleJsonSerializer;

/**
* Abstract implementation of {@link FileInfo}; provides a setter
* for the remote directory and a generic toString implementation.
Expand All @@ -36,19 +38,27 @@ public void setRemoteDirectory(String remoteDirectory) {
this.remoteDirectory = remoteDirectory;
}

@Override
public String getRemoteDirectory() {
return this.remoteDirectory;
}

@Override
public String toString() {
return "FileInfo [isDirectory=" + isDirectory() + ", isLink=" + isLink()
+ ", Size=" + getSize() + ", ModifiedTime="
+ new Date(getModified()) + ", Filename=" + getFilename()
+ ", RemoteDirectory=" + getRemoteDirectory() + ", Permissions=" + getPermissions() + "]";
}

@Override
public int compareTo(FileInfo<F> o) {
return this.getFilename().compareTo(o.getFilename());
}

public String toJson() {
return SimpleJsonSerializer.toJson(this, "directory", "link", "size", "modified", "filename",
"remoteDirectory", "permissions");
}

}
36 changes: 4 additions & 32 deletions ...org/springframework/integration/file/remote/AbstractRemoteFileStreamingMessageSource.java
View file
Expand Up @@ -38,10 +38,6 @@
import org.springframework.integration.file.filters.FileListFilter;
import org.springframework.integration.file.filters.ReversibleFileListFilter;
import org.springframework.integration.file.remote.session.Session;
import org.springframework.integration.support.AbstractIntegrationMessageBuilder;
import org.springframework.integration.support.json.JacksonJsonUtils;
import org.springframework.integration.support.json.JsonObjectMapper;
import org.springframework.integration.support.json.JsonObjectMapperProvider;
import org.springframework.messaging.MessagingException;
import org.springframework.util.Assert;

Expand All @@ -62,7 +58,6 @@ public abstract class AbstractRemoteFileStreamingMessageSource<F>

private final Comparator<AbstractFileInfo<F>> comparator;

private final JsonObjectMapper<?, ?> objectMapper;
/**
* the path on the remote server.
*/
Expand All @@ -79,12 +74,6 @@ protected AbstractRemoteFileStreamingMessageSource(RemoteFileTemplate<F> templat
Comparator<AbstractFileInfo<F>> comparator) {
this.remoteFileTemplate = template;
this.comparator = comparator;
if (JacksonJsonUtils.isJackson2Present()) {
this.objectMapper = JsonObjectMapperProvider.newInstanceBuilder(false).build();
}
else {
this.objectMapper = null;
}
}

/**
Expand Down Expand Up @@ -127,16 +116,6 @@ protected RemoteFileTemplate<F> getRemoteFileTemplate() {
return this.remoteFileTemplate;
}

/**
* Override this method if you wish to provide your own object mapper for
* the {@link AbstractFileInfo} header.
* @return the object mapper.
* @since 5.0
*/
protected JsonObjectMapper<?, ?> getObjectMapper() {
return this.objectMapper;
}

@Override
public final void afterPropertiesSet() {
Assert.state(this.remoteDirectoryExpression != null, "'remoteDirectoryExpression' must not be null");
Expand All @@ -157,20 +136,13 @@ protected Object doReceive() {
String remotePath = remotePath(file);
Session<?> session = this.remoteFileTemplate.getSession();
try {
AbstractIntegrationMessageBuilder<InputStream> builder = getMessageBuilderFactory()
return getMessageBuilderFactory()
.withPayload(session.readRaw(remotePath))
.setHeader(IntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE, session)
.setHeader(FileHeaders.REMOTE_DIRECTORY, file.getRemoteDirectory())
.setHeader(FileHeaders.REMOTE_FILE, file.getFilename());
if (getObjectMapper() != null) {
try {
builder.setHeader(FileHeaders.REMOTE_FILE_INFO, getObjectMapper().toJson(file));
}
catch (Exception e) {
logger.info("Failed to transform file info to json: " + file, e);
}
}
return builder.build();
.setHeader(FileHeaders.REMOTE_FILE, file.getFilename())
.setHeader(FileHeaders.REMOTE_FILE_INFO, (file.toJson()))
.build();
}
catch (IOException e) {
throw new MessagingException("IOException when retrieving " + remotePath, e);
Expand Down
9 changes: 0 additions & 9 deletions ...file/src/test/java/org/springframework/integration/file/remote/StreamingInboundTests.java
View file
Expand Up @@ -39,7 +39,6 @@
import org.junit.Test;
import org.junit.rules.ExpectedException;

import org.springframework.beans.DirectFieldAccessor;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.integration.IntegrationMessageHeaderAccessor;
import org.springframework.integration.channel.QueueChannel;
Expand All @@ -48,7 +47,6 @@
import org.springframework.integration.file.remote.session.Session;
import org.springframework.integration.file.remote.session.SessionFactory;
import org.springframework.integration.file.splitter.FileSplitter;
import org.springframework.integration.support.json.JsonObjectMapperProvider;
import org.springframework.integration.transformer.StreamTransformer;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessagingException;
Expand Down Expand Up @@ -85,15 +83,10 @@ public void testAllData() throws Exception {
assertThat(fileInfo, containsString("filename\":\"foo"));
assertThat(fileInfo, containsString("modified\":42000"));
assertThat(fileInfo, containsString("link\":false"));
assertThat(fileInfo, containsString("fileInfo"));
assertThat(fileInfo, containsString("name=/foo/foo"));

// close after list, transform
verify(new IntegrationMessageHeaderAccessor(received).getCloseableResource(), times(2)).close();

new DirectFieldAccessor(streamer).setPropertyValue("objectMapper",
JsonObjectMapperProvider.newInstanceBuilder(true).build());

received = (Message<byte[]>) this.transformer.transform(streamer.receive());
assertEquals("baz\nqux", new String(received.getPayload()));
assertEquals("/foo", received.getHeaders().get(FileHeaders.REMOTE_DIRECTORY));
Expand All @@ -106,8 +99,6 @@ public void testAllData() throws Exception {
assertThat(fileInfo, containsString("filename\":\"bar"));
assertThat(fileInfo, containsString("modified\":42000"));
assertThat(fileInfo, containsString("link\":false")); // Boon doesn't emit default values (false)
assertThat(fileInfo, containsString("fileInfo"));
assertThat(fileInfo, containsString("name=/foo/bar"));

// close after transform
verify(new IntegrationMessageHeaderAccessor(received).getCloseableResource(), times(3)).close();
Expand Down

0 comments on commit 019946b

Please sign in to comment.