org.netbeans.modules.web.spi.webmodule

Interface WebModuleImplementation

Deprecated.

implement WebModuleImplementation2

@Deprecated
public interface WebModuleImplementation

SPI for WebModule.

See Also:

WebModuleFactory

Method Summary

Modifier and Type	Method and Description
String	getContextPath() Deprecated. Returns the context path of the web module.
FileObject	getDeploymentDescriptor() Deprecated. Returns the deployment descriptor (web.xml file) of the web module.
FileObject	getDocumentBase() Deprecated. Returns the folder that contains sources of the static documents for the web module (html, JSPs, etc.).
String	getJ2eePlatformVersion() Deprecated. Returns the J2EE platform version of this module.
FileObject[]	getJavaSources() Deprecated. This method is deprecated, because its return values does not contain enough information about the source roots. Source roots are usually implemented by a org.netbeans.api.project.SourceGroup, which is more than just a container for a FileObject.
MetadataModel<WebAppMetadata>	getMetadataModel() Deprecated. Returns a model describing the metadata of this web module (servlets, resources, etc.).
FileObject	getWebInf() Deprecated. WEB-INF folder for the web module.

Method Detail

getDocumentBase

FileObject getDocumentBase()

Deprecated.

Returns the folder that contains sources of the static documents for the web module (html, JSPs, etc.).

Returns:

the static documents folder; can be null.

getContextPath

String getContextPath()

Deprecated.

Returns the context path of the web module.

Returns:

the context path; can be null.

getJ2eePlatformVersion

String getJ2eePlatformVersion()

Deprecated.

Returns the J2EE platform version of this module. The returned value is one of the constants WebModule.J2EE_13_LEVEL, WebModule.J2EE_14_LEVEL or WebModule.JAVA_EE_5_LEVEL.

Returns:

J2EE platform version; never null.

getWebInf

FileObject getWebInf()

Deprecated.

WEB-INF folder for the web module.

The WEB-INF folder would typically be a child of the folder returned by WebModuleImplementation.getDocumentBase() but does not need to be.

Returns:

the FileObject; might be null

getDeploymentDescriptor

FileObject getDeploymentDescriptor()

Deprecated.

Returns the deployment descriptor (web.xml file) of the web module.

The web.xml file would typically be a child of the folder returned by WebModuleImplementation.getWebInf() but does not need to be.

Returns:

the web.xml file; can be null.

getJavaSources

@Deprecated
FileObject[] getJavaSources()

Deprecated. This method is deprecated, because its return values does not contain enough information about the source roots. Source roots are usually implemented by a org.netbeans.api.project.SourceGroup, which is more than just a container for a FileObject.

Returns the Java source roots associated with the web module.

Note that not all the java source roots in the project (e.g. in a freeform project) belong to the web module.

Returns:

this web module's Java source roots; never null.

getMetadataModel

MetadataModel<WebAppMetadata> getMetadataModel()

Deprecated.

Returns a model describing the metadata of this web module (servlets, resources, etc.).

Returns:

this web module's metadata model; never null.