org.jboss.forge.addon.javaee.facets

Interface ServletFacet

All Superinterfaces:

org.jboss.forge.addon.facets.Facet<org.jboss.forge.addon.projects.Project>, org.jboss.forge.addon.projects.ProjectFacet

public interface ServletFacet
extends org.jboss.forge.addon.projects.ProjectFacet

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

Author:

Lincoln Baxter, III, George Gastaldi

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.shrinkwrap.descriptor.api.webapp30.WebAppDescriptor	getConfig() Parse and return this Project's web.xml file as a WebAppDescriptor.
org.jboss.forge.addon.resource.FileResource<?>	getConfigFile() Return a reference to this Project's web.xml file.
List<org.jboss.forge.addon.resource.Resource<?>>	getResources() List all files in this Project's WebContent directory, recursively.
List<org.jboss.forge.addon.resource.Resource<?>>	getResources(org.jboss.forge.addon.resource.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.webapp30.WebAppDescriptor descriptor) Save the given WebAppDescriptor as this Project's web.xml file.

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Method Detail

getConfig

org.jboss.shrinkwrap.descriptor.api.webapp30.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.webapp30.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

org.jboss.forge.addon.resource.FileResource<?> getConfigFile()

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

getResources

List<org.jboss.forge.addon.resource.Resource<?>> getResources()

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

getResources

List<org.jboss.forge.addon.resource.Resource<?>> getResources(org.jboss.forge.addon.resource.ResourceFilter filter)

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