org.jboss.forge.spec.javaee
Interface ServletFacet

All Superinterfaces:

Facet

public interface ServletFacet
extends Facet

If installed, this Project supports features from the Servlet specification.

Author:

Lincoln Baxter, III

Method Summary

org.jboss.shrinkwrap.descriptor.api.spec.servlet.web.WebAppDescriptor	getConfig() Parse and return this Project's web.xml file as a WebAppDescriptor.
FileResource<?>	getConfigFile() Return a reference to this Project's web.xml file.
List<Resource<?>>	getResources() List all files in this Project's WebContent directory, recursively.
List<Resource<?>>	getResources(ResourceFilter filter) List all files in this Project's WebContent directory, recursively, only if they match the given ResourceFilter.
void	saveConfig(org.jboss.shrinkwrap.descriptor.api.spec.servlet.web.WebAppDescriptor descriptor) Save the given WebAppDescriptor as this Project's web.xml file.

Methods inherited from interface org.jboss.forge.project.Facet

getProject, install, isInstalled, setProject, uninstall

Method Detail

getConfig

org.jboss.shrinkwrap.descriptor.api.spec.servlet.web.WebAppDescriptor getConfig()

Parse and return this Project's web.xml file as a WebAppDescriptor. If no web.xml exists (particularly in the case of Servlet 3.0 projects), return a virtual web-descriptor instance. This virtual instance may then be modified in memory, then saved using saveConfig(WebAppDescriptor), at which point a physical web.xml file will be created on disk.

saveConfig

void saveConfig(org.jboss.shrinkwrap.descriptor.api.spec.servlet.web.WebAppDescriptor descriptor)

Save the given WebAppDescriptor as this Project's web.xml file. If no web.xml file exists, a new web.xml file will be created.

getConfigFile

FileResource<?> getConfigFile()

Return a reference to this Project's web.xml file.

getResources

List<Resource<?>> getResources()

List all files in this Project's WebContent directory, recursively.

getResources

List<Resource<?>> getResources(ResourceFilter filter)

List all files in this Project's WebContent directory, recursively, only if they match the given ResourceFilter.