Child pages
  • Extending an Application with Custom Plugins

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On In this tutorial we will show how easily your application can be made extensible using the Struts 2 plugins mechanism.

The Interface

First thing we have to do is define an interface that our plugins will implement. This interface must be available to both your web application and the plugins, so keeping it on a separate jar is a good idea.

Code Block
Java
Java
titleIMyPlugin.java
package example;

public interface IMyPlugIn {
   String saySomething();
}

The Plugin

Now lets create an Struts 2 a plugin. Creating a plugin is a simple task, all you need to do is build a jar with your classes, and a file called struts-plugin.xml on its root. First, the class implementing the interface defined on the first step.

...

To install the plugin into your application, just drop the jar file under WEB-INF/lib.

The Action

Now, lets get Struts 2 the framework to inject an instance of com.opensymphony.xwork2.inject.Container into our action, which we will use to discover available plugins at runtime.

Code Block
Java
Java
titleMyAction.java
package example.actions;

import example.IMyPlugin;

public class MyAction extends ActionSupport {
    Set<IMyPlugin> plugins;

    @Inject
    public void setContainer(Container container) {
        Set<String>  names = container.getInstanceNames(IMyPlugin.class);
        plugins = new HashSet<IMyPlugin>();
        for(String name : names) {
            plugins.add(container.getInstance(IMyPlugin.class, name));
        }
    } 

    public Set<IMyPlugin> getPlugins() {
        return this.plugins;
    }
}

The JSP

Let's do something with those plugins:

...