| java.lang.Object
 org.netbeans.modules.web.spi.webmodule.WebFrameworkProvider
| WebFrameworkProvider | | abstract public class WebFrameworkProvider (Code) | | Encapsulates a web framework.
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.
author:
Petr Pisl, Andrei Badea |
| WebFrameworkProvider | | public WebFrameworkProvider(String name, String description)(Code) | | Creates a new web framework with a name and description.
Parameters:
name - the short name of this web framework (e.g., "Struts"); never null.
Parameters:
description - the description of this web framework (e.g., "An open source framework based on the MVC pattern"); can be null.
throws:
NullPointerException - if the name parameter is null. |
| createWebModuleExtender | | public WebModuleExtender createWebModuleExtender(WebModule wm, ExtenderController controller)(Code) | | Creates a
WebModuleExtender web module extender for this framework
and the given web module. This method needs to be implemented instead of the
deprecated
WebFrameworkProvider.extend and
WebFrameworkProvider.getConfigurationPanel 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).
Parameters:
wm - the web module to be extended; can be null, e.g., if themethod is called while creating a new web application, in whichcase the module doesn't exist yet.
Parameters:
controller - an instance of ExtenderController allowing thenewly created extender to communicate with its environment. See theExtenderController for details. Never null. a new web module extender; can be null if the framework doesn't supportextending (either web modules in general of the particular web modulepassed in the wm parameter. |
| getConfigurationFiles | | abstract public File[] getConfigurationFiles(WebModule wm)(Code) | | Returns the configuration files belonging to this framework.
Parameters:
wm - the web module for which the configuration files are returned; never null. an array containing the configuration files; never null. |
| getConfigurationPanel | | public FrameworkConfigurationPanel getConfigurationPanel(WebModule wm)(Code) | | Returns a configuration panel for this web framework. The panel is used
to allow the user configure the way the web module will be extended.
The configuration panel might be displayed to the user when creating
a new web application or when editing the properties of an existing application.
Parameters:
wm - the web module to be configured. a configuration panel for this web framework.WebFrameworkProvider.createWebModuleExtender createWebModuleExtender |
| getDescription | | public String getDescription()(Code) | | Returns the description of this web framework. Defaults to the name
if a null description parameter was passed to the constructor.
the description; never null. |
| getName | | public String getName()(Code) | | Returns the name of this web framework.
the name; never null. |
| getServletPath | | public String getServletPath(FileObject file)(Code) | | Returns the path of the request URL to a given file .
This path starts with a "/" character and includes either the servlet name
or a path to the servlet/JSP. Includes the servlet mapping, but does not include
any extra path information or a query string. The method can return null.
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.
Parameters:
file - an arbitrary FileObject, usually a JSP file; never null. a string that contains the servlet path including the mapping; can be null. |
| isInWebModule | | abstract public boolean isInWebModule(WebModule wm)(Code) | | Finds out if a given web module has already been extended with this framework.
Parameters:
wm - the web module; never null. true if the web module has already been extended with this framework, false otherwise. |
|
|