com.sshtools.common.ui
Class SessionProviderFactory

java.lang.Object
  extended by com.sshtools.common.ui.SessionProviderFactory

public class SessionProviderFactory
extends java.lang.Object

This class is responsible for dynamically loading all the installed session providers. A session provider can be used with SessionProviderFrame to integrate an ssh service such as a terminal window or sftp window within another application.

To install a session provider you should provide a special properties file resource at the root of your source tree called 'session.provider'.

 This properties file should have the following properties defined:

 provider.id= [The unique name of the provider e.g 'sshterm']
 provider.name= [The descriptive name of the provider e.g. 'Terminal Session']
 provider.class= [Fully qualified classname of the provider implementation]
 provider.shortdesc= [A short description of the provider]
 provider.smallicon= [The providers small icon, must be filename only and be
 placed in the same package as the provider class implementation]
 provider.largeicon= [The providers large icon, must be filename only and be
 placed in the same package as the provider class implementation]
 provider.mnemonic= [The mnemonic character]
 provider.options= [The options panel implementation, must implement
 com.sshtools.common.ui.OptionsTab]
 property.page.1= [An number of property page panels, must implement
 com.sshtools.common.ui.SshToolsConnectionTab]
 property.page.2= [More property pages added like this]
 provider.weight= [Weight setting, used to order providers]
 

Version:
$Id: SessionProviderFactory.java,v 1.12 2003/09/22 15:57:57 martianx Exp $
Author:
Lee David Painter

Method Summary
static SessionProviderFactory getInstance()
          Get the one time instance of the factory.
 SessionProvider getProvider(java.lang.String id)
          Get a SessionProvider by its id.
 java.util.List getSessionProviders()
          Get all the installed SessionProvider's.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSessionProviders

public java.util.List getSessionProviders()
Get all the installed SessionProvider's.

Returns:
A list containing instances of SessionProvider

getProvider

public SessionProvider getProvider(java.lang.String id)

Get a SessionProvider by its id. The id is defined by the provider.id property in the providers 'session.provider' resource file.

Session providers that are currently defined within the SSHTools source tree are:

 sshterm   - Terminal session provider
 shift     - SFTP session provider
 tunneling - Secure port forwarding provider
 sshvnc    - VNC session provider
 

Parameters:
id - the id of the SessionProvider.
Returns:

getInstance

public static SessionProviderFactory getInstance()
Get the one time instance of the factory.

Returns:


Copyright © 2002-2003 Lee David Painter & Contributors. All Rights Reserved.