com.sshtools.common.ui: public class: SessionProviderFactory

com.sshtools.common.ui
public class: SessionProviderFactory [javadoc | source]

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

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]

author: Lee - David Painter

version: $ - Id: SessionProviderFactory.java,v 1.12 2003/09/22 15:57:57 martianx Exp $

Field Summary
HashMap	providers

Constructor:
SessionProviderFactory() { ExtensionClassLoader classloader = ConfigurationLoader.getExtensionClassLoader(); try { Enumeration en = classloader.getResources("session.provider"); URL url = null; Properties properties; InputStream in; SessionProvider provider; String name; String id; while (en.hasMoreElements()) { try { url = (URL) en.nextElement(); in = url.openStream(); properties = new Properties(); properties.load(in); IOUtil.closeStream(in); if (properties.containsKey("provider.class") && properties.containsKey("provider.name")) { Class cls = classloader.loadClass(properties.getProperty( "provider.class")); String optionsClassName = properties.getProperty( "provider.options"); Class optionsClass = ((optionsClassName == null) \|\| optionsClassName.equals("")) ? null : classloader.loadClass(optionsClassName); String pageclass; int num = 1; Vector pages = new Vector(); do { pageclass = properties.getProperty("property.page." + String.valueOf(num), null); if (pageclass != null) { pages.add(classloader.loadClass(pageclass)); num++; } } while (pageclass != null); Class[] propertypages = new Class[pages.size()]; pages.toArray(propertypages); name = properties.getProperty("provider.name"); int weight = Integer.parseInt(properties.getProperty( "provider.weight")); id = properties.getProperty("provider.id", name); provider = new SessionProvider(id, name, cls, properties.getProperty("provider.shortdesc"), properties.getProperty("provider.mnemonic"), properties.getProperty("provider.smallicon"), properties.getProperty("provider.largeicon"), optionsClass, propertypages, weight); providers.put(id, provider); log.info("Installed " + provider.getName() + " session provider"); } } catch (ClassNotFoundException ex) { log.warn("Session provider class not found", ex); } catch (IOException ex) { log.warn("Failed to read " + url.toExternalForm(), ex); } } } catch (IOException ex) { } }

Constructor:

 SessionProviderFactory() {
     
        ExtensionClassLoader classloader = ConfigurationLoader.getExtensionClassLoader();
        try {
            Enumeration en = classloader.getResources("session.provider");
            URL url = null;
            Properties properties;
            InputStream in;
            SessionProvider provider;
            String name;
            String id;
            while (en.hasMoreElements()) {
                try {
                    url = (URL) en.nextElement();
                    in = url.openStream();
                    properties = new Properties();
                    properties.load(in);
                    IOUtil.closeStream(in);
                    if (properties.containsKey("provider.class") &&
                            properties.containsKey("provider.name")) {
                        Class cls = classloader.loadClass(properties.getProperty(
                                    "provider.class"));
                        String optionsClassName = properties.getProperty(
                                "provider.options");
                        Class optionsClass = ((optionsClassName == null) ||
                            optionsClassName.equals("")) ? null
                                                         : classloader.loadClass(optionsClassName);
                        String pageclass;
                        int num = 1;
                        Vector pages = new Vector();
                        do {
                            pageclass = properties.getProperty("property.page." +
                                    String.valueOf(num), null);
                            if (pageclass != null) {
                                pages.add(classloader.loadClass(pageclass));
                                num++;
                            }
                        } while (pageclass != null);
                        Class[] propertypages = new Class[pages.size()];
                        pages.toArray(propertypages);
                        name = properties.getProperty("provider.name");
                        int weight = Integer.parseInt(properties.getProperty(
                                    "provider.weight"));
                        id = properties.getProperty("provider.id", name);
                        provider = new SessionProvider(id, name, cls,
                                properties.getProperty("provider.shortdesc"),
                                properties.getProperty("provider.mnemonic"),
                                properties.getProperty("provider.smallicon"),
                                properties.getProperty("provider.largeicon"),
                                optionsClass, propertypages, weight);
                        providers.put(id, provider);
                        log.info("Installed " + provider.getName() +
                            " session provider");
                    }
                } catch (ClassNotFoundException ex) {
                    log.warn("Session provider class not found", ex);
                } catch (IOException ex) {
                    log.warn("Failed to read " + url.toExternalForm(), ex);
                }
            }
        } catch (IOException ex) {
        }
}

Method from com.sshtools.common.ui.SessionProviderFactory Summary:
getInstance, getProvider, getSessionProviders

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.sshtools.common.ui.SessionProviderFactory Detail:
public static SessionProviderFactory getInstance() { return (instance == null) ? (instance = new SessionProviderFactory()) : instance; } Get the one time instance of the factory.
public SessionProvider getProvider(String id) { return (SessionProvider) providers.get(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
public List getSessionProviders() { return new Vector(providers.values()); } Get all the installed SessionProvider's.

Method from com.sshtools.common.ui.SessionProviderFactory Detail:

 public static SessionProviderFactory getInstance() {
        return (instance == null) ? (instance = new SessionProviderFactory())
                                  : instance;
}

Get the one time instance of the factory.

 public SessionProvider getProvider(String id) {
        return (SessionProvider) providers.get(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

 public List getSessionProviders() {
        return new Vector(providers.values());
}

Get all the installed SessionProvider's.