org.apache.sshd.sftp.client.SimpleSftpClient 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 java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.nio.channels.Channel;
import java.security.KeyPair;
import java.util.Objects;

import org.apache.sshd.client.simple.SimpleClientConfigurator;
import org.apache.sshd.common.util.ValidateUtils;

/**
 * A simplified synchronous API for obtaining SFTP sessions.
 *
 * @author Apache MINA SSHD Project
 */
public interface SimpleSftpClient extends Channel {
    /**
     * Creates an SFTP session on the default port and logs in using the provided credentials
     *
     * @param  host        The target host name or address
     * @param  username    Username
     * @param  password    Password
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(String host, String username, String password) throws IOException {
        return sftpLogin(host, SimpleClientConfigurator.DEFAULT_PORT, username, password);
    }

    /**
     * Creates an SFTP session using the provided credentials
     *
     * @param  host        The target host name or address
     * @param  port        The target port
     * @param  username    Username
     * @param  password    Password
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(String host, int port, String username, String password) throws IOException {
        return sftpLogin(InetAddress.getByName(ValidateUtils.checkNotNullAndNotEmpty(host, "No host")), port, username,
                password);
    }

    /**
     * Creates an SFTP session on the default port and logs in using the provided credentials
     *
     * @param  host        The target host name or address
     * @param  username    Username
     * @param  identity    The {@link KeyPair} identity
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(String host, String username, KeyPair identity) throws IOException {
        return sftpLogin(host, SimpleClientConfigurator.DEFAULT_PORT, username, identity);
    }

    /**
     * Creates an SFTP session using the provided credentials
     *
     * @param  host        The target host name or address
     * @param  port        The target port
     * @param  username    Username
     * @param  identity    The {@link KeyPair} identity
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(String host, int port, String username, KeyPair identity) throws IOException {
        return sftpLogin(InetAddress.getByName(ValidateUtils.checkNotNullAndNotEmpty(host, "No host")), port, username,
                identity);
    }

    /**
     * Creates an SFTP session on the default port and logs in using the provided credentials
     *
     * @param  host        The target host {@link InetAddress}
     * @param  username    Username
     * @param  password    Password
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(InetAddress host, String username, String password) throws IOException {
        return sftpLogin(host, SimpleClientConfigurator.DEFAULT_PORT, username, password);
    }

    /**
     * Creates an SFTP session using the provided credentials
     *
     * @param  host        The target host {@link InetAddress}
     * @param  port        The target port
     * @param  username    Username
     * @param  password    Password
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(InetAddress host, int port, String username, String password) throws IOException {
        return sftpLogin(new InetSocketAddress(Objects.requireNonNull(host, "No host address"), port), username, password);
    }

    /**
     * Creates an SFTP session on the default port and logs in using the provided credentials
     *
     * @param  host        The target host {@link InetAddress}
     * @param  username    Username
     * @param  identity    The {@link KeyPair} identity
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(InetAddress host, String username, KeyPair identity) throws IOException {
        return sftpLogin(host, SimpleClientConfigurator.DEFAULT_PORT, username, identity);
    }

    /**
     * Creates an SFTP session using the provided credentials
     *
     * @param  host        The target host {@link InetAddress}
     * @param  port        The target port
     * @param  username    Username
     * @param  identity    The {@link KeyPair} identity
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    default SftpClient sftpLogin(InetAddress host, int port, String username, KeyPair identity) throws IOException {
        return sftpLogin(new InetSocketAddress(Objects.requireNonNull(host, "No host address"), port), username, identity);
    }

    /**
     * Creates an SFTP session using the provided credentials
     *
     * @param  target      The target {@link SocketAddress}
     * @param  username    Username
     * @param  password    Password
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    SftpClient sftpLogin(SocketAddress target, String username, String password) throws IOException;

    /**
     * Creates an SFTP session using the provided credentials
     *
     * @param  target      The target {@link SocketAddress}
     * @param  username    Username
     * @param  identity    The {@link KeyPair} identity
     * @return             Created {@link SftpClient} - Note: closing the client also closes its underlying
     *                     session
     * @throws IOException If failed to login or authenticate
     */
    SftpClient sftpLogin(SocketAddress target, String username, KeyPair identity) throws IOException;

}