BaseBuilder (Apache Mina SSHD

java.lang.Object
- org.apache.sshd.common.BaseBuilder<T,S>

All Implemented Interfaces:

ObjectBuilder<T>

Direct Known Subclasses:

ClientBuilder, ServerBuilder
```
public class BaseBuilder<T extends AbstractFactoryManager,S extends BaseBuilder<T,S>>
extends Object
implements ObjectBuilder<T>
```
Base class for dedicated client/server instance builders

Author:

Apache MINA SSHD Project

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

BaseBuilder()

Constructors
Constructor and Description
`BaseBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`build()`
`T`	`build(boolean isFillWithDefaultValues)`
`S`	`channelFactories(List<NamedFactory<Channel>> channelFactories)`
`S`	`cipherFactories(List<NamedFactory<Cipher>> cipherFactories)`
`S`	`compressionFactories(List<NamedFactory<Compression>> compressionFactories)`
`S`	`factory(Factory<T> factory)`
`S`	`fileSystemFactory(FileSystemFactory fileSystemFactory)`
`protected S`	`fillWithDefaultValues()`
`S`	`forwardingFilter(ForwardingFilter filter)`
`S`	`globalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)`
`S`	`keyExchangeFactories(List<NamedFactory<KeyExchange>> keyExchangeFactories)`
`S`	`macFactories(List<NamedFactory<Mac>> macFactories)`
`protected S`	`me()`
`S`	`randomFactory(Factory<Random> randomFactory)`
`static List<NamedFactory<Cipher>>`	`setUpDefaultCiphers(boolean ignoreUnsupported)`
`static List<NamedFactory<Mac>>`	`setUpDefaultMacs(boolean ignoreUnsupported)`
`static List<NamedFactory<Signature>>`	`setUpDefaultSignatures(boolean ignoreUnsupported)`
`S`	`signatureFactories(List<NamedFactory<Signature>> signatureFactories)`
`S`	`tcpipForwarderFactory(TcpipForwarderFactory tcpipForwarderFactory)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_COMPRESSION_FACTORIES
```
public static final List<NamedFactory<Compression>> DEFAULT_COMPRESSION_FACTORIES
```
  - 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 TcpipForwarderFactory DEFAULT_FORWARDER_FACTORY
```
  - DEFAULT_CIPHERS_PREFERENCE
```
public static final 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 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 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 List<BuiltinSignatures> DEFAULT_SIGNATURE_PREFERENCE
```
    Preferred BuiltinSignatures according to sshd_config(5) HostKeyAlgorithms recommendation
  - factory
```
protected Factory<T extends AbstractFactoryManager> factory
```
  - keyExchangeFactories
```
protected List<NamedFactory<KeyExchange>> keyExchangeFactories
```
  - cipherFactories
```
protected List<NamedFactory<Cipher>> cipherFactories
```
  - compressionFactories
```
protected List<NamedFactory<Compression>> compressionFactories
```
  - macFactories
```
protected List<NamedFactory<Mac>> macFactories
```
  - signatureFactories
```
protected List<NamedFactory<Signature>> signatureFactories
```
  - randomFactory
```
protected Factory<Random> randomFactory
```
  - channelFactories
```
protected List<NamedFactory<Channel>> channelFactories
```
  - fileSystemFactory
```
protected FileSystemFactory fileSystemFactory
```
  - tcpipForwarderFactory
```
protected TcpipForwarderFactory tcpipForwarderFactory
```
  - globalRequestHandlers
```
protected List<RequestHandler<ConnectionService>> globalRequestHandlers
```
  - forwardingFilter
```
protected ForwardingFilter forwardingFilter
```
- Constructor Detail
  - BaseBuilder
```
public BaseBuilder()
```
- Method Detail
  - fillWithDefaultValues
```
protected S fillWithDefaultValues()
```
  - keyExchangeFactories
```
public S keyExchangeFactories(List<NamedFactory<KeyExchange>> keyExchangeFactories)
```
  - signatureFactories
```
public S signatureFactories(List<NamedFactory<Signature>> signatureFactories)
```
  - randomFactory
```
public S randomFactory(Factory<Random> randomFactory)
```
  - cipherFactories
```
public S cipherFactories(List<NamedFactory<Cipher>> cipherFactories)
```
  - compressionFactories
```
public S compressionFactories(List<NamedFactory<Compression>> compressionFactories)
```
  - macFactories
```
public S macFactories(List<NamedFactory<Mac>> macFactories)
```
  - channelFactories
```
public S channelFactories(List<NamedFactory<Channel>> channelFactories)
```
  - fileSystemFactory
```
public S fileSystemFactory(FileSystemFactory fileSystemFactory)
```
  - forwardingFilter
```
public S forwardingFilter(ForwardingFilter filter)
```
  - tcpipForwarderFactory
```
public S tcpipForwarderFactory(TcpipForwarderFactory tcpipForwarderFactory)
```
  - globalRequestHandlers
```
public S globalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)
```
  - factory
```
public S factory(Factory<T> factory)
```
  - 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 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 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 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()

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COMPRESSION_FACTORIES

DEFAULT_FILE_SYSTEM_FACTORY

DEFAULT_FORWARDING_FILTER

DEFAULT_FORWARDER_FACTORY

DEFAULT_CIPHERS_PREFERENCE

DEFAULT_KEX_PREFERENCE

DEFAULT_MAC_PREFERENCE

DEFAULT_SIGNATURE_PREFERENCE

factory

keyExchangeFactories

cipherFactories

compressionFactories

macFactories

signatureFactories

randomFactory

channelFactories

fileSystemFactory

tcpipForwarderFactory

globalRequestHandlers

forwardingFilter

Constructor Detail

BaseBuilder

Method Detail

fillWithDefaultValues

keyExchangeFactories

signatureFactories

randomFactory

cipherFactories

compressionFactories

macFactories

channelFactories

fileSystemFactory

forwardingFilter

tcpipForwarderFactory

globalRequestHandlers

factory

build

build

me

setUpDefaultCiphers

setUpDefaultMacs

setUpDefaultSignatures