Struts 2 plugins contain classes and configuration that extend, replace, or add to existing Struts framework functionality. A plugin can be installed by adding its JAR file to the application's class path, in addition to the JAR files to fulfill whatever dependencies the plugin itself may have. To configure the plugin, the JAR should contain a
struts-plugin.xml file, which follows the same format as an ordinary
Since a plugin can contain the
struts-plugin.xml file, it has the ability to:
- Define new packages with results, interceptors, and/or actions
- Override framework constants
- Introduce new extension point implementation classes
Many popular but optional features of the framework are distributed as plugins. An application can retain all the plugins provided with the distribution, or just include the ones it uses. Plugins can be used to organize application code or to distribute code to third-parties.
Plugins are not loaded in any particular order. Plugins should not have dependencies on each other. A plugin may depend on classes provided by Struts Core, but it should not depend on classes loaded by another plugin.
The framework loads its default configuration first, then any plugin configuration files found in others JARs on the classpath, and finally the "bootstrap"
struts-default.xml(bundled in the Core JAR)
struts-plugin.xml(as many as can be found in other JARs)
struts.xml(provided by your application)
struts.xml file is always loaded last, it can make use of any resources provided by the plugins bundled with the distribution, or any other plugins available to an application.
To include static resources in your plugins add them under "/static" in your jar. And include them in your page using "/static" as the path, like in the following example:
Extension points allow a plugin to override a key class in the Struts framework with an alternate implementation. For example, a plugin could provide a new class to create Action classes or map requests to Actions.
The following extension points are available in Struts 2:
Let's look at two similar but different plugins bundled with the core distribution.
SiteMesh is a popular alternative to Tiles. SiteMesh provides a common look-and-feel to an application's pages by automatically wrapping a plain page with common elements like headers and menubars.
sitemesh-plugin.jar contains several classes, a standard JAR manifest, and a plugin configuration file.
While the SiteMesh Plugin doesn't provide any new results, interceptors, or actions, or even extend any Struts integration points, it does need to know what settings have been enabled in the Struts framework. Therefore, its
struts-plugin.xml looks like this:
<?xml version="1.0" encoding="UTF-8" ?> <!-- /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ --> <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.5//EN" "http://struts.apache.org/dtds/struts-2.5.dtd"> <struts> <bean class="org.apache.struts2.sitemesh.FreemarkerPageFilter" static="true" optional="true"/> <bean class="org.apache.struts2.sitemesh.VelocityPageFilter" static="true" optional="true"/> </struts>
The two bean elements, with the "static" flag enabled, tell Struts to inject the current settings and framework objects into static property setters on startup. This allows, for example, the FreeMarkerPageFilter class to get an instance of the Struts FreemarkerManager and the current encoding setting.
Tiles is a popular alternative to SiteMesh. Tiles provides a common look-and-feel to an application's pages by breaking the page down into common fragments or "tiles".
tiles-plugin.jar contains several classes, a standard JAR manifest, and a configuration file.
Since the Tiles Plugin does need to register configuration elements, a result class, it provides a
For more about bundled and third-party plugins, visit the Apache Struts Plugin Registry.