/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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.sftp.outbound;
import org.springframework.integration.file.remote.ClientCallbackWithoutResult;
import org.springframework.integration.file.remote.RemoteFileTemplate;
import org.springframework.integration.file.remote.handler.FileTransferringMessageHandler;
import org.springframework.integration.file.remote.session.SessionFactory;
import org.springframework.integration.file.support.FileExistsMode;
import org.springframework.integration.sftp.session.SftpRemoteFileTemplate;
import org.springframework.integration.sftp.support.GeneralSftpException;
import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.ChannelSftp.LsEntry;
import com.jcraft.jsch.SftpException;
/**
* Subclass of {@link FileTransferringMessageHandler} for SFTP.
*
* @author Gary Russell
* @since 4.3
*
*/
public class SftpMessageHandler extends FileTransferringMessageHandler<LsEntry> {
/**
* @param remoteFileTemplate the template.
* @see FileTransferringMessageHandler#FileTransferringMessageHandler
* (org.springframework.integration.file.remote.RemoteFileTemplate)
*/
public SftpMessageHandler(SftpRemoteFileTemplate remoteFileTemplate) {
super(remoteFileTemplate);
}
/**
*
* @param remoteFileTemplate the template.
* @param mode the file exists mode.
* @see FileTransferringMessageHandler#FileTransferringMessageHandler
* (org.springframework.integration.file.remote.RemoteFileTemplate, FileExistsMode)
*/
public SftpMessageHandler(SftpRemoteFileTemplate remoteFileTemplate, FileExistsMode mode) {
super(remoteFileTemplate, mode);
}
/**
* @param sessionFactory the session factory.
* @see FileTransferringMessageHandler#FileTransferringMessageHandler
* (SessionFactory)
*/
public SftpMessageHandler(SessionFactory<LsEntry> sessionFactory) {
this(new SftpRemoteFileTemplate(sessionFactory));
}
@Override
public boolean isChmodCapable() {
return true;
}
@Override
protected void doChmod(RemoteFileTemplate<LsEntry> remoteFileTemplate, final String path, final int chmod) {
remoteFileTemplate.executeWithClient((ClientCallbackWithoutResult<ChannelSftp>) client -> {
try {
client.chmod(chmod, path);
}
catch (SftpException e) {
throw new GeneralSftpException("Failed to execute chmod", e);
}
});
}
}