org.apache.sshd.client

Class ClientBuilder

java.lang.Object

org.apache.sshd.common.BaseBuilder<SshClient,ClientBuilder>

org.apache.sshd.client.ClientBuilder

All Implemented Interfaces:

Supplier<SshClient>, ObjectBuilder<SshClient>

public class ClientBuilder
extends BaseBuilder<SshClient,ClientBuilder>

SshClient builder

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientIdentityLoader	clientIdentityLoader
static List<ChannelFactory>	DEFAULT_CHANNEL_FACTORIES
static ClientIdentityLoader	DEFAULT_CLIENT_IDENTITY_LOADER
static List<CompressionFactory>	DEFAULT_COMPRESSION_FACTORIES
static FilePasswordProvider	DEFAULT_FILE_PASSWORD_PROVIDER
static List<RequestHandler<ConnectionService>>	DEFAULT_GLOBAL_REQUEST_HANDLERS
static HostConfigEntryResolver	DEFAULT_HOST_CONFIG_ENTRY_RESOLVER
static KexExtensionHandler	DEFAULT_KEX_EXTENSION_HANDLER
static ServerKeyVerifier	DEFAULT_SERVER_KEY_VERIFIER
static Function<DHFactory,KeyExchangeFactory>	DH2KEX
protected FilePasswordProvider	filePasswordProvider
protected HostConfigEntryResolver	hostConfigEntryResolver
protected KexExtensionHandler	kexExtensionHandler
protected ServerKeyVerifier	serverKeyVerifier

Fields inherited from class org.apache.sshd.common.BaseBuilder

channelFactories, channelStreamPacketWriterResolver, cipherFactories, compressionFactories, DEFAULT_CIPHERS_PREFERENCE, DEFAULT_FILE_SYSTEM_FACTORY, DEFAULT_FORWARDER_FACTORY, DEFAULT_FORWARDING_FILTER, DEFAULT_KEX_PREFERENCE, DEFAULT_MAC_PREFERENCE, DEFAULT_SIGNATURE_PREFERENCE, DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER, factory, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, keyExchangeFactories, macFactories, randomFactory, signatureFactories, unknownChannelReferenceHandler

Constructor Summary

Constructors

Constructor and Description
ClientBuilder()

Method Summary

Modifier and Type	Method and Description
SshClient	build(boolean isFillWithDefaultValues)
static ClientBuilder	builder()
ClientBuilder	clientIdentityLoader(ClientIdentityLoader loader)
ClientBuilder	filePasswordProvider(FilePasswordProvider provider)
protected ClientBuilder	fillWithDefaultValues()
ClientBuilder	hostConfigEntryResolver(HostConfigEntryResolver resolver)
ClientBuilder	kexExtensionHandler(KexExtensionHandler kexExtensionHandler)
ClientBuilder	serverKeyVerifier(ServerKeyVerifier serverKeyVerifier)
static List<NamedFactory<Compression>>	setUpDefaultCompressionFactories(boolean ignoreUnsupported)
static List<KeyExchangeFactory>	setUpDefaultKeyExchanges(boolean ignoreUnsupported)
static List<NamedFactory<Signature>>	setUpDefaultSignatureFactories(boolean ignoreUnsupported)

Methods inherited from class org.apache.sshd.common.BaseBuilder

build, channelFactories, channelStreamPacketWriterResolver, cipherFactories, compressionFactories, factory, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, keyExchangeFactories, macFactories, me, randomFactory, setUpDefaultCiphers, setUpDefaultMacs, signatureFactories, unknownChannelReferenceHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.util.ObjectBuilder

get

Field Detail

DH2KEX

public static final Function<DHFactory,KeyExchangeFactory> DH2KEX

DEFAULT_COMPRESSION_FACTORIES

public static final List<CompressionFactory> DEFAULT_COMPRESSION_FACTORIES

DEFAULT_CHANNEL_FACTORIES

public static final List<ChannelFactory> DEFAULT_CHANNEL_FACTORIES

DEFAULT_GLOBAL_REQUEST_HANDLERS

public static final List<RequestHandler<ConnectionService>> DEFAULT_GLOBAL_REQUEST_HANDLERS

DEFAULT_SERVER_KEY_VERIFIER

public static final ServerKeyVerifier DEFAULT_SERVER_KEY_VERIFIER

DEFAULT_HOST_CONFIG_ENTRY_RESOLVER

public static final HostConfigEntryResolver DEFAULT_HOST_CONFIG_ENTRY_RESOLVER

DEFAULT_CLIENT_IDENTITY_LOADER

public static final ClientIdentityLoader DEFAULT_CLIENT_IDENTITY_LOADER

DEFAULT_FILE_PASSWORD_PROVIDER

public static final FilePasswordProvider DEFAULT_FILE_PASSWORD_PROVIDER

DEFAULT_KEX_EXTENSION_HANDLER

public static final KexExtensionHandler DEFAULT_KEX_EXTENSION_HANDLER

serverKeyVerifier

protected ServerKeyVerifier serverKeyVerifier

hostConfigEntryResolver

protected HostConfigEntryResolver hostConfigEntryResolver

clientIdentityLoader

protected ClientIdentityLoader clientIdentityLoader

filePasswordProvider

protected FilePasswordProvider filePasswordProvider

kexExtensionHandler

protected KexExtensionHandler kexExtensionHandler

Constructor Detail

ClientBuilder

public ClientBuilder()

Method Detail

kexExtensionHandler

public ClientBuilder kexExtensionHandler(KexExtensionHandler kexExtensionHandler)

serverKeyVerifier

public ClientBuilder serverKeyVerifier(ServerKeyVerifier serverKeyVerifier)

hostConfigEntryResolver

public ClientBuilder hostConfigEntryResolver(HostConfigEntryResolver resolver)

clientIdentityLoader

public ClientBuilder clientIdentityLoader(ClientIdentityLoader loader)

filePasswordProvider

public ClientBuilder filePasswordProvider(FilePasswordProvider provider)

fillWithDefaultValues

protected ClientBuilder fillWithDefaultValues()

Overrides:

fillWithDefaultValues in class BaseBuilder<SshClient,ClientBuilder>

build

public SshClient build(boolean isFillWithDefaultValues)

Overrides:

build in class BaseBuilder<SshClient,ClientBuilder>

setUpDefaultSignatureFactories

public static List<NamedFactory<Signature>> setUpDefaultSignatureFactories(boolean ignoreUnsupported)

setUpDefaultCompressionFactories

public static List<NamedFactory<Compression>> setUpDefaultCompressionFactories(boolean ignoreUnsupported)

setUpDefaultKeyExchanges

public static List<KeyExchangeFactory> setUpDefaultKeyExchanges(boolean ignoreUnsupported)

Parameters:

ignoreUnsupported - If true then all the default key exchanges are included, regardless of whether they are currently supported by the JCE. Otherwise, only the supported ones out of the list are included

Returns:

A List of the default NamedFactory instances of the KeyExchanges according to the preference order defined by BaseBuilder.DEFAULT_KEX_PREFERENCE. Note: the list may be filtered to exclude unsupported JCE key exchanges according to the ignoreUnsupported parameter

See Also:

BuiltinDHFactories.isSupported()

builder

public static ClientBuilder builder()