Added ByteStreamTargetAdapter

2008-01-16 14:46:29 +00:00
parent b5335e71cc
commit 40182cb07b
2 changed files with 299 additions and 0 deletions
--- a/spring-integration-core/src/main/java/org/springframework/integration/adapter/stream/ByteStreamTargetAdapter.java
+++ b/spring-integration-core/src/main/java/org/springframework/integration/adapter/stream/ByteStreamTargetAdapter.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2002-2007 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.integration.adapter.stream;
+
+import java.io.BufferedOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+
+import org.springframework.integration.MessageHandlingException;
+import org.springframework.integration.adapter.AbstractTargetAdapter;
+
+/**
+ * A target adapter that writes a byte array to an {@link OutputStream}.
+ * 
+ * @author Mark Fisher
+ */
+public class ByteStreamTargetAdapter extends AbstractTargetAdapter {
+
+	private BufferedOutputStream stream;
+
+
+	public ByteStreamTargetAdapter(OutputStream stream) {
+		this(stream, -1);
+	}
+
+	public ByteStreamTargetAdapter(OutputStream stream, int bufferSize) {
+		if (bufferSize > 0) {
+			this.stream = new BufferedOutputStream(stream, bufferSize);
+		}
+		else {
+			this.stream = new BufferedOutputStream(stream);
+		}
+	}
+
+
+	@Override
+	protected boolean sendToTarget(Object object) {
+		if (object == null) {
+			if (logger.isWarnEnabled()) {
+				logger.warn(this.getClass().getSimpleName() + " received null object");
+			}
+			return false;
+		}
+		try {
+			if (object instanceof String) {
+				this.stream.write(((String) object).getBytes());
+			}
+			else if (object instanceof byte[]){
+				this.stream.write((byte[]) object);
+			}
+			else {
+				throw new MessageHandlingException(this.getClass().getSimpleName() +
+						" only supports byte array and String-based messages");
+			}
+			this.stream.flush();
+			return true;
+		}
+		catch (IOException e) {
+			throw new MessageHandlingException("IO failure occurred in adapter", e);
+		}
+	}
+
+}
--- a/spring-integration-core/src/test/java/org/springframework/integration/adapter/stream/ByteStreamTargetAdapterTests.java
+++ b/spring-integration-core/src/test/java/org/springframework/integration/adapter/stream/ByteStreamTargetAdapterTests.java
@@ -0,0 +1,222 @@
+/*
+ * Copyright 2002-2007 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.integration.adapter.stream;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+
+import org.junit.Test;
+
+import org.springframework.integration.channel.MessageChannel;
+import org.springframework.integration.channel.SimpleChannel;
+import org.springframework.integration.dispatcher.ChannelPollingMessageRetriever;
+import org.springframework.integration.dispatcher.DispatcherTask;
+import org.springframework.integration.message.GenericMessage;
+import org.springframework.integration.message.StringMessage;
+
+/**
+ * @author Mark Fisher
+ */
+public class ByteStreamTargetAdapterTests {
+
+	@Test
+	public void testSingleByteArray() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		DispatcherTask dispatcherTask = new DispatcherTask(channel);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		int count = dispatcherTask.dispatch();
+		assertEquals(1, count);
+		byte[] result = stream.toByteArray();
+		assertEquals(3, result.length);
+		assertEquals(1, result[0]);
+		assertEquals(2, result[1]);
+		assertEquals(3, result[2]);
+	}
+
+	@Test
+	public void testSingleString() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		DispatcherTask dispatcherTask = new DispatcherTask(channel);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new StringMessage("foo"));
+		int count = dispatcherTask.dispatch();
+		assertEquals(1, count);
+		byte[] result = stream.toByteArray();
+		assertEquals(3, result.length);
+		assertEquals("foo", new String(result));
+	}
+
+	@Test
+	public void testMaxMessagesPerTaskSameAsMessageCount() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(3);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(3, dispatcherTask.dispatch());
+		byte[] result = stream.toByteArray();
+		assertEquals(9, result.length);
+		assertEquals(1, result[0]);
+		assertEquals(9, result[8]);
+	}
+
+	@Test
+	public void testMaxMessagesPerTaskLessThanMessageCount() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(2);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(2, dispatcherTask.dispatch());
+		byte[] result = stream.toByteArray();
+		assertEquals(6, result.length);
+		assertEquals(1, result[0]);
+	}
+
+	@Test
+	public void testMaxMessagesPerTaskExceedsMessageCount() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(5);
+		retriever.setReceiveTimeout(0);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(3, dispatcherTask.dispatch());
+		byte[] result = stream.toByteArray();
+		assertEquals(9, result.length);
+		assertEquals(1, result[0]);
+	}
+
+	@Test
+	public void testMaxMessagesLessThanMessageCountWithMultipleDispatches() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(2);
+		retriever.setReceiveTimeout(0);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(2, dispatcherTask.dispatch());
+		byte[] result1 = stream.toByteArray();
+		assertEquals(6, result1.length);
+		assertEquals(1, result1[0]);
+		assertEquals(1, dispatcherTask.dispatch());
+		byte[] result2 = stream.toByteArray();
+		assertEquals(9, result2.length);
+		assertEquals(1, result2[0]);
+		assertEquals(7, result2[6]);
+	}
+
+	@Test
+	public void testMaxMessagesExceedsMessageCountWithMultipleDispatches() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(5);
+		retriever.setReceiveTimeout(0);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(3, dispatcherTask.dispatch());
+		byte[] result1 = stream.toByteArray();
+		assertEquals(9, result1.length);
+		assertEquals(1, result1[0]);
+		assertEquals(0, dispatcherTask.dispatch());
+		byte[] result2 = stream.toByteArray();
+		assertEquals(9, result2.length);	
+		assertEquals(1, result2[0]);
+	}
+
+	@Test
+	public void testStreamResetBetweenDispatches() {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(2);
+		retriever.setReceiveTimeout(0);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(2, dispatcherTask.dispatch());
+		byte[] result1 = stream.toByteArray();
+		assertEquals(6, result1.length);
+		stream.reset();
+		assertEquals(1, dispatcherTask.dispatch());
+		byte[] result2 = stream.toByteArray();
+		assertEquals(3, result2.length);
+		assertEquals(7, result2[0]);
+	}
+
+	@Test
+	public void testStreamWriteBetweenDispatches() throws IOException {
+		ByteArrayOutputStream stream = new ByteArrayOutputStream();
+		MessageChannel channel = new SimpleChannel();
+		ByteStreamTargetAdapter adapter = new ByteStreamTargetAdapter(stream);
+		ChannelPollingMessageRetriever retriever = new ChannelPollingMessageRetriever(channel);
+		retriever.setMaxMessagesPerTask(2);
+		retriever.setReceiveTimeout(0);
+		DispatcherTask dispatcherTask = new DispatcherTask(retriever);
+		dispatcherTask.addHandler(adapter);
+		channel.send(new GenericMessage<byte[]>(new byte[] {1,2,3}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {4,5,6}));
+		channel.send(new GenericMessage<byte[]>(new byte[] {7,8,9}));
+		assertEquals(2, dispatcherTask.dispatch());
+		byte[] result1 = stream.toByteArray();
+		assertEquals(6, result1.length);
+		stream.write(new byte[] {123});
+		stream.flush();
+		assertEquals(1, dispatcherTask.dispatch());
+		byte[] result2 = stream.toByteArray();
+		assertEquals(10, result2.length);
+		assertEquals(1, result2[0]);
+		assertEquals(123, result2[6]);
+		assertEquals(7, result2[7]);
+	}
+
+}