Class ServletPluginExtension

java.lang.Object
ro.sync.ecss.extensions.api.webapp.plugin.ServletPluginExtension
All Implemented Interfaces:
PluginExtension
Direct Known Subclasses:
ServletPluginConfigExtension

@API(type=EXTENDABLE, src=PUBLIC) public abstract class ServletPluginExtension extends Object implements PluginExtension

This abstract class should be extended in order to create a servlet.

To register the servlet you just have to declare an extension of type "WebappServlet" in the plugin's plugin.xml file. For example: <extension type="WebappServlet" class="com.domain.example.ServletPluginExtensionImpl"/>

Web Author installs servlet extensions automatically, each one receiving requests from specific URLs based on the path returned by the getPath() method.

For example, if the Web Author is available at https://example.com/oxygen-xml-web-author/ and the getPath() method returns custom-path, the servlet handles requests for the URLs starting with: https://example.com/oxygen-xml-web-author/plugins-dispatcher/custom-path/.

Since:
26