├── src ├── main │ ├── resources │ │ └── META-INF │ │ │ └── services │ │ │ └── javax.json.bind.spi.JsonbProvider │ └── java │ │ └── io │ │ └── devcon5 │ │ └── jsonb │ │ ├── jackson │ │ ├── JacksonJsonbProvider.java │ │ ├── JacksonJsonbBuilder.java │ │ └── JacksonJsonb.java │ │ └── Types.java └── test │ └── java │ └── io │ └── devcon5 │ └── jsonb │ ├── jackson │ ├── JacksonJsonbProviderTest.java │ ├── JacksonJsonbBuilderTest.java │ └── JacksonJsonbTest.java │ └── TypesTest.java ├── .gitignore ├── README.md ├── pom.xml └── LICENSE /src/main/resources/META-INF/services/javax.json.bind.spi.JsonbProvider: -------------------------------------------------------------------------------- 1 | io.devcon5.jsonb.jackson.JacksonJsonbProvider 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.jar 8 | *.war 9 | *.ear 10 | 11 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 12 | hs_err_pid* 13 | 14 | .idea/ 15 | target/ 16 | *.iml 17 | -------------------------------------------------------------------------------- /src/main/java/io/devcon5/jsonb/jackson/JacksonJsonbProvider.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb.jackson; 18 | 19 | import javax.json.bind.JsonbBuilder; 20 | import javax.json.bind.spi.JsonbProvider; 21 | 22 | /** 23 | * Jackson2 based implementation of Jsonb API 24 | */ 25 | public class JacksonJsonbProvider extends JsonbProvider { 26 | 27 | @Override 28 | public JsonbBuilder create() { 29 | 30 | return new JacksonJsonbBuilder(); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/test/java/io/devcon5/jsonb/jackson/JacksonJsonbProviderTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb.jackson; 18 | 19 | import static org.junit.Assert.assertNotNull; 20 | 21 | import javax.json.bind.JsonbBuilder; 22 | 23 | import org.junit.Test; 24 | 25 | public class JacksonJsonbProviderTest { 26 | 27 | @Test 28 | public void shouldCreateABuilder() throws Exception { 29 | 30 | JsonbBuilder builder = new JacksonJsonbProvider().create(); 31 | 32 | assertNotNull(builder); 33 | 34 | } 35 | 36 | } 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # jackson-jsonb-provider 2 | A Jackson2 based provider based for Json binding API (JSR 367). 3 | 4 | This is an alternative to the reference implementation (Yasson) which is 5 | is not yet available on Maven central. 6 | 7 | Using this provider allows you write code against the standardize Json-binding API while using a 8 | proven and reliable JSON binding implementation (Jackson). This decouples your code from a specific 9 | implementation and allows to switch implementations more easily (theoretically). 10 | 11 | Apart from that, there are no advantages over using Jackson directly, actually you can't access all 12 | of the features provided by Jackson through the binding API. 13 | 14 | # Usage 15 | 16 | ## Dependencies 17 | adding this to your project 18 | 19 | 20 | io.devcon5 21 | jackson-jsonb-provider 22 | 1.0 23 | 24 | 25 | Note that the `javax.json-api` and `javax.json.bind-api` are not provided by this provider 26 | and must be present in the classpath. You may add both dependencies using 27 | 28 | 29 | javax.json 30 | javax.json-api 31 | 1.0 32 | 33 | 34 | javax.json.bind 35 | javax.json.bind-api 36 | 1.0.0-M1 37 | 38 | 39 | ## Code Examples 40 | To create a `Jsonb` instance for serializing/deserialing your objects to and 41 | from Json: 42 | 43 | JsonbBuilder builder = JsonbBuilder.create() 44 | Jsonb jsonb = builder.build(); 45 | 46 | To serisalize your object to json 47 | 48 | MyObject obj = ...; 49 | String json = jsonb.toJson(obj); 50 | 51 | To deserialize json to object 52 | 53 | MyObject obj2 = jsonb.fromJson(json, MyObject.class); 54 | 55 | To deserialize a json array to a list, you may use the `Types` utility class 56 | 57 | List list = jsonb.fromJson(json, Types.ofList(MyObject.class)); 58 | 59 | or 60 | 61 | MyContainer list = jsonb.fromJson(json, Types.of(MyContainer.class, MyObject.class)); 62 | 63 | ## Configuration 64 | This provider can be configured to a small extend: 65 | 66 | - including `null` properties in serialization (default: off) 67 | 68 | JsonbConfig config = new JsonbConfig().withNullValues(true); 69 | builder.withConfig(config); 70 | 71 | Jsonb jsonb = builder.build(); 72 | 73 | - including empty properties (i.e. Collections or arrays) in serialization (default: off) 74 | 75 | JsonbConfig config = new JsonbConfig().setProperty(JacksonJsonbBuilder.INCLUDE_EMPTY_VALUES, true); 76 | builder.withConfig(config); 77 | 78 | Jsonb jsonb = builder.build(); 79 | -------------------------------------------------------------------------------- /src/main/java/io/devcon5/jsonb/jackson/JacksonJsonbBuilder.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb.jackson; 18 | 19 | import javax.json.bind.Jsonb; 20 | import javax.json.bind.JsonbBuilder; 21 | import javax.json.bind.JsonbConfig; 22 | import javax.json.spi.JsonProvider; 23 | 24 | import com.fasterxml.jackson.annotation.JsonInclude; 25 | import com.fasterxml.jackson.databind.ObjectMapper; 26 | 27 | /** 28 | * Jackson2 based implmentation of Jsonb API 29 | */ 30 | public class JacksonJsonbBuilder implements JsonbBuilder { 31 | 32 | /** 33 | * Property name that can be used in configuration to toggle whether null-values should be serialized or not. 34 | * Same behavior as using jsoncConfig.withNullValues(true|false) or using 35 | * {@link JsonbConfig#NULL_VALUES}. 36 | */ 37 | public static final String INCLUDE_NULL_VALUES = "jsonb.jackson.nullValues"; 38 | /** 39 | * Property name that can be used in configuration 40 | */ 41 | public static final String INCLUDE_EMPTY_VALUES = "jsonb.jackson.emptyValues"; 42 | 43 | private boolean includeNulls = false; 44 | private boolean includeEmpty = false; 45 | 46 | @Override 47 | public JsonbBuilder withConfig(final JsonbConfig jsonbConfig) { 48 | 49 | if(jsonbConfig == null) { 50 | throw new IllegalArgumentException("Configuration must not be null"); 51 | } 52 | this.includeNulls = (boolean) jsonbConfig.getProperty(JsonbConfig.NULL_VALUES).orElse(this.includeNulls); 53 | this.includeNulls = (boolean) jsonbConfig.getProperty(INCLUDE_NULL_VALUES).orElse(this.includeNulls); 54 | this.includeEmpty = (boolean) jsonbConfig.getProperty(INCLUDE_EMPTY_VALUES).orElse(this.includeEmpty); 55 | return this; 56 | } 57 | 58 | @Override 59 | public JsonbBuilder withProvider(final JsonProvider jsonProvider) { 60 | //noop 61 | return this; 62 | } 63 | 64 | @Override 65 | public Jsonb build() { 66 | 67 | final ObjectMapper mapper = new ObjectMapper(); 68 | if(!includeNulls){ 69 | mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); 70 | if(!includeEmpty){ 71 | mapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY); 72 | } 73 | } 74 | return new JacksonJsonb(mapper); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 17 | 4.0.0 18 | 19 | 20 | io.devcon5 21 | parent 22 | 1.3 23 | 24 | 25 | io.devcon5 26 | jackson-jsonb-provider 27 | 1.2-SNAPSHOT 28 | 29 | 30 | 1.8 31 | 32 | 1.0 33 | 1.0.0-M1 34 | 2.9.0.pr1 35 | 36 | 4.12 37 | 1.9.5 38 | 39 | 40 | 41 | 42 | 43 | javax.json 44 | javax.json-api 45 | ${javax.json.version} 46 | provided 47 | 48 | 49 | javax.json.bind 50 | javax.json.bind-api 51 | ${javax.jsonb.version} 52 | provided 53 | 54 | 55 | com.fasterxml.jackson.core 56 | jackson-databind 57 | ${jackson.version} 58 | 59 | 60 | 61 | org.mockito 62 | mockito-all 63 | ${mockito.version} 64 | test 65 | 66 | 67 | junit 68 | junit 69 | ${junit.version} 70 | test 71 | 72 | 73 | 74 | 75 | 76 | 77 | org.apache.maven.plugins 78 | maven-compiler-plugin 79 | 3.1 80 | 81 | ${javac.target} 82 | ${javac.target} 83 | ${javac.target} 84 | 85 | 86 | 87 | 88 | 89 | -------------------------------------------------------------------------------- /src/test/java/io/devcon5/jsonb/TypesTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb; 18 | 19 | import static org.junit.Assert.assertEquals; 20 | import static org.junit.Assert.assertNotNull; 21 | import static org.junit.Assert.assertNull; 22 | 23 | import java.lang.reflect.ParameterizedType; 24 | import java.util.List; 25 | import java.util.Map; 26 | import java.util.Optional; 27 | import java.util.Set; 28 | import java.util.concurrent.atomic.AtomicReference; 29 | 30 | import org.junit.Test; 31 | 32 | /** 33 | * Created on 21.03.2017. 34 | */ 35 | public class TypesTest { 36 | 37 | @Test 38 | public void listOf() throws Exception { 39 | ParameterizedType type = Types.listOf(String.class); 40 | 41 | assertNotNull(type); 42 | assertEquals(List.class, type.getRawType()); 43 | assertNotNull(type.getActualTypeArguments()); 44 | assertEquals(1, type.getActualTypeArguments().length); 45 | assertEquals(String.class, type.getActualTypeArguments()[0]); 46 | assertNull(type.getOwnerType()); 47 | 48 | } 49 | 50 | @Test 51 | public void setOf() throws Exception { 52 | ParameterizedType type = Types.setOf(String.class); 53 | 54 | assertNotNull(type); 55 | assertEquals(Set.class, type.getRawType()); 56 | assertNotNull(type.getActualTypeArguments()); 57 | assertEquals(1, type.getActualTypeArguments().length); 58 | assertEquals(String.class, type.getActualTypeArguments()[0]); 59 | assertNull(type.getOwnerType()); 60 | } 61 | 62 | @Test 63 | public void mapOf() throws Exception { 64 | ParameterizedType type = Types.mapOf(String.class, Long.class); 65 | 66 | assertNotNull(type); 67 | assertEquals(Map.class, type.getRawType()); 68 | assertNotNull(type.getActualTypeArguments()); 69 | assertEquals(2, type.getActualTypeArguments().length); 70 | assertEquals(String.class, type.getActualTypeArguments()[0]); 71 | assertEquals(Long.class, type.getActualTypeArguments()[1]); 72 | assertNull(type.getOwnerType()); 73 | } 74 | 75 | @Test 76 | public void optionalOf() throws Exception { 77 | ParameterizedType type = Types.optionalOf(String.class); 78 | 79 | assertNotNull(type); 80 | assertEquals(Optional.class, type.getRawType()); 81 | assertNotNull(type.getActualTypeArguments()); 82 | assertEquals(1, type.getActualTypeArguments().length); 83 | assertEquals(String.class, type.getActualTypeArguments()[0]); 84 | assertNull(type.getOwnerType()); 85 | 86 | } 87 | 88 | @Test 89 | public void of() throws Exception { 90 | ParameterizedType type = Types.of(AtomicReference.class, String.class); 91 | 92 | assertNotNull(type); 93 | assertEquals(AtomicReference.class, type.getRawType()); 94 | assertNotNull(type.getActualTypeArguments()); 95 | assertEquals(1, type.getActualTypeArguments().length); 96 | assertEquals(String.class, type.getActualTypeArguments()[0]); 97 | assertNull(type.getOwnerType()); 98 | } 99 | 100 | @Test 101 | public void ofOwnerType() throws Exception { 102 | //its a bit hypothetical to have List.AtomicReference :) 103 | ParameterizedType type = Types.ofOwnerType(List.class, AtomicReference.class, String.class); 104 | 105 | assertNotNull(type); 106 | assertEquals(AtomicReference.class, type.getRawType()); 107 | assertNotNull(type.getActualTypeArguments()); 108 | assertEquals(1, type.getActualTypeArguments().length); 109 | assertEquals(String.class, type.getActualTypeArguments()[0]); 110 | assertEquals(List.class, type.getOwnerType()); 111 | } 112 | 113 | } 114 | -------------------------------------------------------------------------------- /src/test/java/io/devcon5/jsonb/jackson/JacksonJsonbBuilderTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb.jackson; 18 | 19 | import static org.junit.Assert.assertEquals; 20 | import static org.junit.Assert.assertNotNull; 21 | import static org.junit.Assert.assertSame; 22 | 23 | import javax.json.bind.Jsonb; 24 | import javax.json.bind.JsonbConfig; 25 | import javax.json.spi.JsonProvider; 26 | import java.util.ArrayList; 27 | import java.util.List; 28 | 29 | import org.junit.Before; 30 | import org.junit.Test; 31 | import org.junit.runner.RunWith; 32 | import org.mockito.Mock; 33 | import org.mockito.runners.MockitoJUnitRunner; 34 | 35 | @RunWith(MockitoJUnitRunner.class) 36 | public class JacksonJsonbBuilderTest { 37 | 38 | @Mock 39 | private JsonProvider prov; 40 | 41 | private JsonbConfig config; 42 | 43 | @Before 44 | public void setUp() throws Exception { 45 | this.config = new JsonbConfig(); 46 | } 47 | 48 | @Test 49 | public void withEmptyConfig_nullsDisabledAsDefault() throws Exception { 50 | JacksonJsonbBuilder builder = new JacksonJsonbBuilder(); 51 | assertSame(builder, builder.withConfig(config)); 52 | 53 | String result = builder.build().toJson(new Example()); 54 | assertEquals("{\"value\":0}", result); 55 | } 56 | 57 | @Test(expected = IllegalArgumentException.class) 58 | public void withNullConfig() throws Exception { 59 | JacksonJsonbBuilder builder = new JacksonJsonbBuilder(); 60 | assertSame(builder, builder.withConfig(null)); 61 | } 62 | 63 | @Test 64 | public void withNullsEnabledByJsonbConfig() throws Exception { 65 | JacksonJsonbBuilder builder = new JacksonJsonbBuilder(); 66 | this.config.withNullValues(true); 67 | assertSame(builder, builder.withConfig(config)); 68 | 69 | String result = builder.build().toJson(new Example()); 70 | assertEquals("{\"list\":[],\"name\":null,\"value\":0}", result); 71 | } 72 | 73 | @Test 74 | public void withNullsEnabledByPropertyConfig() throws Exception { 75 | JacksonJsonbBuilder builder = new JacksonJsonbBuilder(); 76 | this.config.setProperty(JacksonJsonbBuilder.INCLUDE_NULL_VALUES, true); 77 | assertSame(builder, builder.withConfig(config)); 78 | 79 | String result = builder.build().toJson(new Example()); 80 | assertEquals("{\"list\":[],\"name\":null,\"value\":0}", result); 81 | } 82 | 83 | @Test 84 | public void withEmptyEnabledByPropertyConfig() throws Exception { 85 | JacksonJsonbBuilder builder = new JacksonJsonbBuilder(); 86 | this.config.setProperty(JacksonJsonbBuilder.INCLUDE_EMPTY_VALUES, true); 87 | assertSame(builder, builder.withConfig(config)); 88 | 89 | String result = builder.build().toJson(new Example()); 90 | System.out.println(result); 91 | assertEquals("{\"list\":[],\"value\":0}", result); 92 | } 93 | 94 | @Test 95 | public void withProvider() throws Exception { 96 | JacksonJsonbBuilder builder = new JacksonJsonbBuilder(); 97 | assertSame(builder, builder.withProvider(prov)); 98 | } 99 | 100 | @Test 101 | public void build() throws Exception { 102 | 103 | Jsonb jsonb = new JacksonJsonbBuilder().build(); 104 | assertNotNull(jsonb); 105 | } 106 | 107 | public static class Example { 108 | 109 | private List list = new ArrayList<>(); 110 | private String name; 111 | private int value; 112 | 113 | public String getName() { 114 | 115 | return name; 116 | } 117 | 118 | public void setName(final String name) { 119 | 120 | this.name = name; 121 | } 122 | 123 | public int getValue() { 124 | 125 | return value; 126 | } 127 | 128 | public void setValue(final int value) { 129 | 130 | this.value = value; 131 | } 132 | 133 | public void setList(final List list) { 134 | 135 | this.list = list; 136 | } 137 | 138 | public List getList() { 139 | 140 | return list; 141 | } 142 | } 143 | 144 | } 145 | -------------------------------------------------------------------------------- /src/test/java/io/devcon5/jsonb/jackson/JacksonJsonbTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb.jackson; 18 | 19 | import static org.junit.Assert.assertEquals; 20 | import static org.junit.Assert.assertNotNull; 21 | 22 | import java.io.ByteArrayInputStream; 23 | import java.io.ByteArrayOutputStream; 24 | import java.io.StringReader; 25 | import java.io.StringWriter; 26 | import java.lang.reflect.Type; 27 | 28 | import com.fasterxml.jackson.databind.ObjectMapper; 29 | import org.junit.Before; 30 | import org.junit.Test; 31 | 32 | public class JacksonJsonbTest { 33 | 34 | private static final String REF_JSON = "{\"name\":\"Test\",\"value\":12}"; 35 | 36 | private JacksonJsonb subject; 37 | 38 | private Example example; 39 | 40 | @Before 41 | public void setUp() throws Exception { 42 | 43 | this.example = new Example(); 44 | this.example.setName("Test"); 45 | this.example.setValue(12); 46 | this.subject = new JacksonJsonb(new ObjectMapper()); 47 | } 48 | 49 | private void assertResultIsOk(final Example ex) { 50 | 51 | assertNotNull(ex); 52 | assertEquals("Test", ex.getName()); 53 | assertEquals(12, ex.getValue()); 54 | } 55 | 56 | @Test 57 | public void fromJsonInputStreamAndClass() throws Exception { 58 | 59 | Example ex = subject.fromJson(new ByteArrayInputStream(REF_JSON.getBytes()), Example.class); 60 | assertResultIsOk(ex); 61 | } 62 | 63 | @Test 64 | public void fromJsonInputStreamAndType() throws Exception { 65 | 66 | Example ex = subject.fromJson(new ByteArrayInputStream(REF_JSON.getBytes()), (Type)Example.class); 67 | assertResultIsOk(ex); 68 | } 69 | 70 | @Test 71 | public void fromJsonReaderAndClass() throws Exception { 72 | Example ex = subject.fromJson(new StringReader(REF_JSON), Example.class); 73 | assertResultIsOk(ex); 74 | } 75 | 76 | @Test 77 | public void fromJsonReaderAndType() throws Exception { 78 | Example ex = subject.fromJson(new StringReader(REF_JSON), (Type)Example.class); 79 | assertResultIsOk(ex); 80 | } 81 | 82 | @Test 83 | public void fromJsonStringAndClass() throws Exception { 84 | Example ex = subject.fromJson(REF_JSON, Example.class); 85 | assertResultIsOk(ex); 86 | } 87 | 88 | @Test 89 | public void fromJsonStringAndType() throws Exception { 90 | Example ex = subject.fromJson(REF_JSON, (Type)Example.class); 91 | assertResultIsOk(ex); 92 | } 93 | 94 | @Test 95 | public void toJsonFromObject() throws Exception { 96 | String result = subject.toJson(this.example); 97 | assertEquals(REF_JSON, result); 98 | } 99 | 100 | @Test 101 | public void toJsonFromObjectAndType() throws Exception { 102 | String result = subject.toJson(this.example, Example.class); 103 | assertEquals(REF_JSON, result); 104 | } 105 | 106 | @Test 107 | public void toJsonFromObjectToWriter() throws Exception { 108 | StringWriter writer = new StringWriter(); 109 | subject.toJson(this.example, writer); 110 | String result = writer.toString(); 111 | assertEquals(REF_JSON, result); 112 | } 113 | 114 | @Test 115 | public void toJsonFromObjectAndTypeToWriter() throws Exception { 116 | StringWriter writer = new StringWriter(); 117 | subject.toJson(this.example, Example.class, writer); 118 | String result = writer.toString(); 119 | assertEquals(REF_JSON, result); 120 | 121 | } 122 | 123 | @Test 124 | public void toJsonFromObjectToOutputStream() throws Exception { 125 | 126 | ByteArrayOutputStream os = new ByteArrayOutputStream(); 127 | subject.toJson(this.example, os); 128 | String result = new String(os.toByteArray()); 129 | assertEquals(REF_JSON, result); 130 | } 131 | 132 | @Test 133 | public void toJsonFromObjectAndTypeToOutputStream() throws Exception { 134 | ByteArrayOutputStream os = new ByteArrayOutputStream(); 135 | subject.toJson(this.example, Example.class, os); 136 | String result = new String(os.toByteArray()); 137 | assertEquals(REF_JSON, result); 138 | } 139 | 140 | @Test 141 | public void close() throws Exception { 142 | 143 | } 144 | 145 | public static class Example { 146 | 147 | private String name; 148 | private int value; 149 | 150 | public String getName() { 151 | 152 | return name; 153 | } 154 | 155 | public void setName(final String name) { 156 | 157 | this.name = name; 158 | } 159 | 160 | public int getValue() { 161 | 162 | return value; 163 | } 164 | 165 | public void setValue(final int value) { 166 | 167 | this.value = value; 168 | } 169 | } 170 | 171 | } 172 | -------------------------------------------------------------------------------- /src/main/java/io/devcon5/jsonb/jackson/JacksonJsonb.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb.jackson; 18 | 19 | import javax.json.bind.Jsonb; 20 | import javax.json.bind.JsonbException; 21 | import java.io.IOException; 22 | import java.io.InputStream; 23 | import java.io.OutputStream; 24 | import java.io.Reader; 25 | import java.io.Writer; 26 | import java.lang.reflect.Type; 27 | 28 | import com.fasterxml.jackson.core.JsonProcessingException; 29 | import com.fasterxml.jackson.databind.ObjectMapper; 30 | import com.fasterxml.jackson.databind.type.TypeFactory; 31 | 32 | /** 33 | * Jackson2 based implementation for JsonB API 34 | */ 35 | public class JacksonJsonb implements Jsonb { 36 | 37 | private final ObjectMapper mapper; 38 | 39 | public JacksonJsonb(final ObjectMapper mapper) { 40 | this.mapper = mapper; 41 | 42 | } 43 | 44 | @Override 45 | public T fromJson(final String s, final Class aClass) throws JsonbException { 46 | 47 | try { 48 | return mapper.readValue(s, aClass); 49 | } catch (IOException e) { 50 | throw new JsonbException("Could not parse content", e); 51 | } 52 | } 53 | 54 | @Override 55 | public T fromJson(final String s, final Type type) throws JsonbException { 56 | 57 | try { 58 | return mapper.readValue(s, TypeFactory.defaultInstance().constructType(type)); 59 | } catch (IOException e) { 60 | throw new JsonbException("Could not parse content", e); 61 | } 62 | } 63 | 64 | @Override 65 | public T fromJson(final Reader reader, final Class aClass) throws JsonbException { 66 | 67 | try { 68 | return mapper.readValue(reader, aClass); 69 | } catch (IOException e) { 70 | throw new JsonbException("Could not parse content", e); 71 | } 72 | } 73 | 74 | @Override 75 | public T fromJson(final Reader reader, final Type type) throws JsonbException { 76 | 77 | try { 78 | return mapper.readValue(reader, TypeFactory.defaultInstance().constructType(type)); 79 | } catch (IOException e) { 80 | throw new JsonbException("Could not parse content", e); 81 | } 82 | } 83 | 84 | @Override 85 | public T fromJson(final InputStream inputStream, final Class aClass) throws JsonbException { 86 | 87 | try { 88 | return mapper.readValue(inputStream, aClass); 89 | } catch (IOException e) { 90 | throw new JsonbException("Could not parse content", e); 91 | } 92 | } 93 | 94 | @Override 95 | public T fromJson(final InputStream inputStream, final Type type) throws JsonbException { 96 | 97 | try { 98 | return mapper.readValue(inputStream, TypeFactory.defaultInstance().constructType(type)); 99 | } catch (IOException e) { 100 | throw new JsonbException("Could not parse content", e); 101 | } 102 | } 103 | 104 | @Override 105 | public String toJson(final Object o) throws JsonbException { 106 | 107 | try { 108 | return mapper.writeValueAsString(o); 109 | } catch (JsonProcessingException e) { 110 | throw new JsonbException("Could not serialize object of type" + o.getClass(), e); 111 | } 112 | } 113 | 114 | @Override 115 | public String toJson(final Object o, final Type type) throws JsonbException { 116 | 117 | return toJson(o); 118 | } 119 | 120 | @Override 121 | public void toJson(final Object o, final Writer writer) throws JsonbException { 122 | try { 123 | mapper.writeValue(writer, o); 124 | } catch (JsonProcessingException e) { 125 | throw new JsonbException("Could not serialize object of type" + o.getClass(), e); 126 | } catch (IOException e) { 127 | throw new JsonbException("Could not write serialized object of type" + o.getClass(), e); 128 | } 129 | } 130 | 131 | @Override 132 | public void toJson(final Object o, final Type type, final Writer writer) throws JsonbException { 133 | toJson(o, writer); 134 | } 135 | 136 | @Override 137 | public void toJson(final Object o, final OutputStream outputStream) throws JsonbException { 138 | try { 139 | mapper.writeValue(outputStream, o); 140 | } catch (JsonProcessingException e) { 141 | throw new JsonbException("Could not serialize object of type" + o.getClass(), e); 142 | } catch (IOException e) { 143 | throw new JsonbException("Could not write serialized object of type" + o.getClass(), e); 144 | } 145 | } 146 | 147 | @Override 148 | public void toJson(final Object o, final Type type, final OutputStream outputStream) throws JsonbException { 149 | toJson(o, outputStream); 150 | } 151 | 152 | @Override 153 | public void close() throws Exception { 154 | //noop 155 | } 156 | } 157 | -------------------------------------------------------------------------------- /src/main/java/io/devcon5/jsonb/Types.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017, DevCon5 GmbH, Switzerland 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package io.devcon5.jsonb; 18 | 19 | import java.lang.reflect.ParameterizedType; 20 | import java.lang.reflect.Type; 21 | import java.util.Arrays; 22 | import java.util.List; 23 | import java.util.Map; 24 | import java.util.Optional; 25 | import java.util.Set; 26 | 27 | /** 28 | * Utility class with factory methods to create type handles that simplify JSON deserialization with jsonb. 29 | *
30 | * For example, to create a {@link Type} instance for List<String> invoke 31 | *

 32 |  *     ParameterizedType listOfStrings = Types.listOf(String.class);
 33 |  * 
34 | * 35 | * 36 | * Created on 20.03.2017. 37 | */ 38 | public final class Types { 39 | 40 | private Types() { 41 | 42 | } 43 | 44 | /** 45 | * Creates a parameterized type definition for a generic list 46 | * 47 | * @param genericType 48 | * the type of the entries of the list 49 | * 50 | * @return a new instance of {@link ParameterizedType} 51 | */ 52 | public static ParameterizedType listOf(Type genericType) { 53 | 54 | return new ParameterizedTypeImpl(List.class, genericType); 55 | } 56 | 57 | /** 58 | * Creates a parameterized type definition for a generic set 59 | * 60 | * @param genericType 61 | * the type of teh entries in the set 62 | * 63 | * @return a new instance of {@link ParameterizedType} 64 | */ 65 | public static ParameterizedType setOf(Type genericType) { 66 | 67 | return new ParameterizedTypeImpl(Set.class, genericType); 68 | } 69 | 70 | /** 71 | * Creates a parameterrized type definition for a generic map 72 | * 73 | * @param keyType 74 | * the type of the keys of the map 75 | * @param valueType 76 | * the type of the values of the map 77 | * 78 | * @return a new instance of {@link ParameterizedType} 79 | */ 80 | public static ParameterizedType mapOf(Type keyType, Type valueType) { 81 | 82 | return new ParameterizedTypeImpl(Map.class, keyType, valueType); 83 | } 84 | 85 | /** 86 | * Creates a parameterized type definition for a generic optional 87 | * 88 | * @param genericType 89 | * the type of teh entries in the set 90 | * 91 | * @return a new instance of {@link ParameterizedType} 92 | */ 93 | public static ParameterizedType optionalOf(Type genericType) { 94 | 95 | return new ParameterizedTypeImpl(Optional.class, genericType); 96 | } 97 | 98 | /** 99 | * Creates a parameterized type definition for a rawtype 100 | * 101 | * @param rawType 102 | * the base type 103 | * @param typeParameters 104 | * the generic type parameters 105 | * 106 | * @return a new instance of {@link ParameterizedType} 107 | */ 108 | public static ParameterizedType of(Class rawType, Type... typeParameters) { 109 | 110 | return new ParameterizedTypeImpl(rawType, typeParameters); 111 | } 112 | 113 | /** 114 | * Creates a parameterized type definition for a owned rawtype. For example Owner.Raw<String> 115 | * 116 | * @param ownerType 117 | * the type that owns the rawtype 118 | * @param rawType 119 | * the base type 120 | * @param typeParameters 121 | * the generic type parameters 122 | * 123 | * @return a new instance of {@link ParameterizedType} 124 | */ 125 | public static ParameterizedType ofOwnerType(Type ownerType, Class rawType, Type... typeParameters) { 126 | 127 | return new ParameterizedTypeImpl(rawType, typeParameters, ownerType); 128 | } 129 | 130 | /** 131 | * 132 | */ 133 | static class ParameterizedTypeImpl implements ParameterizedType { 134 | 135 | private final Type rawType; 136 | private final Type[] typeArgs; 137 | private final Type ownerType; 138 | 139 | ParameterizedTypeImpl(final Type rawType, final Type[] typeArgs, final Type ownerType) { 140 | 141 | this.rawType = rawType; 142 | this.ownerType = ownerType; 143 | this.typeArgs = typeArgs; 144 | } 145 | 146 | ParameterizedTypeImpl(final Type rawType, final Type... typeArgs) { 147 | 148 | this(rawType, typeArgs, null); 149 | } 150 | 151 | @Override 152 | public Type[] getActualTypeArguments() { 153 | 154 | return typeArgs; 155 | } 156 | 157 | @Override 158 | public Type getRawType() { 159 | 160 | return this.rawType; 161 | } 162 | 163 | @Override 164 | public Type getOwnerType() { 165 | 166 | return this.ownerType; 167 | } 168 | 169 | @Override 170 | public boolean equals(final Object o) { 171 | 172 | if (this == o) { 173 | return true; 174 | } 175 | if (o == null || getClass() != o.getClass()) { 176 | return false; 177 | } 178 | 179 | final ParameterizedTypeImpl that = (ParameterizedTypeImpl) o; 180 | 181 | if (rawType != null ? !rawType.equals(that.rawType) : that.rawType != null) { 182 | return false; 183 | } 184 | if (!Arrays.equals(typeArgs, that.typeArgs)) { 185 | return false; 186 | } 187 | return ownerType != null ? ownerType.equals(that.ownerType) : that.ownerType == null; 188 | } 189 | 190 | @Override 191 | public int hashCode() { 192 | 193 | int result = rawType != null ? rawType.hashCode() : 0; 194 | result = 31 * result + (typeArgs != null ? typeArgs.hashCode() : 0); 195 | result = 31 * result + (ownerType != null ? ownerType.hashCode() : 0); 196 | return result; 197 | } 198 | } 199 | 200 | } 201 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------