Top Description Fields Constructors Methods
org.apache.sshd.client

public Class ClientBuilder

extends BaseBuilder<SshClient, ClientBuilder>
Class Inheritance
Imports
java.util.Arrays, .Collections, .List, java.util.function.Function, org.apache.sshd.client.config.hosts.DefaultConfigFileHostEntryResolver, .HostConfigEntryResolver, org.apache.sshd.client.config.keys.ClientIdentityLoader, org.apache.sshd.client.global.OpenSshHostKeysHandler, org.apache.sshd.client.kex.DHGClient, .DHGEXClient, org.apache.sshd.client.keyverifier.AcceptAllServerKeyVerifier, .ServerKeyVerifier, org.apache.sshd.common.BaseBuilder, .NamedFactory, org.apache.sshd.common.channel.ChannelFactory, .RequestHandler, org.apache.sshd.common.compression.BuiltinCompressions, .Compression, .CompressionFactory, org.apache.sshd.common.config.keys.FilePasswordProvider, org.apache.sshd.common.global.KeepAliveHandler, org.apache.sshd.common.kex.DHFactory, .KeyExchange, .KeyExchangeFactory, org.apache.sshd.common.kex.extension.DefaultClientKexExtensionHandler, .KexExtensionHandler, org.apache.sshd.common.session.ConnectionService, org.apache.sshd.common.signature.Signature, org.apache.sshd.server.forward.ForwardedTcpipFactory
SshClient builder

Field Summary

Modifier and TypeField and Description
protected ClientIdentityLoader
clientIdentityLoader

public static final List<ChannelFactory>
DEFAULT_CHANNEL_FACTORIES

public static final ClientIdentityLoader
DEFAULT_CLIENT_IDENTITY_LOADER

public static final List<CompressionFactory>
DEFAULT_COMPRESSION_FACTORIES

public static final FilePasswordProvider
DEFAULT_FILE_PASSWORD_PROVIDER

public static final List<RequestHandler<ConnectionService>>
DEFAULT_GLOBAL_REQUEST_HANDLERS

public static final HostConfigEntryResolver
DEFAULT_HOST_CONFIG_ENTRY_RESOLVER

public static final KexExtensionHandler
DEFAULT_KEX_EXTENSION_HANDLER

public static final ServerKeyVerifier
DEFAULT_SERVER_KEY_VERIFIER

public static final Function<DHFactory, KeyExchangeFactory>
DH2KEX

protected FilePasswordProvider
filePasswordProvider

protected HostConfigEntryResolver
hostConfigEntryResolver

protected ServerKeyVerifier
serverKeyVerifier

Inherited from org.apache.sshd.common.BaseBuilder:
channelFactorieschannelStreamPacketWriterResolvercipherFactoriescompressionFactoriesDEFAULT_CIPHERS_PREFERENCEDEFAULT_FILE_SYSTEM_FACTORYDEFAULT_FORWARDER_FACTORYDEFAULT_FORWARDING_FILTERDEFAULT_KEX_PREFERENCEDEFAULT_MAC_PREFERENCEDEFAULT_SIGNATURE_PREFERENCEDEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLERfactoryfileSystemFactoryforwarderFactoryforwardingFilterglobalRequestHandlerskexExtensionHandlerkeyExchangeFactoriesmacFactoriesrandomFactorysignatureFactoriesunknownChannelReferenceHandler

Constructor Summary

AccessConstructor and Description
public
ClientBuilder()

Method Summary

Modifier and TypeMethod and Description
public SshClient
build(boolean isFillWithDefaultValues)

Overrides org.apache.sshd.common.BaseBuilder.build.

public static ClientBuilder
builder()

public ClientBuilder
clientIdentityLoader(ClientIdentityLoader loader)

public ClientBuilder
filePasswordProvider(FilePasswordProvider provider)

protected ClientBuilder
fillWithDefaultValues()

Overrides org.apache.sshd.common.BaseBuilder.fillWithDefaultValues.

public ClientBuilder
hostConfigEntryResolver(HostConfigEntryResolver resolver)

public ClientBuilder
serverKeyVerifier(ServerKeyVerifier serverKeyVerifier)

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

public static List<KeyExchangeFactory>

Returns:

A List of the default NamedFactory instances of the KeyExchanges according to the preference order defined by DEFAULT_KEX_PREFERENCE

Note

the list may be filtered to exclude unsupported JCE key exchanges according to the ignoreUnsupported parameter

setUpDefaultKeyExchanges(boolean
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
ignoreUnsupported)

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

Inherited from org.apache.sshd.common.BaseBuilder:
buildchannelFactorieschannelStreamPacketWriterResolvercipherFactoriescompressionFactoriesfactoryfileSystemFactoryforwarderFactoryforwardingFilterglobalRequestHandlerskexExtensionHandlerkeyExchangeFactoriesmacFactoriesmerandomFactorysetUpDefaultCipherssetUpDefaultMacssignatureFactoriesunknownChannelReferenceHandler

Field Detail

clientIdentityLoaderback to summary
protected ClientIdentityLoader clientIdentityLoader
DEFAULT_CHANNEL_FACTORIESback to summary
public static final List<ChannelFactory> DEFAULT_CHANNEL_FACTORIES
DEFAULT_CLIENT_IDENTITY_LOADERback to summary
public static final ClientIdentityLoader DEFAULT_CLIENT_IDENTITY_LOADER
DEFAULT_COMPRESSION_FACTORIESback to summary
public static final List<CompressionFactory> DEFAULT_COMPRESSION_FACTORIES
DEFAULT_FILE_PASSWORD_PROVIDERback to summary
public static final FilePasswordProvider DEFAULT_FILE_PASSWORD_PROVIDER
DEFAULT_GLOBAL_REQUEST_HANDLERSback to summary
public static final List<RequestHandler<ConnectionService>> DEFAULT_GLOBAL_REQUEST_HANDLERS
DEFAULT_HOST_CONFIG_ENTRY_RESOLVERback to summary
public static final HostConfigEntryResolver DEFAULT_HOST_CONFIG_ENTRY_RESOLVER
DEFAULT_KEX_EXTENSION_HANDLERback to summary
public static final KexExtensionHandler DEFAULT_KEX_EXTENSION_HANDLER
DEFAULT_SERVER_KEY_VERIFIERback to summary
public static final ServerKeyVerifier DEFAULT_SERVER_KEY_VERIFIER
DH2KEXback to summary
public static final Function<DHFactory, KeyExchangeFactory> DH2KEX
Annotations
@SuppressWarnings:checkstyle:Indentation
filePasswordProviderback to summary
protected FilePasswordProvider filePasswordProvider
hostConfigEntryResolverback to summary
protected HostConfigEntryResolver hostConfigEntryResolver
serverKeyVerifierback to summary
protected ServerKeyVerifier serverKeyVerifier

Constructor Detail

ClientBuilderback to summary
public ClientBuilder()

Method Detail

buildback to summary
public SshClient build(boolean isFillWithDefaultValues)

Overrides org.apache.sshd.common.BaseBuilder.build.

Annotations
@Override
builderback to summary
public static ClientBuilder builder()
clientIdentityLoaderback to summary
public ClientBuilder clientIdentityLoader(ClientIdentityLoader loader)
filePasswordProviderback to summary
public ClientBuilder filePasswordProvider(FilePasswordProvider provider)
fillWithDefaultValuesback to summary
protected ClientBuilder fillWithDefaultValues()

Overrides org.apache.sshd.common.BaseBuilder.fillWithDefaultValues.

Annotations
@Override
hostConfigEntryResolverback to summary
public ClientBuilder hostConfigEntryResolver(HostConfigEntryResolver resolver)
serverKeyVerifierback to summary
public ClientBuilder serverKeyVerifier(ServerKeyVerifier serverKeyVerifier)
setUpDefaultCompressionFactoriesback to summary
public static List<NamedFactory<Compression>> setUpDefaultCompressionFactories(boolean ignoreUnsupported)
Annotations
@SuppressWarnings:unchecked, rawtypes
setUpDefaultKeyExchangesback to summary
public static List<KeyExchangeFactory> setUpDefaultKeyExchanges(boolean ignoreUnsupported)
Parameters
ignoreUnsupported:boolean

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:List<KeyExchangeFactory>

A List of the default NamedFactory instances of the KeyExchanges according to the preference order defined by DEFAULT_KEX_PREFERENCE

Note

the list may be filtered to exclude unsupported JCE key exchanges according to the ignoreUnsupported parameter

See Also
org.apache.sshd.common.kex.BuiltinDHFactories#isSupported()
setUpDefaultSignatureFactoriesback to summary
public static List<NamedFactory<Signature>> setUpDefaultSignatureFactories(boolean ignoreUnsupported)
Annotations
@SuppressWarnings:unchecked, rawtypes