net.sf.sshapi

Class DefaultProviderFactory

java.lang.Object

net.sf.sshapi.DefaultProviderFactory

All Implemented Interfaces:

SshProviderFactory

public class DefaultProviderFactory
extends java.lang.Object
implements SshProviderFactory

Default implementation of a SshProviderFactory that by default searches for known implementations on the classpath. It can also be configured using system properties.

Locating providers

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROVIDER_CLASS_NAME System property name that may be set to use a specific provider

Constructor Summary

Constructors

Constructor and Description
DefaultProviderFactory() Constructor

Method Summary

Modifier and Type	Method and Description
protected static SshProvider	createProviderInstance(java.lang.String className)
static Capability[]	getAllCapabilties() Get all discovered Capability.
static java.lang.String[]	getAllCiphers() Get all discovered ciphers.
static java.lang.String[]	getAllCompression() Get all discovered compression algorithms.
static java.lang.String[]	getAllKEX() Get all discovered key exchange algorithms.
static java.lang.String[]	getAllMAC() Get all discovered message authentication code algorithms.
static SshProvider[]	getAllProviders() Get all discovered providers.
static java.lang.String[]	getAllPublicKey() Get all discovered public key algorithms.
protected static java.lang.ClassLoader	getClassLoader()
static SshProviderFactory	getInstance() Get a singleton instance of the client factory.
SshProvider	getProvider() Get the default provider.
SshProvider	getProvider(SshConfiguration configuration) Create a new SshProvider using a specified configuration.
static SshProvider	getProviderByName(java.lang.String providerName) Get a provider given it's name.
protected static SshProvider	loadFromProperties(java.util.Properties properties)
protected static SshProvider	loadFromProperties(java.net.URL resource)
protected static java.util.Properties	loadProperties(java.net.URL resource)
static void	setProviderClassLoader(java.lang.ClassLoader classLoader) Set the class loader to use to load providers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROVIDER_CLASS_NAME

public static final java.lang.String PROVIDER_CLASS_NAME

System property name that may be set to use a specific provider

See Also:

Constant Field Values

Constructor Detail

DefaultProviderFactory

public DefaultProviderFactory()

Constructor

Method Detail

getInstance

public static SshProviderFactory getInstance()

Get a singleton instance of the client factory. The instance will be created on the first call to this method. By default, an instance of this class will be created, although this may be overridden by setting the system property FACTORY_CLASS_NAME.

Returns:

instance

getAllProviders

public static SshProvider[] getAllProviders()

Get all discovered providers. See above for details on how providers are discovered.

Returns:

all providers

getAllCapabilties

public static Capability[] getAllCapabilties()

Get all discovered Capability. This is determine by examining all providers for their capabilities and producing a unique list.

Returns:

all capabilities

getAllCiphers

public static java.lang.String[] getAllCiphers()

Get all discovered ciphers. This is determine by examining all providers for their ciphers and producing a unique list.

Returns:

all ciphers

getAllKEX

public static java.lang.String[] getAllKEX()

Get all discovered key exchange algorithms. This is determine by examining all providers for their algorithms and producing a unique list.

Returns:

all key exchange algorithms

getAllCompression

public static java.lang.String[] getAllCompression()

Get all discovered compression algorithms. This is determine by examining all providers for their algorithms and producing a unique list.

Returns:

all compression algorithms

getAllMAC

public static java.lang.String[] getAllMAC()

Get all discovered message authentication code algorithms. This is determine by examining all providers for their algorithms and producing a unique list.

Returns:

all message authentication code algorithms

getProviderByName

public static SshProvider getProviderByName(java.lang.String providerName)

Get a provider given it's name.

Parameters:

providerName - provider name

Returns:

provider

Throws:

java.lang.IllegalArgumentException - if no such provider is found

getAllPublicKey

public static java.lang.String[] getAllPublicKey()

Get all discovered public key algorithms. This is determine by examining all providers for their algorithms and producing a unique list.

Returns:

all public key algorithms

getProvider

public SshProvider getProvider()

Get the default provider.

Returns:

provider

getProvider

public SshProvider getProvider(SshConfiguration configuration)

Description copied from interface: SshProviderFactory

Create a new SshProvider using a specified configuration. Each provider will be offered the configuration to see if it can support it. If more than one provider can support the configuration, the actual one used will depend on the factory implementation.

Specified by:

getProvider in interface SshProviderFactory

Parameters:

configuration - configuration

Returns:

provider

setProviderClassLoader

public static void setProviderClassLoader(java.lang.ClassLoader classLoader)

Set the class loader to use to load providers. By default, this will be current Thread.getContextClassLoader() if one is set, or the class loader that loaded this class if not.

Parameters:

classLoader - class loader

createProviderInstance

protected static final SshProvider createProviderInstance(java.lang.String className)
                                                   throws java.lang.InstantiationException,
                                                          java.lang.IllegalAccessException,
                                                          java.lang.ClassNotFoundException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

getClassLoader

protected static final java.lang.ClassLoader getClassLoader()

loadFromProperties

protected static final SshProvider loadFromProperties(java.net.URL resource)
                                               throws java.io.IOException

Throws:

java.io.IOException

loadFromProperties

protected static final SshProvider loadFromProperties(java.util.Properties properties)

loadProperties

protected static final java.util.Properties loadProperties(java.net.URL resource)
                                                    throws java.io.IOException

Throws:

java.io.IOException