Apache Mina SSHD 2.15.0 · org.apache.sshd.common.BaseBuilder

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

Access	Constructor and Description
public	BaseBuilder()

Method Summary

Modifier and Type	Method and Description
public T	build(boolean isFillWithDefaultValues)
public T	build() Implements org.apache.sshd.common.util.ObjectBuilder.build.
public S	channelFactories(List<ChannelFactory> channelFactories)
public S	channelStreamPacketWriterResolver(ChannelStreamWriterResolver resolver)
public S	cipherFactories(List<NamedFactory<Cipher>> cipherFactories)
public S	compressionFactories(List<NamedFactory<Compression>> compressionFactories)
public S	factory(Factory<T> factory)
public S	fileSystemFactory(FileSystemFactory fileSystemFactory)
protected S	fillWithDefaultValues()
public S	forwarderFactory(ForwarderFactory forwarderFactory)
public S	forwardingFilter(ForwardingFilter filter)
public S	globalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)
public S	kexExtensionHandler(KexExtensionHandler kexExtensionHandler)
public S	keyExchangeFactories(List<KeyExchangeFactory> keyExchangeFactories)
public S	macFactories(List<NamedFactory<Mac>> macFactories)
protected S	me()
public S	randomFactory(Factory<Random> randomFactory)
public static List<NamedFactory<Cipher>>	Returns: A `List` of the default `NamedFactory` instances of the `Cipher`s 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 setUpDefaultCiphers(boolean 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 ignoreUnsupported)
public static List<NamedFactory<Mac>>	Returns: A `List` of the default `NamedFactory` instances of the `Mac`s 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 setUpDefaultMacs(boolean If `true` all the available built-in `Mac` factories are added, otherwise only those that are supported by the current JDK setup ignoreUnsupported)
public S	signatureFactories(List<NamedFactory<Signature>> signatureFactories)
public S	unknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

channelFactories	back to summary
protected List<ChannelFactory> channelFactories

channelStreamPacketWriterResolver	back to summary
protected ChannelStreamWriterResolver channelStreamPacketWriterResolver

cipherFactories	back to summary
protected List<NamedFactory<Cipher>> cipherFactories

compressionFactories	back to summary
protected List<NamedFactory<Compression>> compressionFactories

DEFAULT_CIPHERS_PREFERENCE	back to summary
public static final List<BuiltinCiphers> DEFAULT_CIPHERS_PREFERENCE The default `BuiltinCiphers` setup in order of preference as specified by ssh_config(5)

DEFAULT_FILE_SYSTEM_FACTORY	back to summary
public static final FileSystemFactory DEFAULT_FILE_SYSTEM_FACTORY

DEFAULT_FORWARDER_FACTORY	back to summary
public static final ForwarderFactory DEFAULT_FORWARDER_FACTORY

DEFAULT_FORWARDING_FILTER	back to summary
public static final ForwardingFilter DEFAULT_FORWARDING_FILTER

DEFAULT_KEX_PREFERENCE	back to summary
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	back to summary
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	back to summary
public static final List<BuiltinSignatures> DEFAULT_SIGNATURE_PREFERENCE Preferred `BuiltinSignatures` according to sshd_config(5) - HostKeyAlgorithms `HostKeyAlgorithms` recommendation

DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER	back to summary
public static final UnknownChannelReferenceHandler DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER

factory	back to summary
protected Factory<T> factory

fileSystemFactory	back to summary
protected FileSystemFactory fileSystemFactory

forwarderFactory	back to summary
protected ForwarderFactory forwarderFactory

forwardingFilter	back to summary
protected ForwardingFilter forwardingFilter

globalRequestHandlers	back to summary
protected List<RequestHandler<ConnectionService>> globalRequestHandlers

kexExtensionHandler	back to summary
protected KexExtensionHandler kexExtensionHandler

keyExchangeFactories	back to summary
protected List<KeyExchangeFactory> keyExchangeFactories

macFactories	back to summary
protected List<NamedFactory<Mac>> macFactories

randomFactory	back to summary
protected Factory<Random> randomFactory

signatureFactories	back to summary
protected List<NamedFactory<Signature>> signatureFactories

unknownChannelReferenceHandler	back to summary
protected UnknownChannelReferenceHandler unknownChannelReferenceHandler

Constructor Detail

BaseBuilder	back to summary
public BaseBuilder()

Method Detail

build	back to summary
public T build(boolean isFillWithDefaultValues)

build	back to summary
public T build() Implements org.apache.sshd.common.util.ObjectBuilder.build. Annotations @Override

build

back to summary

public T build()

Implements org.apache.sshd.common.util.ObjectBuilder.build.

Annotations

@Override

channelFactories	back to summary
public S channelFactories(List<ChannelFactory> channelFactories)

channelStreamPacketWriterResolver	back to summary
public S channelStreamPacketWriterResolver(ChannelStreamWriterResolver resolver)

cipherFactories	back to summary
public S cipherFactories(List<NamedFactory<Cipher>> cipherFactories)

compressionFactories	back to summary
public S compressionFactories(List<NamedFactory<Compression>> compressionFactories)

factory	back to summary
public S factory(Factory<T> factory)

fileSystemFactory	back to summary
public S fileSystemFactory(FileSystemFactory fileSystemFactory)

fillWithDefaultValues	back to summary
protected S fillWithDefaultValues()

forwarderFactory	back to summary
public S forwarderFactory(ForwarderFactory forwarderFactory)

forwardingFilter	back to summary
public S forwardingFilter(ForwardingFilter filter)

globalRequestHandlers	back to summary
public S globalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)

kexExtensionHandler	back to summary
public S kexExtensionHandler(KexExtensionHandler kexExtensionHandler)

keyExchangeFactories	back to summary
public S keyExchangeFactories(List<KeyExchangeFactory> keyExchangeFactories)

macFactories	back to summary
public S macFactories(List<NamedFactory<Mac>> macFactories)

me	back to summary
protected S me() Annotations @SuppressWarnings:unchecked

randomFactory	back to summary
public S randomFactory(Factory<Random> randomFactory)

setUpDefaultCiphers back to summary

setUpDefaultCiphers	back to summary
public static List<NamedFactory<Cipher>> setUpDefaultCiphers(boolean ignoreUnsupported) Parameters ignoreUnsupported:boolean 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:List<NamedFactory<Cipher>> A `List` of the default `NamedFactory` instances of the `Cipher`s 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 Annotations @SuppressWarnings:unchecked, rawtypes See Also `BuiltinCiphers#isSupported()`

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

Parameters

ignoreUnsupported:boolean: 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:List<NamedFactory<Cipher>>

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

Annotations

@SuppressWarnings:unchecked, rawtypes

See Also

BuiltinCiphers#isSupported()

setUpDefaultMacs back to summary

setUpDefaultMacs	back to summary
public static List<NamedFactory<Mac>> setUpDefaultMacs(boolean ignoreUnsupported) Parameters ignoreUnsupported:boolean If `true` all the available built-in `Mac` factories are added, otherwise only those that are supported by the current JDK setup Returns:List<NamedFactory<Mac>> A `List` of the default `NamedFactory` instances of the `Mac`s 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 Annotations @SuppressWarnings:unchecked, rawtypes See Also `BuiltinMacs#isSupported()`

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

Parameters

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

Returns:List<NamedFactory<Mac>>

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

Annotations

@SuppressWarnings:unchecked, rawtypes

See Also

BuiltinMacs#isSupported()

signatureFactories	back to summary
public S signatureFactories(List<NamedFactory<Signature>> signatureFactories)

unknownChannelReferenceHandler	back to summary
public S unknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail