Examples of net.xeoh.plugins.base.Plugin

net.xeoh.plugins.base.Plugin
The base class of all plugins. Plugin creation is fairly simple:

1. Create a new top level package for your plugin, e.g., com.company.plugins.imagedb in case of an image database.

2. Create an interface within that package. The interface should (well, must) extend Plugin. Add all the methods you like, for example listImages()

3. Create an impl sub-package with the plugin package, in our case this is com.company.plugins.imagedb.impl. The impl-name is not required, but should be kept as a convention. In the future there might exist tools that depend on it, or work better with it. If you have multiple implementations, create several sub-packages within the impl folder. In our example case, this could be the implementations impl.simple (for a simple test implementation), impl.distributed (for our distributed image storage) and impl.compatiblity (for the old DB API)

4. Implement your interfaces, i.e., create a class / classes inside the respective impl folder.

5. Add the @ {@link PluginImplementation} annotation to your implemented class(es).

6. You're done. Technically your plugin is ready now to use. It can be compiled now (Eclipse will probably have done this for you already). You might want to have a look at the {@link PluginManager} documentation to see how you can load and retrieve it (see addPluginsFrom() and getPlugin()).

NOTE: You should ensure that all implementations of your plugins are thread safe! Expect your functions to be called any time in any state. @author Ralf Biedert @see PluginManager @see PluginUtil

            timer.schedule(lateMessage, 250);


            // Instanciate the plugin
            final Constructor constructor = c.getDeclaredConstructor();
            constructor.setAccessible(true);
            final Plugin spawnedPlugin = (Plugin) constructor.newInstance();
            
            // In here spawning of the plugin worked
            final SpawnResult spawnResult = new SpawnResult(spawnedPlugin);
            spawnResult.metaInformation.pluginStatus = PluginStatus.SPAWNED;
            spawnResult.metaInformation.spawnTime = System.currentTimeMillis();

View Full Code Here

     * @return
     */
    @SuppressWarnings("unchecked")
    Plugin getEntityForType(Class<?> type, String...capabilities) {
        // We need that anyways.
        Plugin plugin = this.pluginManager.getPlugin((Class<Plugin>) getTrueDependencyInterfaceType(type), new OptionCapabilities(capabilities)); 
        
        // First check if the requested type is an anctual interface or not. If it is, we simply treat
        // it as a plugin, if it is not (i.e., a ordinary class), we treat it as a util wrapper.
        if(type.isInterface()) {
            return plugin;

View Full Code Here

        System.out.println("GO");
        ExportResult exportPlugin = p.exportPlugin(p2);
        System.out.println("1");
        Assert.assertNotNull(exportPlugin);
        System.out.println("2");
        Plugin rp = p.getRemoteProxy(new URI("discover://nearest"), TestAnnotations.class);
        System.out.println(rp);
        Plugin remoteProxy = p.getRemoteProxy(new URI("discover://any"), Plugin.class);


        Assert.assertNotNull(remoteProxy);
        TestAnnotations remoteProxy2 = p.getRemoteProxy(new URI("discover://nearest"), TestAnnotations.class);
        Assert.assertNotNull(remoteProxy2);
        String injectionStatus = remoteProxy2.getInjectionStatus();
        Assert.assertEquals(injectionStatus, "INJECTION OK");
        System.out.println("YO");
        Plugin youngest = p.getRemoteProxy(new URI("discover://youngest"), Plugin.class);
        Assert.assertNotNull(youngest);
        Plugin oldest = p.getRemoteProxy(new URI("discover://oldest"), Plugin.class);
        Assert.assertNotNull(oldest);


    }

View Full Code Here

        if (p.spawnType != SpawnType.PLUGIN)
            throw new IllegalStateException("May only hook plugins!");


        this.pluginListLock.lock();
        try {
            Plugin plugin = (Plugin) p.pluggable;


            // Only do something if the plugins is not this
            if (plugin != this && plugin != this.pluginSupervisor) {
                // Wrap plugin inside meta handler, if enabled
                if (this.wrapPluginsInMetaProxy) {


                    final Class<?>[] internalInterfaces = plugin.getClass().getInterfaces();
                    final Class<?>[] interfaces = new Class[internalInterfaces.length + 1];


                    System.arraycopy(internalInterfaces, 0, interfaces, 0, internalInterfaces.length);


                    interfaces[interfaces.length - 1] = PluginWrapper.class;


                    plugin = (Plugin) Proxy.newProxyInstance(plugin.getClass().getClassLoader(), interfaces, new PluginMetaHandler(this.pluginSupervisor, plugin));
                }
            }


            // 1. Process plugin loaded information
            processPluginLoadedAnnotationForThisPlugin(p);

View Full Code Here

TOP

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

net.xeoh.plugins.base.impl.PluginManagerImpl

net.xeoh.plugins.base.impl.spawning.handler.InjectHandler

net.xeoh.plugins.base.impl.spawning.Spawner

net.xeoh.plugins.remote.DiscoverPluginTest

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.