+ * Support Number classes including Byte, Short, Integer, Float, Double, Long, BigInteger, BigDecimal. This class + * delegates to {@link NumberUtils#parseNumber(String, Class, NumberFormat)} to perform the conversion. + * + * @author Mark Pollack + * @author Keith Donald + * + * @see Byte + * @see Short + * @see Integer + * @see Long + * @see java.math.BigInteger + * @see Float + * @see Double + * @see java.math.BigDecimal + * @see NumberUtils + */ +public class LocaleAwareStringToNumberConverterFactory implements ConverterFactory { + + private NumberFormat numberFormat; + + public LocaleAwareStringToNumberConverterFactory(NumberFormat numberFormat) { + this.numberFormat = numberFormat; + } + + @Override + public Converter getConverter(Class targetType) { + return new StringToNumber(targetType, numberFormat); + } + + private static final class StringToNumber implements Converter { + + private final Class targetType; + + private NumberFormat numberFormat; + + public StringToNumber(Class targetType, NumberFormat numberFormat) { + this.targetType = targetType; + this.numberFormat = numberFormat; + } + + @Override + public T convert(String source) { + return NumberUtils.parseNumber(source, this.targetType, numberFormat); + } + } + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/StringToDateConverter.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/StringToDateConverter.java new file mode 100644 index 000000000..76550a6dc --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/StringToDateConverter.java @@ -0,0 +1,70 @@ +/* + * Copyright 2013 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple; + +import java.text.DateFormat; +import java.text.ParseException; +import java.text.SimpleDateFormat; +import java.util.Date; + +import org.springframework.core.convert.converter.Converter; + +/** + * Converter for Strings to Date that can take into account date patterns + * + * @author Mark Pollack + * + */ +public class StringToDateConverter implements Converter { + + private final static String DEFAULT_DATE_PATTERN = "yyyy-MM-dd"; + + private DateFormat dateFormat; + + public StringToDateConverter() { + this.dateFormat = new SimpleDateFormat(DEFAULT_DATE_PATTERN); + this.dateFormat.setLenient(false); + + } + + public StringToDateConverter(String pattern) { + this.dateFormat = new SimpleDateFormat(pattern); + this.dateFormat.setLenient(false); + } + + public StringToDateConverter(DateFormat dateFormat) { + this.dateFormat = dateFormat; + } + + @Override + public Date convert(String source) { + try { + return dateFormat.parse(source); + } + catch (ParseException e) { + String pattern; + if (dateFormat instanceof SimpleDateFormat) { + pattern = ((SimpleDateFormat) dateFormat).toPattern(); + } + else { + pattern = dateFormat.toString(); + } + throw new IllegalArgumentException(e.getMessage() + ", format: [" + pattern + "]"); + } + } + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/Tuple.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/Tuple.java new file mode 100644 index 000000000..a0c4c5d75 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/Tuple.java @@ -0,0 +1,558 @@ +/* + * Copyright 2013 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple; + +import java.math.BigDecimal; +import java.util.Date; +import java.util.List; + +import org.springframework.core.convert.ConversionFailedException; + +/** + * Data structure that stores a fixed number of ordered key-value pairs and adds convenience methods to access values in + * a type-safe manner. + * + * The structure is immutable once created and values to not need to be of the same type. When accessing values, + * Spring's type conversion system is used to convert the value type to the requested type. The type conversion system + * is extensible. + * + * Tuples are created using the TupleBuilder class. + * + * @author Mark Pollack + * + */ +public interface Tuple { + + /** + * Return the number of elements in this tuple. + * + * @return number of elements + */ + int size(); + + /** + * Return the fields names that can reference elements by name in this tuple + * + * @return list of field names + */ + List getFieldNames(); + + /** + * Return the values for all the fields in this tuple + * + * @return list of values. + */ + List getValues(); + + /** + * Return true if the tuple contains a field of the given name + * + * @param name the name of the field + * @return true if present, otherwise false + */ + boolean hasFieldName(String name); + + /** + * Return the Java types of the fields in this tuple. + * + * @return the Java types of the fields in this tuple. + */ + @SuppressWarnings("rawtypes") + List getFieldTypes(); + + /** + * Return the number of fields in this tuple. + * + * @return the number of fields in this tuple. + */ + int getFieldCount(); + + /** + * Return the value of the field given the name + * + * @param name the name of the field + * @return value of the field + * @throws IllegalArgumentException if the name is not present + */ + Object getValue(String name); + + /** + * Return the value of the field given the index position + * + * @param index position in the tuple + * @return value of the field + * @throws IndexOutOfBoundsException if the index position is out of bounds. + */ + Object getValue(int index); + + /** + * Return the value of the field given the name + * + * @param name the field name + * @param valueClass Class to coerce the value into. + * @return value of the field + */ + T getValue(String name, Class valueClass); + + /** + * Return the value of the field given the index position + * + * @param index position in the tuple + * @param valueClass Class to coerce the value into + * @return value of the field + */ + T getValue(int index, Class valueClass); + + /** + * Read the {@link String} value given the field 'name'. + * + * @param name the field name. + * @return value of the field + */ + String getString(String name); + + /** + * Read the String value given the index position + * + * @param index position in the tuple + * @return value of the field + */ + String getString(int index); + + /** + * Read the {@link Tuple} value given the field 'name'. + * + * @param name the field name. + * @return value of the field + */ + Tuple getTuple(String name); + + /** + * Read the Tuple value given the index position + * + * @param index position in the tuple + * @return value of the field + */ + Tuple getTuple(int index); + + /** + * Read the {@link String} value at index 'index' including trailing whitespace (don't trim). + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + String getRawString(int index); + + /** + * Read the {@link String} value from column with given 'name' including trailing whitespace (don't + * trim). + * + * @param name the field name. + */ + String getRawString(String name); + + /** + * Read the 'char' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + char getChar(int index); + + + /** + * Read the 'char' value from field with given 'name'. + * + * @param name the field name. + * @throws IllegalArgumentException if a field with given name is not defined. + */ + char getChar(String name); + + /** + * Read the 'boolean' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + boolean getBoolean(int index); + + /** + * Read the 'boolean' value from field with given 'name'. + * + * @param name the field name. + * @throws IllegalArgumentException if a field with given name is not defined. + */ + boolean getBoolean(String name); + + /** + * Read the 'boolean' value at index 'index'. + * + * @param index the field index. + * @param trueValue the value that signifies {@link Boolean#TRUE true}; case-sensitive. + * @throws IndexOutOfBoundsException if the index is out of bounds, or if the supplied trueValue is + * null. + */ + boolean getBoolean(int index, String trueValue); + + /** + * Read the 'boolean' value from column with given 'name'. + * + * @param name the field name. + * @param trueValue the value that signifies {@link Boolean#TRUE true}; case-sensitive. + * @throws IllegalArgumentException if a column with given name is not defined, or if the supplied + * trueValue is null. + */ + boolean getBoolean(String name, String trueValue); + + /** + * Read the 'byte' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + byte getByte(int index); + + /** + * Read the 'byte' value from column with given 'name'. + * + * @param name the field name. + */ + byte getByte(String name); + + + /** + * Read the 'byte' value at index 'index'. using the supplied defaultValue if + * the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + byte getByte(int index, byte defaultValue); + + /** + * Read the 'byte' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + byte getByte(String name, byte defaultValue); + + /** + * Read the 'short' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + short getShort(int index); + + /** + * Read the 'short' value from column with given 'name'. + * + * @param name the field name. + */ + short getShort(String name); + + /** + * Read the 'short' value at index 'index'. using the supplied defaultValue + * if the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + short getShort(int index, short defaultValue); + + /** + * Read the 'short' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + short getShort(String name, short defaultValue); + + /** + * Read the 'int' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + int getInt(int index); + + /** + * Read the 'int' value from column with given 'name'. + * + * @param name the field name. + */ + int getInt(String name); + + /** + * Read the 'int' value at index 'index'. using the supplied defaultValue if + * the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + int getInt(int index, int defaultValue); + + /** + * Read the 'int' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + int getInt(String name, int defaultValue); + + /** + * Read the 'long' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + long getLong(int index); + + /** + * Read the 'int' value from column with given 'name'. + * + * @param name the field name. + */ + long getLong(String name); + + /** + * Read the 'long' value at index 'index'. using the supplied defaultValue if + * the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + long getLong(int index, long defaultValue); + + /** + * Read the 'long' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + long getLong(String name, long defaultValue); + + /** + * Read the 'float' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + float getFloat(int index); + + /** + * Read the 'float' value from column with given 'name'. + * + * @param name the field name. + */ + float getFloat(String name); + + /** + * Read the 'float' value at index 'index'. using the supplied defaultValue + * if the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + float getFloat(int index, float defaultValue); + + /** + * Read the 'float' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + float getFloat(String name, float defaultValue); + + + /** + * Read the 'double' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + double getDouble(int index); + + /** + * Read the 'double' value from column with given 'name'. + * + * @param name the field name. + */ + double getDouble(String name); + + + /** + * Read the 'double' value at index 'index'. using the supplied defaultValue + * if the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + double getDouble(int index, double defaultValue); + + /** + * Read the 'double' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + double getDouble(String name, double defaultValue); + + /** + * Read the 'BigDecimal' value at index 'index'. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + BigDecimal getBigDecimal(int index); + + /** + * Read the 'BigDecimal' value from column with given 'name'. + * + * @param name the field name. + */ + BigDecimal getBigDecimal(String name); + + /** + * Read the 'BigDecimal' value at index 'index'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + */ + BigDecimal getBigDecimal(int index, BigDecimal defaultValue); + + /** + * Read the 'BigDecimal' value from column with given 'name'. using the supplied + * defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + */ + BigDecimal getBigDecimal(String name, BigDecimal defaultValue); + + /** + * Read the java.util.Date value in default format at designated column index. + * + * @param index the field index. + * @throws IndexOutOfBoundsException if the index is out of bounds. + * @throws ConversionFailedException if the value is not parseable + */ + Date getDate(int index); + + /** + * Read the java.util.Date value in default format at designated column with given name. + * + * @param name the field name. + * @throws IllegalArgumentException if a column with given name is not defined + * @throws ConversionFailedException if the value is not parseable + */ + Date getDate(String name); + + /** + * Read the java.util.Date value in default format at designated column index using the + * supplied defaultValue if the field value is a zero length string or null. + * + * @param index the field index. + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + * @throws ConversionFailedException if the value is not parseable + */ + Date getDate(int index, Date defaultValue); + + /** + * Read the java.util.Date value in default format at designated column with given name. + * using the supplied defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param defaultValue the default value to return if field value is not found. + * @throws IllegalArgumentException if a column with given name is not defined + * @throws ConversionFailedException if the value is not parseable + */ + Date getDate(String name, Date defaultValue); + + /** + * Read the java.util.Date value in default format at designated column index. + * + * @param index the field index. + * @param pattern the pattern describing the date and time format + * @throws IndexOutOfBoundsException if the index is out of bounds. + * @throws IllegalArgumentException if the date cannot be parsed. + * + */ + Date getDateWithPattern(int index, String pattern); + + /** + * Read the java.util.Date value in given format from column with given name. + * + * @param name the field name. + * @param pattern the pattern describing the date and time format + * @throws IllegalArgumentException if a column with given name is not defined or if the specified field cannot be + * parsed + * + */ + Date getDateWithPattern(String name, String pattern); + + /** + * Read the java.util.Date value in default format at designated column index. using the + * supplied defaultValue if the field value is a zero length string or null. + * + * @param index the field index. + * @param pattern the pattern describing the date and time format + * @param defaultValue the default value to return if field value is not found. + * @throws IndexOutOfBoundsException if the index is out of bounds. + * @throws IllegalArgumentException if the date cannot be parsed. + * + */ + Date getDateWithPattern(int index, String pattern, Date defaultValue); + + /** + * Read the java.util.Date value in given format from column with given name. using the + * supplied defaultValue if the field value is a zero length string or null. + * + * @param name the field name. + * @param pattern the pattern describing the date and time format + * @param defaultValue the default value to return if field value is not found. + * @throws IllegalArgumentException if a column with given name is not defined or if the specified field cannot be + * parsed + * + */ + Date getDateWithPattern(String name, String pattern, Date defaultValue); + + /** + * Use SpEL expression to return a subset of the tuple that matches the expression + * + * @param expression SpEL expression to select from a Map, e.g. ?[key.startsWith('b')] + * @return a new Tuple with data selected from the current instance. + */ + Tuple select(String expression); + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleBuilder.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleBuilder.java new file mode 100644 index 000000000..6a9bb788d --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleBuilder.java @@ -0,0 +1,217 @@ +/* + * Copyright 2013-2015 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple; + +import java.text.DateFormat; +import java.text.NumberFormat; +import java.text.SimpleDateFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Locale; + +import org.springframework.core.convert.converter.Converter; +import org.springframework.core.convert.support.ConfigurableConversionService; +import org.springframework.util.AlternativeJdkIdGenerator; +import org.springframework.util.Assert; +import org.springframework.util.IdGenerator; + +/** + * Builder class to create Tuple instances. + * + * Default Locale is US for NumberFormat and default DatePattern is "yyyy-MM-dd" + * + * Note: Using a custom conversion service that is instance based (not configured + * as a singleton) will have significant performance impacts. + * + * @author Mark Pollack + * @author David Turanski + * @author Michael Minella + * @author Gunnar Hillert + * + */ +public class TupleBuilder { + + private List names = new ArrayList<>(); + + private List values = new ArrayList<>(); + + private static final ConfigurableConversionService defaultConversionService; + + private ConfigurableConversionService customConversionService = null; + + private final static String DEFAULT_DATE_PATTERN = "yyyy-MM-dd"; + + private final static Locale DEFAULT_LOCALE = Locale.US; + + private static Converter tupleToStringConverter = new TupleToJsonStringConverter(); + + private static Converter stringToTupleConverter = new JsonStringToTupleConverter(); + + private static final IdGenerator defaultIdGenerator = new AlternativeJdkIdGenerator(); + + static { + defaultConversionService = new DefaultTupleConversionService(); + defaultConversionService.addConverterFactory(new LocaleAwareStringToNumberConverterFactory(NumberFormat + .getInstance(DEFAULT_LOCALE))); + DateFormat dateFormat = new SimpleDateFormat(DEFAULT_DATE_PATTERN); + dateFormat.setLenient(false); + defaultConversionService.addConverter(new StringToDateConverter(dateFormat)); + } + + public static TupleBuilder tuple() { + return new TupleBuilder(); + } + + public Tuple of(String k1, Object v1) { + return newTuple(namesOf(k1), valuesOf(v1)); + } + + public Tuple of(String k1, Object v1, String k2, Object v2) { + addEntry(k1, v1); + addEntry(k2, v2); + return build(); + } + + public Tuple of(String k1, Object v1, String k2, Object v2, String k3, Object v3) { + addEntry(k1, v1); + addEntry(k2, v2); + addEntry(k3, v3); + return build(); + } + + public Tuple of(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4) { + addEntry(k1, v1); + addEntry(k2, v2); + addEntry(k3, v3); + addEntry(k4, v4); + return build(); + } + + public Tuple ofNamesAndValues(List names, List values) { + this.names = names; + this.values = values; + return build(); + } + + public TupleBuilder put(String k1, Object v1) { + addEntry(k1, v1); + return this; + } + + /** + * Add all names and values of the tuple to the built tuple. + * @param tuple names and value to add to the tuple being built + * @return builder to continue creating a new tuple instance + */ + public TupleBuilder putAll(Tuple tuple) { + for (int i = 0; i < tuple.size(); i++) { + Object value = tuple.getValues().get(i); + String name = tuple.getFieldNames().get(i); + addEntry(name, value); + } + return this; + } + + public Tuple build() { + return newTuple(names, values); + } + + public static Tuple fromString(String source) { + return stringToTupleConverter.convert(source); + } + + public TupleBuilder setConfigurableConversionService(ConfigurableConversionService formattingConversionService) { + Assert.notNull(formattingConversionService); + this.customConversionService = formattingConversionService; + return this; + } + + public ConversionServiceBuilder setFormats(Locale locale, DateFormat dateFormat) { + return new ConversionServiceBuilder(this, locale, dateFormat); + } + + void addEntry(String k1, Object v1) { + names.add(k1); + values.add(v1); + } + + static List valuesOf(Object v1) { + ArrayList values = new ArrayList<>(); + values.add(v1); + return Collections.unmodifiableList(values); + } + + static List namesOf(String k1) { + List fields = new ArrayList<>(1); + fields.add(k1); + return Collections.unmodifiableList(fields); + + } + + protected Tuple newTuple(List names, List values) { + DefaultTuple tuple; + + if(customConversionService != null) { + tuple = new DefaultTuple(names, values, customConversionService); + } + else { + tuple = new DefaultTuple(names, values, defaultConversionService); + } + + tuple.setTupleToStringConverter(tupleToStringConverter); + return tuple; + } + + /** + * Provides the ability to inject a {@link ConfigurableConversionService} as a way to + * customize conversion behavior in the built {@link Tuple}. + * + * @author Michael Minella + */ + public static class ConversionServiceBuilder { + + private TupleBuilder builder; + + private Locale locale; + + private DateFormat dateFormat; + + ConversionServiceBuilder(TupleBuilder builder, Locale locale, DateFormat dateFormat) { + this.builder = builder; + this.locale = locale; + this.dateFormat = dateFormat; + } + + public TupleBuilder setConfigurableConversionService(ConfigurableConversionService formattingConversionService) { + Assert.notNull(formattingConversionService); + + if(locale != null) { + formattingConversionService.addConverterFactory(new LocaleAwareStringToNumberConverterFactory(NumberFormat + .getInstance(locale))); + } + + if(dateFormat != null) { + formattingConversionService.addConverter(new StringToDateConverter(dateFormat)); + } + + builder.setConfigurableConversionService(formattingConversionService); + + return builder; + } + } +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleJsonMarshaller.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleJsonMarshaller.java new file mode 100644 index 000000000..094270f86 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleJsonMarshaller.java @@ -0,0 +1,30 @@ +/* + * Copyright 2015 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple; + + +/** + * @author David Turanski + * + */ +public class TupleJsonMarshaller extends TupleStringMarshaller { + + public TupleJsonMarshaller() { + super(new TupleToJsonStringConverter(), new JsonStringToTupleConverter()); + } + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleStringMarshaller.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleStringMarshaller.java new file mode 100644 index 000000000..d48e53460 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleStringMarshaller.java @@ -0,0 +1,44 @@ +/* + * Copyright 2015 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple; + +import org.springframework.core.convert.converter.Converter; + +/** + * @author David Turanski + * + */ +public class TupleStringMarshaller { + + private final Converter tupleToStringConverter; + + private final Converter stringToTupleConverter; + + public TupleStringMarshaller(Converter tupleToStringConverter, + Converter stringToTupleConverter) { + this.tupleToStringConverter = tupleToStringConverter; + this.stringToTupleConverter = stringToTupleConverter; + } + + public Tuple toTuple(String source) { + return stringToTupleConverter.convert(source); + } + + public String fromTuple(Tuple source) { + return tupleToStringConverter.convert(source); + } +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleToJsonStringConverter.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleToJsonStringConverter.java new file mode 100644 index 000000000..48bd7f744 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/TupleToJsonStringConverter.java @@ -0,0 +1,70 @@ +/* + * Copyright 2002-2015 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple; + +import org.springframework.core.convert.converter.Converter; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; + +/** + * Converts a Tuple to JSON representation + * + * @author David Turanski + * @author Gunnar Hillert + * + */ +public class TupleToJsonStringConverter implements Converter { + + private final ObjectMapper mapper = new ObjectMapper(); + + @Override + public String convert(Tuple source) { + ObjectNode root = toObjectNode(source); + String json = null; + try { + json = mapper.writeValueAsString(root); + } + catch (Exception e) { + throw new IllegalArgumentException("Tuple to string conversion failed", e); + } + return json; + } + + private ObjectNode toObjectNode(Tuple source) { + ObjectNode root = mapper.createObjectNode(); +// root.put("id", source.getId().toString()); +// root.put("timestamp", source.getTimestamp()); + for (int i = 0; i < source.size(); i++) { + Object value = source.getValues().get(i); + String name = source.getFieldNames().get(i); + if (value != null) { + if (value instanceof Tuple) { + root.putPOJO(name, toObjectNode((Tuple) value)); + } + else if (!value.getClass().isPrimitive()) { + root.putPOJO(name, root.pojoNode(value)); + } + else { + root.put(name, value.toString()); + } + } + } + return root; + } + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/JsonToTupleTransformer.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/JsonToTupleTransformer.java new file mode 100644 index 000000000..3e8da7ef5 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/JsonToTupleTransformer.java @@ -0,0 +1,60 @@ +/* + * Copyright 2013 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple.integration; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.springframework.integration.transformer.AbstractPayloadTransformer; +import org.springframework.cloud.stream.tuple.Tuple; +import org.springframework.cloud.stream.tuple.TupleBuilder; + +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +/** + * Converts from a json string into a tuple data structure. + * + * @author Mark Fisher + */ +public class JsonToTupleTransformer extends AbstractPayloadTransformer { + + private final ObjectMapper mapper = new ObjectMapper(); + + public JsonToTupleTransformer() { + mapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true); + } + + @Override + public Tuple transformPayload(String json) throws Exception { + List names = new ArrayList(); + List values = new ArrayList(); + JsonNode node = this.mapper.readTree(json); + Iterator fieldNames = node.fieldNames(); + while (fieldNames.hasNext()) { + String name = fieldNames.next(); + JsonNode valueNode = node.get(name); + Object value = mapper.treeToValue(valueNode, Object.class); + names.add(name); + values.add(value); + } + return TupleBuilder.tuple().ofNamesAndValues(names, values); + } + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/MapToTupleTransformer.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/MapToTupleTransformer.java new file mode 100644 index 000000000..daec0dfc3 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/MapToTupleTransformer.java @@ -0,0 +1,48 @@ +/* + * Copyright 2013 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple.integration; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import org.springframework.integration.transformer.AbstractPayloadTransformer; +import org.springframework.cloud.stream.tuple.Tuple; +import org.springframework.cloud.stream.tuple.TupleBuilder; + +/** + * Converts from a Map to the Tuple data structure. + * + * @author Mark Pollack + */ +public class MapToTupleTransformer extends AbstractPayloadTransformer, Tuple> { + + @Override + public Tuple transformPayload(Map map) { + + List newNames = new ArrayList(); + List newValues = new ArrayList(); + for (Object name : map.keySet()) { + newNames.add(name.toString()); + } + for (Object value : map.values()) { + newValues.add(value); + } + return TupleBuilder.tuple().ofNamesAndValues(newNames, newValues); + + } +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/package-info.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/package-info.java new file mode 100644 index 000000000..97950fb5b --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/integration/package-info.java @@ -0,0 +1,5 @@ +/** + * Contains classes that supports tuple integration such as tuple transformers etc., + */ + +package org.springframework.cloud.stream.tuple.integration; diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/DefaultTupleSerializer.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/DefaultTupleSerializer.java new file mode 100644 index 000000000..dfdcbb6ba --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/DefaultTupleSerializer.java @@ -0,0 +1,55 @@ +/* + * Copyright 2015 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple.kryo; + +import java.util.ArrayList; +import java.util.List; + +import com.esotericsoftware.kryo.Kryo; +import com.esotericsoftware.kryo.Serializer; +import com.esotericsoftware.kryo.io.Input; +import com.esotericsoftware.kryo.io.Output; + +import org.springframework.cloud.stream.tuple.Tuple; +import org.springframework.cloud.stream.tuple.TupleBuilder; + +/** + * Deserializes Tuples by writing the field names and then the values as class/object pairs + * followed by the tuple Id and timestamp. + * + * @author David Turanski + */ +public class DefaultTupleSerializer extends Serializer { + @Override + public void write(Kryo kryo, Output output, Tuple tuple) { + kryo.writeObject(output, tuple.getFieldNames()); + for (Object val: tuple.getValues()) { + kryo.writeClassAndObject(output, val); + } + } + + @Override + @SuppressWarnings("unchecked") + public Tuple read(Kryo kryo, Input input, Class type) { + List names = kryo.readObject(input, ArrayList.class); + List values = new ArrayList<>(names.size()); + for (int i = 0; i < names.size(); i++) { + Object val = kryo.readClassAndObject(input); + values.add(i, val); + } + return TupleBuilder.tuple().ofNamesAndValues(names, values); + } +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/TupleKryoRegistrar.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/TupleKryoRegistrar.java new file mode 100644 index 000000000..43c2469e8 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/TupleKryoRegistrar.java @@ -0,0 +1,52 @@ +/* + * Copyright 2015 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple.kryo; + +import java.util.ArrayList; +import java.util.List; + +import org.springframework.integration.codec.kryo.AbstractKryoRegistrar; +import org.springframework.integration.codec.kryo.KryoRegistrar; +import org.springframework.cloud.stream.tuple.DefaultTuple; + +import com.esotericsoftware.kryo.Registration; +import com.esotericsoftware.kryo.serializers.CollectionSerializer; + +/** + * A {@link KryoRegistrar} + * used to register a Tuple serializer. + * @author David Turanski + * @since 1.2 + */ +public class TupleKryoRegistrar extends AbstractKryoRegistrar { + + private final static int TUPLE_REGISTRATION_ID = 41; + + private final static int ARRAY_LIST_REGISTRATION_ID = 42; + + private final DefaultTupleSerializer defaultTupleSerializer = new DefaultTupleSerializer(); + + private final CollectionSerializer collectionSerializer = new CollectionSerializer(); + + + @Override + public List getRegistrations() { + List registrations = new ArrayList<>(2); + registrations.add(new Registration(DefaultTuple.class, defaultTupleSerializer, TUPLE_REGISTRATION_ID)); + registrations.add(new Registration(ArrayList.class, collectionSerializer, ARRAY_LIST_REGISTRATION_ID)); + return registrations; + } +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/package-info.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/package-info.java new file mode 100644 index 000000000..c8e4b4bc4 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/kryo/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2014 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Contains tuple processor classes. + */ + +package org.springframework.cloud.stream.tuple.kryo; diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/package-info.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/package-info.java new file mode 100644 index 000000000..cb67ae4c3 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/package-info.java @@ -0,0 +1,5 @@ +/** + * Base package for tuple classes. + */ + +package org.springframework.cloud.stream.tuple; diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/processor/TupleProcessor.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/processor/TupleProcessor.java new file mode 100644 index 000000000..3d3a14a77 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/processor/TupleProcessor.java @@ -0,0 +1,30 @@ +/* + * Copyright 2013 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple.processor; + +import org.springframework.cloud.stream.tuple.Tuple; + +/** + * Simple type-safe process callback method that returns another Tuple + * + * @author Mark Pollack + * + */ +public interface TupleProcessor { + + Tuple process(Tuple tuple); +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/processor/package-info.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/processor/package-info.java new file mode 100644 index 000000000..d0f935d3b --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/processor/package-info.java @@ -0,0 +1,5 @@ +/** + * Contains tuple processor classes. + */ + +package org.springframework.cloud.stream.tuple.processor; diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/spel/TuplePropertyAccessor.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/spel/TuplePropertyAccessor.java new file mode 100644 index 000000000..6a934c836 --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/spel/TuplePropertyAccessor.java @@ -0,0 +1,116 @@ +/* + * Copyright 2013 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.stream.tuple.spel; + +import org.springframework.expression.AccessException; +import org.springframework.expression.EvaluationContext; +import org.springframework.expression.PropertyAccessor; +import org.springframework.expression.TypedValue; +import org.springframework.cloud.stream.tuple.Tuple; + +/** + * A {@link PropertyAccessor} implementation that enables reading of {@link Tuple} values using dot notation within SpEL + * expressions. Writing is not supported since {@link Tuple}s are immutable. + * + * @author Mark Fisher + */ +public class TuplePropertyAccessor implements PropertyAccessor { + + @Override + public Class[] getSpecificTargetClasses() { + return new Class[] { Tuple.class }; + } + + @Override + public boolean canRead(EvaluationContext context, Object target, String name) throws AccessException { + Tuple tuple = (Tuple) target; + if (tuple.hasFieldName(name)) { + return true; + } + return maybeIndex(name, tuple) != null; + } + + /** + * Return an integer if the String property name can be parsed as an int, or null otherwise. + */ + private Integer maybeIndex(String name, Tuple tuple) { + Integer index = null; + try { + int i = Integer.parseInt(name); + if (i > -1 && tuple.size() > i) { + index = i; + } + } + catch (NumberFormatException e) { + // not an integer + } + return index; + } + + @Override + public TypedValue read(EvaluationContext context, Object target, String name) throws AccessException { + Tuple tuple = (Tuple) target; + boolean hasKey = false; + Object value = null; + if (tuple.hasFieldName(name)) { + hasKey = true; + value = tuple.getValue(name); + } + else { + Integer index = maybeIndex(name, tuple); + if (index != null) { + hasKey = true; + value = tuple.getValue(index); + } + } + if (value == null && !hasKey) { + throw new TupleAccessException(name); + } + return new TypedValue(value); + } + + @Override + public boolean canWrite(EvaluationContext context, Object target, String name) throws AccessException { + return false; + } + + @Override + public void write(EvaluationContext context, Object target, String name, Object newValue) throws AccessException { + throw new UnsupportedOperationException("Tuple is immutable"); + } + + /** + * Exception thrown from {@code read} in order to reset a cached PropertyAccessor, allowing other accessors to have + * a try. + */ + @SuppressWarnings("serial") + private static class TupleAccessException extends AccessException { + + private final String name; + + public TupleAccessException(String name) { + super(null); + this.name = name; + } + + @Override + public String getMessage() { + return "Tuple does not contain a value for field name '" + this.name + "'"; + } + } + +} diff --git a/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/spel/package-info.java b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/spel/package-info.java new file mode 100644 index 000000000..830847f6e --- /dev/null +++ b/spring-cloud-stream-tuple/src/main/java/org/springframework/cloud/stream/tuple/spel/package-info.java @@ -0,0 +1,5 @@ +/** + * Contains tuple SpEL accessor classes. + */ + +package org.springframework.cloud.stream.tuple.spel;
name
index
char
boolean
trueValue
null
byte
defaultValue
short
int
long
float
double
BigDecimal
java.util.Date