Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	BuiltinCompressions.Constants
public static class	BuiltinCompressions.ParseResult Holds the result of `BuiltinCompressions#parseCompressionsList(String)`

Field Summary

Modifier and Type	Field and Description
public static final BuiltinCompressions	delayedZlib
private static final Map<String, CompressionFactory>	EXTENSIONS
private final String	name Hides java.lang.Enum.name.
public static final BuiltinCompressions	none
public static final Set<BuiltinCompressions>	VALUES
public static final BuiltinCompressions	zlib

Access	Constructor and Description
private	BuiltinCompressions(String n)

Method Summary

Modifier and Type	Method and Description
public static BuiltinCompressions	fromFactoryName(String name)
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public static NavigableSet<CompressionFactory>	Returns: A `SortedSet` of the currently registered extensions, sorted according to the factory name (case insensitive) getRegisteredExtensions()
public boolean	isCompressionExecuted() Implements org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.
public boolean	isDelayed() Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed. Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.
public final boolean	isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported.
public static BuiltinCompressions.ParseResult	Returns: A `ParseResult` containing the successfully parsed factories and the unknown ones Note it is up to caller to ensure that the lists do not contain duplicates parseCompressionsList(String A comma-separated list of Compressions' names - ignored if `null`/empty compressions)
public static BuiltinCompressions.ParseResult	parseCompressionsList(String... compressions)
public static BuiltinCompressions.ParseResult	parseCompressionsList(Collection<String> compressions)
public static void	registerExtension(CompressionFactory The factory to register extension) Registered a `org.apache.sshd.common.NamedFactory` to be available besides the built-in ones when parsing configuration
public static CompressionFactory	Returns: The factory or `null` if it is neither a built-in one or a registered extension resolveFactory(String The factory name name)
public final String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static CompressionFactory	Returns: The registered extension - `null` if not found unregisterExtension(String The factory name - ignored if `null`/empty name) Unregisters specified extension
public static BuiltinCompressions	valueOf(String name)
public static BuiltinCompressions[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

delayedZlib	back to summary
public static final BuiltinCompressions delayedZlib

EXTENSIONS	back to summary
private static final Map<String, CompressionFactory> EXTENSIONS

name	back to summary
private final String name Hides java.lang.Enum.name.

none	back to summary
public static final BuiltinCompressions none

VALUES	back to summary
public static final Set<BuiltinCompressions> VALUES

zlib	back to summary
public static final BuiltinCompressions zlib

Constructor Detail

BuiltinCompressions	back to summary
private BuiltinCompressions(String n)

Method Detail

fromFactoryName	back to summary
public static BuiltinCompressions fromFactoryName(String name)

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getRegisteredExtensions	back to summary
public static NavigableSet<CompressionFactory> getRegisteredExtensions() Returns:NavigableSet<CompressionFactory> A `SortedSet` of the currently registered extensions, sorted according to the factory name (case insensitive)

isCompressionExecuted back to summary

isCompressionExecuted	back to summary
public boolean isCompressionExecuted() Implements org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted. Returns:boolean Doc from org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted. `true` if there is any compression executed by this "compressor" - special case for 'none' Annotations @Override

public boolean isCompressionExecuted()

Implements org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

Returns:boolean

Doc from org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

true if there is any compression executed by this "compressor" - special case for 'none'

Annotations

@Override

isDelayed	back to summary
public boolean isDelayed() Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed. Doc from org.apache.sshd.common.compression.CompressionInformation.isDelayed. Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated. Returns:boolean if the compression is delayed after authentication or not Annotations @Override

isDelayed

back to summary

public boolean isDelayed()

Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed.

Doc from org.apache.sshd.common.compression.CompressionInformation.isDelayed.

Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.

Returns:boolean

if the compression is delayed after authentication or not

Annotations

@Override

isSupported	back to summary
public final boolean isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported. Annotations @Override

isSupported

back to summary

public final boolean isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

Annotations

@Override

parseCompressionsList	back to summary
public static BuiltinCompressions.ParseResult parseCompressionsList(String compressions) Parameters compressions:String A comma-separated list of Compressions' names - ignored if `null`/empty Returns:BuiltinCompressions.ParseResult A `ParseResult` containing the successfully parsed factories and the unknown ones Note it is up to caller to ensure that the lists do not contain duplicates

parseCompressionsList	back to summary
public static BuiltinCompressions.ParseResult parseCompressionsList(String... compressions)

parseCompressionsList	back to summary
public static BuiltinCompressions.ParseResult parseCompressionsList(Collection<String> compressions)

registerExtension back to summary

registerExtension	back to summary
public static void registerExtension(CompressionFactory extension) Registered a `org.apache.sshd.common.NamedFactory` to be available besides the built-in ones when parsing configuration Parameters extension:CompressionFactory The factory to register Exceptions IllegalArgumentException: if factory instance is `null`, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).

public static void registerExtension(CompressionFactory extension)

Registered a org.apache.sshd.common.NamedFactory to be available besides the built-in ones when parsing configuration

Parameters

extension:CompressionFactory: The factory to register

Exceptions

IllegalArgumentException:: if factory instance is null, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).

resolveFactory	back to summary
public static CompressionFactory resolveFactory(String name) Parameters name:String The factory name Returns:CompressionFactory The factory or `null` if it is neither a built-in one or a registered extension

toString	back to summary
public final String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public final String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

unregisterExtension back to summary

unregisterExtension	back to summary
public static CompressionFactory unregisterExtension(String name) Unregisters specified extension Parameters name:String The factory name - ignored if `null`/empty Returns:CompressionFactory The registered extension - `null` if not found

public static CompressionFactory unregisterExtension(String name)

Unregisters specified extension

Parameters

name:String: The factory name - ignored if null/empty

Returns:CompressionFactory

The registered extension - null if not found

valueOf	back to summary
public static BuiltinCompressions valueOf(String name)

values	back to summary
public static BuiltinCompressions[] values()

org.apache.sshd.common.compression back to summary

public final Class BuiltinCompressions.Constants

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.common.compression.BuiltinCompressions.Constants

Field Summary

Modifier and Type	Field and Description
public static final String	DELAYED_ZLIB
public static final String	NONE
public static final String	ZLIB

Constructor Summary

Access	Constructor and Description
private	Constants()

Method Summary

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

Field Detail

DELAYED_ZLIB	back to summary
public static final String DELAYED_ZLIB

NONE	back to summary
public static final String NONE

ZLIB	back to summary
public static final String ZLIB

Constructor Detail

Constants	back to summary
private Constants()

org.apache.sshd.common.compression back to summary

public Class BuiltinCompressions.ParseResult

Class Inheritance

extends NamedFactoriesListParseResult<Compression, CompressionFactory>

java.lang.Object
org.apache.sshd.common.config.ListParseResult
org.apache.sshd.common.config.FactoriesListParseResult
org.apache.sshd.common.config.NamedFactoriesListParseResult
org.apache.sshd.common.compression.BuiltinCompressions.ParseResult

Holds the result of BuiltinCompressions#parseCompressionsList(String)

Author: Apache MINA SSHD Project

Field Summary

Modifier and Type	Field and Description
public static final BuiltinCompressions.ParseResult	EMPTY

Constructor Summary

Access	Constructor and Description
public	ParseResult(List<CompressionFactory> parsed, List<String> unsupported)

Method Summary

Inherited from org.apache.sshd.common.config.NamedFactoriesListParseResult:: toString

Field Detail

EMPTY	back to summary
public static final BuiltinCompressions.ParseResult EMPTY

Constructor Detail

ParseResult	back to summary
public ParseResult(List<CompressionFactory> parsed, List<String> unsupported)

public sealed Enum BuiltinCompressions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BuiltinCompressions.Constants

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class BuiltinCompressions.ParseResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail