org.springframework.integration.ftp.dsl.Ftp.java Source code

Introduction

Here is the source code for org.springframework.integration.ftp.dsl.Ftp.java

Source

/*
 * Copyright 2014-2019 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
 *
 *      https://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.ftp.dsl;

import java.io.File;
import java.util.Comparator;

import org.apache.commons.net.ftp.FTPFile;

import org.springframework.integration.file.remote.MessageSessionCallback;
import org.springframework.integration.file.remote.RemoteFileTemplate;
import org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway;
import org.springframework.integration.file.remote.session.SessionFactory;
import org.springframework.integration.file.support.FileExistsMode;
import org.springframework.integration.ftp.gateway.FtpOutboundGateway;
import org.springframework.integration.ftp.session.FtpRemoteFileTemplate;

/**
 * The factory for FTP components.
 *
 * @author Artem Bilan
 * @author Gary Russell
 * @since 5.0
 */
public final class Ftp {

    /**
     * A {@link FtpInboundChannelAdapterSpec} factory for an inbound channel adapter spec.
     * @param sessionFactory the session factory.
     * @return the spec.
     */
    public static FtpInboundChannelAdapterSpec inboundAdapter(SessionFactory<FTPFile> sessionFactory) {
        return inboundAdapter(sessionFactory, null);
    }

    /**
     * A {@link FtpInboundChannelAdapterSpec} factory for an inbound channel adapter spec.
     * @param sessionFactory the session factory.
     * @param receptionOrderComparator the comparator.
     * @return the spec.
     */
    public static FtpInboundChannelAdapterSpec inboundAdapter(SessionFactory<FTPFile> sessionFactory,
            Comparator<File> receptionOrderComparator) {
        return new FtpInboundChannelAdapterSpec(sessionFactory, receptionOrderComparator);
    }

    /**
     * A {@link FtpStreamingInboundChannelAdapterSpec} factory for an inbound channel
     * adapter spec.
     * @param remoteFileTemplate the remote file template.
     * @return the spec.
     */
    public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(
            RemoteFileTemplate<FTPFile> remoteFileTemplate) {
        return inboundStreamingAdapter(remoteFileTemplate, null);
    }

    /**
     * A {@link FtpStreamingInboundChannelAdapterSpec} factory for an inbound channel
     * adapter spec.
     * @param remoteFileTemplate the remote file template.
     * @param receptionOrderComparator the comparator.
     * @return the spec.
     */
    public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(
            RemoteFileTemplate<FTPFile> remoteFileTemplate, Comparator<FTPFile> receptionOrderComparator) {
        return new FtpStreamingInboundChannelAdapterSpec(remoteFileTemplate, receptionOrderComparator);
    }

    /**
     * A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
     * @param sessionFactory the session factory.
     * @return the spec.
     */
    public static FtpMessageHandlerSpec outboundAdapter(SessionFactory<FTPFile> sessionFactory) {
        return new FtpMessageHandlerSpec(sessionFactory);
    }

    /**
     * A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
     * @param sessionFactory the session factory.
     * @param fileExistsMode the file exists mode.
     * @return the spec.
     */
    public static FtpMessageHandlerSpec outboundAdapter(SessionFactory<FTPFile> sessionFactory,
            FileExistsMode fileExistsMode) {
        return outboundAdapter(new FtpRemoteFileTemplate(sessionFactory), fileExistsMode);
    }

    /**
     * A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
     * @param remoteFileTemplate the remote file template.
     * @return the spec.
     */
    public static FtpMessageHandlerSpec outboundAdapter(RemoteFileTemplate<FTPFile> remoteFileTemplate) {
        return new FtpMessageHandlerSpec(remoteFileTemplate);
    }

    /**
     * A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
     * @param remoteFileTemplate the remote file template.
     * @param fileExistsMode the file exists mode.
     * @return the spec.
     */
    public static FtpMessageHandlerSpec outboundAdapter(RemoteFileTemplate<FTPFile> remoteFileTemplate,
            FileExistsMode fileExistsMode) {
        return new FtpMessageHandlerSpec(remoteFileTemplate, fileExistsMode);
    }

    /**
     * Produce a {@link FtpOutboundGatewaySpec} based on the {@link SessionFactory},
     * {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
     * remoteFilePath.
     * @param sessionFactory the {@link SessionFactory}.
     * @param command the command to perform on the FTP.
     * @param expression the remoteFilePath SpEL expression.
     * @return the {@link FtpOutboundGatewaySpec}
     */
    public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<FTPFile> sessionFactory,
            AbstractRemoteFileOutboundGateway.Command command, String expression) {
        return outboundGateway(sessionFactory, command.getCommand(), expression);
    }

    /**
     * Produce a {@link FtpOutboundGatewaySpec} based on the {@link SessionFactory},
     * {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
     * remoteFilePath.
     * @param sessionFactory the {@link SessionFactory}.
     * @param command the command to perform on the FTP.
     * @param expression the remoteFilePath SpEL expression.
     * @return the {@link FtpOutboundGatewaySpec}
     * @see RemoteFileTemplate
     */
    public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<FTPFile> sessionFactory, String command,
            String expression) {
        return new FtpOutboundGatewaySpec(new FtpOutboundGateway(sessionFactory, command, expression));
    }

    /**
     * Produce a {@link FtpOutboundGatewaySpec} based on the {@link RemoteFileTemplate},
     * {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
     * remoteFilePath.
     * @param remoteFileTemplate the {@link RemoteFileTemplate}.
     * @param command the command to perform on the FTP.
     * @param expression the remoteFilePath SpEL expression.
     * @return the {@link FtpOutboundGatewaySpec}
     * @see RemoteFileTemplate
     */
    public static FtpOutboundGatewaySpec outboundGateway(RemoteFileTemplate<FTPFile> remoteFileTemplate,
            AbstractRemoteFileOutboundGateway.Command command, String expression) {
        return outboundGateway(remoteFileTemplate, command.getCommand(), expression);
    }

    /**
     * Produce a {@link FtpOutboundGatewaySpec} based on the {@link RemoteFileTemplate},
     * {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
     * remoteFilePath.
     * @param remoteFileTemplate the {@link RemoteFileTemplate}.
     * @param command the command to perform on the FTP.
     * @param expression the remoteFilePath SpEL expression.
     * @return the {@link FtpOutboundGatewaySpec}
     * @see RemoteFileTemplate
     */
    public static FtpOutboundGatewaySpec outboundGateway(RemoteFileTemplate<FTPFile> remoteFileTemplate,
            String command, String expression) {
        return new FtpOutboundGatewaySpec(new FtpOutboundGateway(remoteFileTemplate, command, expression));
    }

    /**
     * Produce a {@link FtpOutboundGatewaySpec} based on the
     * {@link MessageSessionCallback}.
     * @param sessionFactory the {@link SessionFactory} to connect to.
     * @param messageSessionCallback the {@link MessageSessionCallback} to perform SFTP
     * operation(s) with the {@code Message} context.
     * @return the {@link FtpOutboundGatewaySpec}
     * @see MessageSessionCallback
     */
    public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<FTPFile> sessionFactory,
            MessageSessionCallback<FTPFile, ?> messageSessionCallback) {
        return new FtpOutboundGatewaySpec(new FtpOutboundGateway(sessionFactory, messageSessionCallback));
    }

    private Ftp() {
        super();
    }

}