org.jboss.forge.addon.javaee.servlet

Interface ServletFacet<DESCRIPTOR extends org.jboss.shrinkwrap.descriptor.api.webapp.WebAppCommonDescriptor>

All Superinterfaces:

Configurable<DESCRIPTOR>, Facet<Project>, JavaEEFacet, ProjectFacet

All Known Subinterfaces:

ServletFacet_2_5, ServletFacet_3_0, ServletFacet_3_1

@FacetConstraints(value=@FacetConstraint(value=WebResourcesFacet.class,type=REQUIRED))
public interface ServletFacet<DESCRIPTOR extends org.jboss.shrinkwrap.descriptor.api.webapp.WebAppCommonDescriptor>
extends JavaEEFacet, Configurable<DESCRIPTOR>, ProjectFacet

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

Author:

Lincoln Baxter, III, George Gastaldi

Method Summary

Modifier and Type	Method and Description
void	addLoginConfig(String authMethod, String realmName) Adds a login-config element to the web.xml of the current project.
void	addSecurityConstraint(String displayName, String webResourceName, String webResourceDescription, Iterable<String> httpMethods, Iterable<String> urlPatterns, Iterable<String> roleNames, TransportGuarantee transportGuarantee) Adds a security constraint to the current project.
void	addSecurityRole(String roleName) Adds a security role to the current project.
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.
List<String>	getSecurityRoles() Returns all the security roles defined for the current project.
DirectoryResource	getWebInfDirectory() Return a reference to the WEB-INF directory of this project.
boolean	removeSecurityRole(String roleName) Removes a security role from the current project.

Methods inherited from interface org.jboss.forge.addon.javaee.JavaEEFacet

getSpecName, getSpecVersion

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

getFaceted, install, isInstalled, uninstall

Methods inherited from interface org.jboss.forge.addon.javaee.Configurable

getConfig, getConfigFile, saveConfig

Method Detail

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.

getWebInfDirectory

DirectoryResource getWebInfDirectory()

Return a reference to the WEB-INF directory of this project.

addLoginConfig

void addLoginConfig(String authMethod,
                    String realmName)

Adds a login-config element to the web.xml of the current project.

Parameters:

authMethod - The authentication mechanism for this login config

realmName - The realm name to be used for the authentication scheme chosen for this login config

addSecurityRole

void addSecurityRole(String roleName)

Adds a security role to the current project.

Parameters:

roleName - The name of the security role. Must conform to the NMTOKEN lexical rules

getSecurityRoles

List<String> getSecurityRoles()

Returns all the security roles defined for the current project.

removeSecurityRole

boolean removeSecurityRole(String roleName)

Removes a security role from the current project.

Parameters:

roleName - The name of the role that should be removed

Returns:

Returns true if the role was successfully removed. If for some reason, e.g. the role was not found, the role could not be removed, returns false.

addSecurityConstraint

void addSecurityConstraint(String displayName,
                           String webResourceName,
                           String webResourceDescription,
                           Iterable<String> httpMethods,
                           Iterable<String> urlPatterns,
                           Iterable<String> roleNames,
                           TransportGuarantee transportGuarantee)

Adds a security constraint to the current project.

Parameters:

displayName - The display name of the new security constraints

webResourceName - The name of the web resource collection of the new security constraint. Cannot be null

webResourceDescription - The description of the web resource collection of the new security constraint

httpMethods - The HTTP methods that are protected by the new security constraint. May be empty

urlPatterns - The URL patterns that are protected by the new security constraint. May be empty

roleNames - The role names which are part of the authentication constraint of the new security constraint. May be empty

transportGuarantee - The user data constraint of the new security constraint