org.apache.sshd.sftp.client.SftpClientFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-sftp Show documentation
There is a newer version: 2.14.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.sshd.sftp.client;

import java.io.IOException;

import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.sftp.client.fs.SftpFileSystem;
import org.apache.sshd.sftp.client.impl.DefaultSftpClientFactory;

/**
 * TODO Add javadoc
 *
 * @author Apache MINA SSHD Project
 */
public interface SftpClientFactory {

    static SftpClientFactory instance() {
        return DefaultSftpClientFactory.INSTANCE;
    }

    /**
     * Create an SFTP client from this session.
     *
     * @param  session     The {@link ClientSession} to be used for creating the SFTP client
     * @return             The created {@link SftpClient}
     * @throws IOException if failed to create the client
     */
    default SftpClient createSftpClient(ClientSession session) throws IOException {
        return createSftpClient(session, SftpVersionSelector.CURRENT);
    }

    /**
     * Creates an SFTP client using the specified version
     *
     * @param  session     The {@link ClientSession} to be used for creating the SFTP client
     * @param  version     The version to use - Note: if the specified version is not supported by the server
     *                     then an exception will occur
     * @return             The created {@link SftpClient}
     * @throws IOException If failed to create the client or use the specified version
     */
    default SftpClient createSftpClient(ClientSession session, int version) throws IOException {
        return createSftpClient(session, SftpVersionSelector.fixedVersionSelector(version));
    }

    /**
     * @param  session     The {@link ClientSession} to which the SFTP client should be attached
     * @param  selector    The {@link SftpVersionSelector} to use in order to negotiate the SFTP version
     * @return             The created {@link SftpClient} instance
     * @throws IOException If failed to create the client
     */
    default SftpClient createSftpClient(ClientSession session, SftpVersionSelector selector) throws IOException {
        return createSftpClient(session, selector, SftpErrorDataHandler.EMPTY);
    }

    /**
     * Create an SFTP client from this session.
     *
     * @param  session          The {@link ClientSession} to be used for creating the SFTP client
     * @param  errorDataHandler The {@link SftpErrorDataHandler} to handle incoming data through the error stream - if
     *                          {@code null} the data is silently ignored
     * @return                  The created {@link SftpClient}
     * @throws IOException      if failed to create the client
     */
    default SftpClient createSftpClient(ClientSession session, SftpErrorDataHandler errorDataHandler) throws IOException {
        return createSftpClient(session, SftpVersionSelector.CURRENT, errorDataHandler);
    }

    /**
     * @param  session          The {@link ClientSession} to which the SFTP client should be attached
     * @param  selector         The {@link SftpVersionSelector} to use in order to negotiate the SFTP version
     * @param  errorDataHandler The {@link SftpErrorDataHandler} to handle incoming data through the error stream - if
     *                          {@code null} the data is silently ignored
     * @return                  The created {@link SftpClient} instance
     * @throws IOException      If failed to create the client
     */
    SftpClient createSftpClient(
            ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
            throws IOException;

    default SftpFileSystem createSftpFileSystem(ClientSession session) throws IOException {
        return createSftpFileSystem(session, SftpVersionSelector.CURRENT);
    }

    default SftpFileSystem createSftpFileSystem(ClientSession session, int version) throws IOException {
        return createSftpFileSystem(session, SftpVersionSelector.fixedVersionSelector(version));
    }

    default SftpFileSystem createSftpFileSystem(ClientSession session, SftpVersionSelector selector) throws IOException {
        return createSftpFileSystem(session, selector, 0, 0);
    }

    default SftpFileSystem createSftpFileSystem(ClientSession session, int version, int readBufferSize, int writeBufferSize)
            throws IOException {
        return createSftpFileSystem(session, SftpVersionSelector.fixedVersionSelector(version), readBufferSize,
                writeBufferSize);
    }

    default SftpFileSystem createSftpFileSystem(ClientSession session, int readBufferSize, int writeBufferSize)
            throws IOException {
        return createSftpFileSystem(session, SftpVersionSelector.CURRENT, readBufferSize, writeBufferSize);
    }

    default SftpFileSystem createSftpFileSystem(
            ClientSession session, SftpVersionSelector selector, int readBufferSize, int writeBufferSize)
            throws IOException {
        return createSftpFileSystem(session, selector, SftpErrorDataHandler.EMPTY, readBufferSize, writeBufferSize);
    }

    /**
     * @param  session          The {@link ClientSession} to which the SFTP client backing the file system should be
     *                          attached
     * @param  selector         The {@link SftpVersionSelector} to use in order to negotiate the SFTP version
     * @param  errorDataHandler The {@link SftpErrorDataHandler} to handle incoming data through the error stream - if
     *                          {@code null} the data is silently ignored
     * @param  readBufferSize   Default I/O read buffer size
     * @param  writeBufferSize  Default I/O write buffer size
     * @return                  The created {@link SftpFileSystem} instance
     * @throws IOException      If failed to create the instance
     */
    SftpFileSystem createSftpFileSystem(
            ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler,
            int readBufferSize, int writeBufferSize)
            throws IOException;
}