Examples of net.xeoh.plugins.base.PluginManager

net.xeoh.plugins.base.PluginManager
This is your entry point to and the heart of JSPF. The plugin manager keeps track of all registed plugins and gives you methods to add and query them. You cannot instantiate the PluginManager directly, instead you

create this class the first time by a call to {@link PluginManagerFactory}.createPluginManager()

Afterwards you probably want to add some of your own plugins. During the lifetime of your application there should only be one PluginManager. The PluginManager does not have to be passed to the inside of your plugins, instead, they can request it by the @ {@link InjectPlugin}annotation (i.e, create a field 'public PluginManager manager' and add the annotation).

There are also a number of default plugins you can retrieve right away (without calling addPluginsFrom() explicitly.). These are:
- {@link PluginConfiguration} - enables you to get and set config options
- {@link PluginInformation} - provides meta information about plugins
- {@link InformationBroker} - supports information exchange between plugins while keeping them decoupled
In addition (and after loading the specific plugin) you can also retrieve a RemoteAPI.

The following configuration sub-keys are usually known for this class (see {@link PluginConfiguration}, keys must be set before createPluginManager() is being called, i.e., set in the {@link JSPFProperties} object!):
- cache.enabled - Specifies if the known plugins should be cached. Specify either {true, false}.
- cache.mode - If we should use strong caching (slow but more accurate) or weak (much faster). Specify either {stong, weak}.
- cache.file - Cache file to use. Specify any relative or absolute file path, file will be created / overwritten.
- classpath.filter.default.enabled - If Java default classpaths (e.g., jre/lib/*) should be filtered. Specify either {true, false}. Might not work on all platforms as expected.
- classpath.filter.default.pattern - Specify what to filter in addition to default classpaths. Specify a list of ';' separated tokens, e.g., "jdk/lib;jre/lib". Will be matched against URL representations, so all \\ will be converted to / (and ' ' might become %20, ...).
- logging.level - Either {OFF, FINEST, FINER, FINE, INFO, WARNING, ALL}. Specifies what to log on the console.
@see PluginManagerUtil @author Ralf Biedert

        final JSPFProperties props = new JSPFProperties();


        props.setProperty(PluginManager.class, "cache.enabled", "true");
        props.setProperty(PluginManager.class, "cache.file", "myjspf.cache");


        final PluginManager pm = PluginManagerFactory.createPluginManager(props);


        DiscoveryMangerFileImpl dmp = new DiscoveryMangerFileImpl();
        dmp.anouncePlugin(pm, PublishMethod.JAVASCRIPT, new URI("http://xxx.com"));


        Thread.sleep(2000);

View Full Code Here


        /*
         * The is the only time you have to access a class directly. Just returns the
         * Plugin manager.
         */
        final PluginManager pmf = PluginManagerFactory.createPluginManager();


        /*
         * Add plugins from somewhere. Be sure to put *the right path* in here. This
         * method may be called multiple times. If you plan to deliver your application
         * replace bin/ with for example myplugins.jar
         */
        pmf.addPluginsFrom(new File("target/test-classes/").toURI());


        /*
         * Obtain multiple plugins
         */
        PluginManagerUtil pmu = new PluginManagerUtil(pmf);

View Full Code Here


        /*
         * The is the only time you have to access a class directly. Just returns the
         * Plugin manager.
         */
        final PluginManager pmf = PluginManagerFactory.createPluginManager();


        /*
         * Add plugins from somewhere. Be sure to put *the right path* in here. This
         * method may be called multiple times. If you plan to deliver your application
         * replace bin/ with for example myplugins.jar
         */
        pmf.addPluginsFrom(new File("bin/").toURI());


        /*
         * Thats it. Technically all plugins have now been loaded and are running. If you
         * would like to retrieve one, do it like this:
         */
        final OutputService plugin = pmf.getPlugin(OutputService.class);
        plugin.doSomething();
    }

View Full Code Here

    @Test
    public void testMany() {
        for(int i=0; i<10000; i++) {
            System.out.println();
            System.out.println("Run " + i);
            PluginManager manager = PluginManagerFactory.createPluginManager();
            manager.addPluginsFrom(ClassURI.CLASSPATH);
            manager.shutdown();
        }
    }

View Full Code Here

        try {
            UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
        } catch (final Exception e) {}


        // We only need the default plugins and a few of our owns
        final PluginManager pluginManager = PluginManagerFactory.createPluginManager();
        final PluginManagerUtil pluginManagerUtil = new PluginManagerUtil(pluginManager);


        pluginManager.addPluginsFrom(ClassURI.PLUGIN(PlainConverterImpl.class));
        pluginManager.addPluginsFrom(ClassURI.PLUGIN(CSVConverterImpl.class));
        pluginManager.addPluginsFrom(ClassURI.PLUGIN(XMLConverterImpl.class));
        pluginManager.addPluginsFrom(new File("plugins/").toURI());


        final MainWindow mainWindow = new MainWindow(pluginManager);
        mainWindow.setVisible(true);


        final Collection<Converter> converters = pluginManagerUtil.getPlugins(Converter.class);

View Full Code Here

    /**
     * @throws MalformedURLException
     */
    @Test
    public void testAddPluginsFrom() throws MalformedURLException {
        final PluginManager pm2 = PluginManagerFactory.createPluginManager();


        Assert.assertNull(pm2.getPlugin(TestAnnotations.class));
    }

View Full Code Here

    /**
     * @throws MalformedURLException
     */
    @Test
    public void testAddPluginsFrom() throws MalformedURLException {
        final PluginManager pm2 = PluginManagerFactory.createPluginManager();




        Assert.assertNull(pm2.getPlugin(TestAnnotations.class));
        //pm2.addPluginsFrom(new File("tests/plugins/test.coredefinition.jar").toURI());
        //pm2.addPluginsFrom(new File("tests/plugins/test.annotation.jar").toURI());
        //Assert.assertNotNull(pm2.getPlugin(TestAnnotations.class));
    }

View Full Code Here


        props.setProperty(PluginManager.class, "cache.enabled", "true");
        props.setProperty(PluginManager.class, "cache.mode", "weak");
        props.setProperty(PluginManager.class, "cache.file", "jspf.cache");


        PluginManager pm = PluginManagerFactory.createPluginManager(props);
        pm.addPluginsFrom(new URI("classpath://*"));


        TestAnnotations plugin = pm.getPlugin(TestAnnotations.class);
        RemoteAPI remote = pm.getPlugin(RemoteAPI.class, new OptionPluginSelector<RemoteAPI>(new PluginSelector<RemoteAPI>() {


            public boolean selectPlugin(final RemoteAPI p) {
                if (p.getPublishMethod().equals(PublishMethod.JSON)) return true;
                return false;
            }


        }));


        ExportResult exportPlugin = remote.exportPlugin(plugin);
        Collection<URI> exportURIs = exportPlugin.getExportURIs();
        for (URI uri : exportURIs) {
            System.out.println(uri);
        }
        
        Thread.sleep(6000000);


        pm.shutdown();
    }

View Full Code Here

        props.setProperty(PluginManager.class, "cache.mode", "weak");
        props.setProperty(PluginManager.class, "cache.file", "jspf.cache");
        props.setProperty(PluginManager.class, "logging.level", "INFO");
        props.setProperty(PluginManager.class, "classpath.filter.default.pattern", "");


        PluginManager pm = PluginManagerFactory.createPluginManager(props);
        pm.addPluginsFrom(URI.create("classpath://*"));
        
        final PluginInformation pi = pm.getPlugin(PluginInformation.class);
        final InformationAuthors information = pi.getInformation(pi, InformationAuthors.class);
    }

View Full Code Here

        final JSPFProperties props = new JSPFProperties();


        props.setProperty(PluginManager.class, "cache.enabled", "true");
        props.setProperty(PluginManager.class, "cache.file", "myjspf.cache");


        PluginManager pm = PluginManagerFactory.createPluginManager(props);


        System.out.println("X");
        pm.addPluginsFrom(new URI("classpath://*"));
        pm.addPluginsFrom(new File("coolplugin.jar").toURI());
        System.out.println("Y");


        final PluginInformation pi = pm.getPlugin(PluginInformation.class);
        final PluginManagerUtil pmu = new PluginManagerUtil(pm);
        Collection<Plugin> plugins = pmu.getPlugins(Plugin.class);
        for (Plugin p : plugins) {
            Collection<String> information = pi.getInformation(Information.CLASSPATH_ORIGIN, p);
            for (String string : information) {
                System.out.println(p + ": " + string);
            }
        }


        Thread.sleep(5000);
        pm.shutdown();
    }

View Full Code Here

0 1

TOP

Related Classes of net.xeoh.plugins.base.PluginManager

multipleplugins.Main

net.xeoh.plugins.core.PluginManagerLoadByPath

net.xeoh.plugins.core.PluginManagerTest

net.xeoh.plugins.core.ShutdownTest

net.xeoh.plugins.diagnosisreader.DiagnosisReader

net.xeoh.plugins.remotediscovery.impl.common.discoverymanager.impl.filepreferences.DiscoveryMangerFileImpl

net.xeoh.plugins.remotediscovery.impl.common.discoverymanager.impl.localpreferences.DiscoveryMangerPreferencesImpl

net.xeoh.plugins.sandbox.DiagnosisTest

net.xeoh.plugins.sandbox.JSONTest

net.xeoh.plugins.sandbox.LoadIsolated

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.