public abstract class WebFrameworkProvider extends Object
This class allows providing support for web frameworks. It can be used to extend a web module with a web framework, to find out whether a web module is already extender by a web framework, or to retrieve a web framework's specific configuration files.
Instances of this class are registered in the j2ee/webtier/framework
in the module layer.
Constructor and Description |
---|
WebFrameworkProvider(String name,
String description)
Creates a new web framework with a name and description.
|
Modifier and Type | Method and Description |
---|---|
WebModuleExtender |
createWebModuleExtender(WebModule wm,
ExtenderController controller)
Creates a
web module extender for this framework
and the given web module. |
Set |
extend(WebModule wm)
Deprecated.
This method has been replaced with
createWebModuleExtender . |
abstract File[] |
getConfigurationFiles(WebModule wm)
Returns the configuration files belonging to this framework.
|
FrameworkConfigurationPanel |
getConfigurationPanel(WebModule wm)
Deprecated.
This method has been replaced with
createWebModuleExtender . |
String |
getDescription()
Returns the description of this web framework.
|
String |
getName()
Returns the name of this web framework.
|
String |
getServletPath(FileObject file)
Returns the path of the request URL to a given file .
|
abstract boolean |
isInWebModule(WebModule wm)
Finds out if a given web module has already been extended with this framework.
|
boolean |
requiresWebXml()
Test if this framework requires web.xml deployment descriptor for its
functioning.
|
public WebFrameworkProvider(String name, String description)
name
- the short name of this web framework (e.g., "Struts"); never null.description
- the description of this web framework (e.g., "An open source framework based on the MVC pattern"); can be null.NullPointerException
- if the name
parameter is null.public String getName()
public String getDescription()
description
parameter was passed to the constructor.@Deprecated public Set extend(WebModule wm)
createWebModuleExtender
.wm
- the WebModule
to be extended; never null.public abstract boolean isInWebModule(WebModule wm)
wm
- the web module; never null.public abstract File[] getConfigurationFiles(WebModule wm)
wm
- the web module for which the configuration files are returned; never null.@Deprecated public FrameworkConfigurationPanel getConfigurationPanel(WebModule wm)
createWebModuleExtender
.wm
- the web module to be configured.public WebModuleExtender createWebModuleExtender(WebModule wm, ExtenderController controller)
web module extender
for this framework
and the given web module. This method needs to be implemented instead of the
deprecated WebFrameworkProvider.extend(org.netbeans.modules.web.api.webmodule.WebModule)
and WebFrameworkProvider.getConfigurationPanel(org.netbeans.modules.web.api.webmodule.WebModule)
methods. It
needs to be implemented even if this web framework doesn't support extending
a web module (it would just return null in this case).wm
- the web module to be extended; can be null, e.g., if the
method is called while creating a new web application, in which
case the module doesn't exist yet.controller
- an instance of ExtenderController
allowing the
newly created extender to communicate with its environment. See the
ExtenderController
for details. Never null.wm
parameter.public String getServletPath(FileObject file)
JSF Example: consider an index.jsp file in the document base. Normaly the URL
for accessing this page in browser should be http://server:port/contextpath/index.jsp
.
The servlet path is /index.jsp
.
However, because the index.jsp
file includes JSF tags,
its URL should include the appropriate JSF servlet
mapping. If the mapping is /faces/*, then the URL is
http://server:port/contextpath/faces/index.jsp
and this method
should return /faces/index.jsp
.
file
- an arbitrary FileObject
, usually a JSP file; never null.public boolean requiresWebXml()