Introduction

This document lists changes made to the WebModule API.

Index of APIs

Web Module API

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

(Jan 27 '05) Replace URLCookie with a RequestParametersQuery API and RequestParametersQueryImplementation SPI

All changes by date

(Sep 21 '09) Adding ability to listen on WebModuleImplementation2 changes
(Jul 1 '09) Adding method requiresWebXml
(Sep 28 '07) Making the WebModule API public
(Sep 14 '07) Deprecating WebFrameworkProvider.extend() and WebFrameworkProvider.getConfigurationPanel()
(Sep 14 '07) Deprecating WebModule.getJavaSources
(Mar 8 '06) Adding WebFrameworkProvider.getServletPath()
(Jul 28 '05) Adding web framework support
(Jan 27 '05) Replace URLCookie with a RequestParametersQuery API and RequestParametersQueryImplementation SPI

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.api.web.webmodule > 1.20

(1.16) Adding ability to listen on WebModuleImplementation2 changes
(1.15) Adding method requiresWebXml
(1.10) Making the WebModule API public
(1.9) Deprecating WebFrameworkProvider.extend() and WebFrameworkProvider.getConfigurationPanel()
(1.9) Deprecating WebModule.getJavaSources
(1.5) Adding WebFrameworkProvider.getServletPath()
(1.4) Adding web framework support
(1.2) Replace URLCookie with a RequestParametersQuery API and RequestParametersQueryImplementation SPI

Changes by affected class

`org.netbeans.modules.web.spi.webmodule.FrameworkConfigurationPanel`

(Sep 14 '07) Deprecating WebFrameworkProvider.extend() and WebFrameworkProvider.getConfigurationPanel()

`org.netbeans.modules.web.api.webmodule.RequestParametersQuery`

(Jan 27 '05) Replace URLCookie with a RequestParametersQuery API and RequestParametersQueryImplementation SPI

`org.netbeans.modules.web.spi.webmodule.RequestParametersQueryImplementation`

(Jan 27 '05) Replace URLCookie with a RequestParametersQuery API and RequestParametersQueryImplementation SPI

`org.netbeans.modules.web.api.webmodule.URLCookie`

(Jan 27 '05) Replace URLCookie with a RequestParametersQuery API and RequestParametersQueryImplementation SPI

`org.netbeans.modules.web.spi.webmodule.WebFrameworkProvider`

(Sep 14 '07) Deprecating WebFrameworkProvider.extend() and WebFrameworkProvider.getConfigurationPanel()
(Mar 8 '06) Adding WebFrameworkProvider.getServletPath()
(Jul 28 '05) Adding web framework support

`org.netbeans.modules.web.api.webmodule.WebFrameworks`

(Jul 28 '05) Adding web framework support

`org.netbeans.modules.web.api.webmodule.WebModule`

(Sep 14 '07) Deprecating WebModule.getJavaSources

`org.netbeans.modules.web.spi.webmodule.WebModuleExtender`

(Sep 14 '07) Deprecating WebFrameworkProvider.extend() and WebFrameworkProvider.getConfigurationPanel()

`org.netbeans.modules.web.spi.webmodule.WebModuleImplementation2`

(Sep 21 '09) Adding ability to listen on WebModuleImplementation2 changes

Details of all changes by API and date

Web Module API

Adding ability to listen on WebModuleImplementation2 changes

Sep 21 '09; API spec. version: 1.16; affected top-level classes: WebModuleImplementation2; made by: dkonecny; issues: #154944

Adding ability to listen on changes of document base or WEB-INF folder. WebModuleImplementation2 was introduced in this release so I'm taking advantage of it and adding requested methods.

Adding method requiresWebXml

Jul 1 '09; API spec. version: 1.15; made by: pslechta@netbeans.org

New method requiresWebXml added. Framework specifies via this method if it reqires web.xml DD or not.

Making the WebModule API public

Sep 28 '07; API spec. version: 1.10; made by: abadea@netbeans.org; issues: #112441

Made the WebModule API public with the stability level "under development".

Deprecating `WebFrameworkProvider.extend()` and `WebFrameworkProvider.getConfigurationPanel()`

Sep 14 '07; API spec. version: 1.9; affected top-level classes: FrameworkConfigurationPanel WebFrameworkProvider WebModuleExtender; made by: abadea@netbeans.org

Deprecated methods WebFrameworkProvider.extend() and WebFrameworkProvider.getConfigurationPanel(). Class WebConfigurationPanel has been deprecated too.

Introduced a WebModuleExtender class and a WebModule.createWebModuleExtender() method returning it. This allows for better encapsulation of the web module extending process.