org.apache.sshd.common

Class BaseBuilder<T extends AbstractFactoryManager,S extends BaseBuilder<T,S>>

java.lang.Object

org.apache.sshd.common.BaseBuilder<T,S>

Type Parameters:

T - Type of AbstractFactoryManager being built

S - Type of builder

All Implemented Interfaces:

java.util.function.Supplier<T>, ObjectBuilder<T>

Direct Known Subclasses:

ClientBuilder, ServerBuilder

public class BaseBuilder<T extends AbstractFactoryManager,S extends BaseBuilder<T,S>>
extends java.lang.Object
implements ObjectBuilder<T>

Base class for dedicated client/server instance builders

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<NamedFactory<Channel>>	channelFactories
protected ChannelStreamPacketWriterResolver	channelStreamPacketWriterResolver
protected java.util.List<NamedFactory<Cipher>>	cipherFactories
protected java.util.List<NamedFactory<Compression>>	compressionFactories
static java.util.List<BuiltinCiphers>	DEFAULT_CIPHERS_PREFERENCE The default BuiltinCiphers setup in order of preference as specified by ssh_config(5)
static FileSystemFactory	DEFAULT_FILE_SYSTEM_FACTORY
static ForwardingFilterFactory	DEFAULT_FORWARDER_FACTORY
static ForwardingFilter	DEFAULT_FORWARDING_FILTER
static java.util.List<BuiltinDHFactories>	DEFAULT_KEX_PREFERENCE The default BuiltinDHFactories setup in order of preference as specified by ssh_config(5)
static java.util.List<BuiltinMacs>	DEFAULT_MAC_PREFERENCE The default BuiltinMacs setup in order of preference as specified by ssh_config(5)
static java.util.List<BuiltinSignatures>	DEFAULT_SIGNATURE_PREFERENCE Preferred BuiltinSignatures according to sshd_config(5) HostKeyAlgorithms recommendation
static UnknownChannelReferenceHandler	DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER
protected Factory<T>	factory
protected FileSystemFactory	fileSystemFactory
protected ForwardingFilterFactory	forwarderFactory
protected ForwardingFilter	forwardingFilter
protected java.util.List<RequestHandler<ConnectionService>>	globalRequestHandlers
protected java.util.List<NamedFactory<KeyExchange>>	keyExchangeFactories
protected java.util.List<NamedFactory<Mac>>	macFactories
protected Factory<Random>	randomFactory
protected java.util.List<NamedFactory<Signature>>	signatureFactories
protected UnknownChannelReferenceHandler	unknownChannelReferenceHandler

Constructor Summary

Constructors

Constructor and Description
BaseBuilder()

Method Summary

Modifier and Type	Method and Description
T	build()
T	build(boolean isFillWithDefaultValues)
S	channelFactories(java.util.List<NamedFactory<Channel>> channelFactories)
S	channelStreamPacketWriterResolver(ChannelStreamPacketWriterResolver resolver)
S	cipherFactories(java.util.List<NamedFactory<Cipher>> cipherFactories)
S	compressionFactories(java.util.List<NamedFactory<Compression>> compressionFactories)
S	factory(Factory<T> factory)
S	fileSystemFactory(FileSystemFactory fileSystemFactory)
protected S	fillWithDefaultValues()
S	forwarderFactory(ForwardingFilterFactory forwarderFactory)
S	forwardingFilter(ForwardingFilter filter)
S	globalRequestHandlers(java.util.List<RequestHandler<ConnectionService>> globalRequestHandlers)
S	keyExchangeFactories(java.util.List<NamedFactory<KeyExchange>> keyExchangeFactories)
S	macFactories(java.util.List<NamedFactory<Mac>> macFactories)
protected S	me()
S	randomFactory(Factory<Random> randomFactory)
static java.util.List<NamedFactory<Cipher>>	setUpDefaultCiphers(boolean ignoreUnsupported)
static java.util.List<NamedFactory<Mac>>	setUpDefaultMacs(boolean ignoreUnsupported)
static java.util.List<NamedFactory<Signature>>	setUpDefaultSignatures(boolean ignoreUnsupported)
S	signatureFactories(java.util.List<NamedFactory<Signature>> signatureFactories)
S	unknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)

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

DEFAULT_FILE_SYSTEM_FACTORY

public static final FileSystemFactory DEFAULT_FILE_SYSTEM_FACTORY

DEFAULT_FORWARDING_FILTER

public static final ForwardingFilter DEFAULT_FORWARDING_FILTER

DEFAULT_FORWARDER_FACTORY

public static final ForwardingFilterFactory DEFAULT_FORWARDER_FACTORY

DEFAULT_CIPHERS_PREFERENCE

public static final java.util.List<BuiltinCiphers> DEFAULT_CIPHERS_PREFERENCE

The default BuiltinCiphers setup in order of preference as specified by ssh_config(5)

DEFAULT_KEX_PREFERENCE

public static final java.util.List<BuiltinDHFactories> DEFAULT_KEX_PREFERENCE

The default BuiltinDHFactories setup in order of preference as specified by ssh_config(5)

DEFAULT_MAC_PREFERENCE

public static final java.util.List<BuiltinMacs> DEFAULT_MAC_PREFERENCE

The default BuiltinMacs setup in order of preference as specified by ssh_config(5)

DEFAULT_SIGNATURE_PREFERENCE

public static final java.util.List<BuiltinSignatures> DEFAULT_SIGNATURE_PREFERENCE

Preferred BuiltinSignatures according to sshd_config(5) HostKeyAlgorithms recommendation

DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER

public static final UnknownChannelReferenceHandler DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER

factory

protected Factory<T extends AbstractFactoryManager> factory

keyExchangeFactories

protected java.util.List<NamedFactory<KeyExchange>> keyExchangeFactories

cipherFactories

protected java.util.List<NamedFactory<Cipher>> cipherFactories

compressionFactories

protected java.util.List<NamedFactory<Compression>> compressionFactories

macFactories

protected java.util.List<NamedFactory<Mac>> macFactories

signatureFactories

protected java.util.List<NamedFactory<Signature>> signatureFactories

randomFactory

protected Factory<Random> randomFactory

channelFactories

protected java.util.List<NamedFactory<Channel>> channelFactories

fileSystemFactory

protected FileSystemFactory fileSystemFactory

forwarderFactory

protected ForwardingFilterFactory forwarderFactory

globalRequestHandlers

protected java.util.List<RequestHandler<ConnectionService>> globalRequestHandlers

forwardingFilter

protected ForwardingFilter forwardingFilter

channelStreamPacketWriterResolver

protected ChannelStreamPacketWriterResolver channelStreamPacketWriterResolver

unknownChannelReferenceHandler

protected UnknownChannelReferenceHandler unknownChannelReferenceHandler

Constructor Detail

BaseBuilder

public BaseBuilder()

Method Detail

fillWithDefaultValues

protected S fillWithDefaultValues()

keyExchangeFactories

public S keyExchangeFactories(java.util.List<NamedFactory<KeyExchange>> keyExchangeFactories)

signatureFactories

public S signatureFactories(java.util.List<NamedFactory<Signature>> signatureFactories)

randomFactory

public S randomFactory(Factory<Random> randomFactory)

cipherFactories

public S cipherFactories(java.util.List<NamedFactory<Cipher>> cipherFactories)

compressionFactories

public S compressionFactories(java.util.List<NamedFactory<Compression>> compressionFactories)

macFactories

public S macFactories(java.util.List<NamedFactory<Mac>> macFactories)

channelFactories

public S channelFactories(java.util.List<NamedFactory<Channel>> channelFactories)

fileSystemFactory

public S fileSystemFactory(FileSystemFactory fileSystemFactory)

forwardingFilter

public S forwardingFilter(ForwardingFilter filter)

forwarderFactory

public S forwarderFactory(ForwardingFilterFactory forwarderFactory)

globalRequestHandlers

public S globalRequestHandlers(java.util.List<RequestHandler<ConnectionService>> globalRequestHandlers)

factory

public S factory(Factory<T> factory)

channelStreamPacketWriterResolver

public S channelStreamPacketWriterResolver(ChannelStreamPacketWriterResolver resolver)

unknownChannelReferenceHandler

public S unknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)

build

public T build(boolean isFillWithDefaultValues)

build

public T build()

Specified by:

build in interface ObjectBuilder<T extends AbstractFactoryManager>

me

protected S me()

setUpDefaultCiphers

public static java.util.List<NamedFactory<Cipher>> setUpDefaultCiphers(boolean ignoreUnsupported)

Parameters:

ignoreUnsupported - If true then all the default ciphers 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 Ciphers according to the preference order defined by DEFAULT_CIPHERS_PREFERENCE. Note: the list may be filtered to exclude unsupported JCE ciphers according to the ignoreUnsupported parameter

See Also:

BuiltinCiphers.isSupported()

setUpDefaultMacs

public static java.util.List<NamedFactory<Mac>> setUpDefaultMacs(boolean ignoreUnsupported)

Parameters:

ignoreUnsupported - If true all the available built-in Mac factories are added, otherwise only those that are supported by the current JDK setup

Returns:

A List of the default NamedFactory instances of the Macs according to the preference order defined by DEFAULT_MAC_PREFERENCE. Note: the list may be filtered to exclude unsupported JCE MACs according to the ignoreUnsupported parameter

See Also:

BuiltinMacs.isSupported()

setUpDefaultSignatures

public static java.util.List<NamedFactory<Signature>> setUpDefaultSignatures(boolean ignoreUnsupported)

Parameters:

ignoreUnsupported - If true all the available built-in Signature factories are added, otherwise only those that are supported by the current JDK setup

Returns:

A List of the default NamedFactory instances of the Signatures according to the preference order defined by DEFAULT_SIGNATURE_PREFERENCE. Note: the list may be filtered to exclude unsupported JCE signatures according to the ignoreUnsupported parameter

See Also:

BuiltinSignatures.isSupported()