Merge pull request #672 from garyrussell/INT-2438

* INT-2438: Fix Temporary Remote Directory
This commit is contained in:
Mark Fisher
2012-11-09 14:48:57 -05:00
2 changed files with 50 additions and 18 deletions

View File

@@ -45,6 +45,7 @@ import org.springframework.util.StringUtils;
* @author Josh Long
* @author Oleg Zhurakousky
* @author David Turanski
* @author Gary Russell
* @since 2.0
*/
public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
@@ -81,7 +82,7 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
public void setAutoCreateDirectory(boolean autoCreateDirectory) {
this.autoCreateDirectory = autoCreateDirectory;
}
public void setRemoteFileSeparator(String remoteFileSeparator) {
Assert.notNull(remoteFileSeparator, "'remoteFileSeparator' must not be null");
this.remoteFileSeparator = remoteFileSeparator;
@@ -91,12 +92,12 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
Assert.notNull(remoteDirectoryExpression, "remoteDirectoryExpression must not be null");
this.directoryExpressionProcessor = new ExpressionEvaluatingMessageProcessor<String>(remoteDirectoryExpression, String.class);
}
public void setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression) {
Assert.notNull(temporaryRemoteDirectoryExpression, "temporaryRemoteDirectoryExpression must not be null");
this.temporaryDirectoryExpressionProcessor = new ExpressionEvaluatingMessageProcessor<String>(temporaryRemoteDirectoryExpression, String.class);
}
protected String getTemporaryFileSuffix() {
return this.temporaryFileSuffix;
}
@@ -123,13 +124,14 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
public void setCharset(String charset) {
this.charset = charset;
}
public void setTemporaryFileSuffix(String temporaryFileSuffix) {
Assert.notNull(temporaryFileSuffix, "'temporaryFileSuffix' must not be null");
this.hasExplicitlySetSuffix = true;
this.temporaryFileSuffix = temporaryFileSuffix;
}
@Override
protected void onInit() throws Exception {
Assert.notNull(this.directoryExpressionProcessor, "remoteDirectoryExpression is required");
if (this.autoCreateDirectory){
@@ -149,7 +151,7 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
String remoteDirectory = this.directoryExpressionProcessor.processMessage(message);
String temporaryRemoteDirectory = remoteDirectory;
if (this.temporaryDirectoryExpressionProcessor != null){
temporaryRemoteDirectory = this.directoryExpressionProcessor.processMessage(message);
temporaryRemoteDirectory = this.temporaryDirectoryExpressionProcessor.processMessage(message);
}
String fileName = this.fileNameGenerator.generateFileName(message);
this.sendFileToRemoteDirectory(file, temporaryRemoteDirectory, remoteDirectory, fileName, session);
@@ -192,7 +194,7 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
if (payload instanceof File) {
sendableFile = (File) payload;
}
else if (payload instanceof byte[] || payload instanceof String) {
else if (payload instanceof byte[] || payload instanceof String) {
String tempFileName = this.fileNameGenerator.generateFileName(message) + ".tmp";
sendableFile = new File(this.temporaryDirectory, tempFileName); // will only create temp file for String/byte[]
byte[] bytes = null;
@@ -215,7 +217,7 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
}
}
private void sendFileToRemoteDirectory(File file, String temporaryRemoteDirectory, String remoteDirectory, String fileName, Session<F> session)
private void sendFileToRemoteDirectory(File file, String temporaryRemoteDirectory, String remoteDirectory, String fileName, Session<F> session)
throws FileNotFoundException, IOException {
remoteDirectory = this.normalizeDirectoryPath(remoteDirectory);
@@ -226,17 +228,17 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
// write remote file first with temporary file extension if enabled
String tempFilePath = tempRemoteFilePath + (useTemporaryFileName ? this.temporaryFileSuffix : "");
if (this.autoCreateDirectory) {
try {
this.makeDirectories(remoteDirectory, session);
}
}
catch (IllegalStateException e) {
// Revert to old FTP behavior if recursive mkdir fails, for backwards compatibility
session.mkdir(remoteDirectory);
}
}
FileInputStream fileInputStream = new FileInputStream(file);
try {
session.write(fileInputStream, tempFilePath);
@@ -244,7 +246,7 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
if (useTemporaryFileName){
session.rename(tempFilePath, remoteFilePath);
}
}
}
catch (Exception e) {
throw new MessagingException("Failed to write to '" + tempFilePath + "' while uploading the file", e);
}
@@ -252,22 +254,22 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
fileInputStream.close();
}
}
private String normalizeDirectoryPath(String directoryPath){
if (!StringUtils.hasText(directoryPath)) {
directoryPath = "";
}
else if (!directoryPath.endsWith(this.remoteFileSeparator)) {
directoryPath += this.remoteFileSeparator;
directoryPath += this.remoteFileSeparator;
}
return directoryPath;
}
private void makeDirectories(String path, Session<F> session) throws IOException {
if (!session.exists(path)){
if (!session.exists(path)){
int nextSeparatorIndex = path.lastIndexOf(remoteFileSeparator);
if (nextSeparatorIndex > -1){
List<String> pathsToCreate = new LinkedList<String>();
while (nextSeparatorIndex > -1){
@@ -276,12 +278,12 @@ public class FileTransferringMessageHandler<F> extends AbstractMessageHandler {
// no more paths to create
break;
}
else {
else {
pathsToCreate.add(0, pathSegment);
nextSeparatorIndex = pathSegment.lastIndexOf(remoteFileSeparator);
}
}
for (String pathToCreate : pathsToCreate) {
if (logger.isDebugEnabled()){
logger.debug("Creating '" + pathToCreate + "'");

View File

@@ -17,6 +17,7 @@
package org.springframework.integration.file.remote.handler;
import static junit.framework.Assert.assertFalse;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
@@ -24,12 +25,14 @@ import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.io.InputStream;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.Test;
import org.mockito.Mockito;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.springframework.expression.ExpressionParser;
import org.springframework.expression.common.LiteralExpression;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.integration.Message;
import org.springframework.integration.file.remote.session.Session;
@@ -39,6 +42,7 @@ import org.springframework.integration.support.MessageBuilder;
/**
* @author Oleg Zhurakousky
* @author Gary Russell
*/
public class FileTransferringMessageHandlerTests {
@@ -64,6 +68,32 @@ public class FileTransferringMessageHandlerTests {
verify(session, times(1)).write(Mockito.any(InputStream.class), Mockito.anyString());
}
@SuppressWarnings("unchecked")
@Test
public <F> void testTemporaryRemoteDir() throws Exception{
SessionFactory<F> sf = mock(SessionFactory.class);
Session<F> session = mock(Session.class);
final AtomicReference<String> temporaryPath = new AtomicReference<String>();
final AtomicReference<String> finalPath = new AtomicReference<String>();
when(sf.getSession()).thenReturn(session);
doAnswer(new Answer<Object>() {
public Object answer(InvocationOnMock invocation) throws Throwable {
temporaryPath.set((String) invocation.getArguments()[0]);
finalPath.set((String) invocation.getArguments()[1]);
return null;
}
}).when(session).rename(Mockito.anyString(), Mockito.anyString());
FileTransferringMessageHandler<F> handler = new FileTransferringMessageHandler<F>(sf);
handler.setRemoteDirectoryExpression(new LiteralExpression("foo"));
handler.setTemporaryRemoteDirectoryExpression(new LiteralExpression("bar"));
handler.afterPropertiesSet();
handler.handleMessage(new GenericMessage<String>("hello"));
verify(session, times(1)).write(Mockito.any(InputStream.class), Mockito.anyString());
assertEquals("bar", temporaryPath.get().substring(0, 3));
assertEquals("foo", finalPath.get().substring(0, 3));
}
@SuppressWarnings("unchecked")
@Test
public <F> void testRemoteDirWithNull() throws Exception{