Package | Description |
---|---|
org.codehaus.cargo.module.webapp | |
org.codehaus.cargo.module.webapp.merge |
Modifier and Type | Method and Description |
---|---|
WebXml |
WarArchive.getWebXml()
Returns the deployment descriptor of the web application.
|
WebXml |
DefaultWarArchive.getWebXml()
Returns the deployment descriptor of the web application.
|
static WebXml |
WebXmlIo.newWebXml(WebXmlVersion theVersion)
Creates a new empty deployment descriptor.
|
WebXml |
WebXmlTypeAwareParser.parse()
Perform the parsing of the passed stream, and return a Web XML from the contents.
|
static WebXml |
WebXmlIo.parseWebXml(InputStream theInput,
EntityResolver theEntityResolver)
Parses a deployment descriptor provided as input stream.
|
static WebXml |
WebXmlIo.parseWebXmlFromFile(File theFile,
EntityResolver theEntityResolver)
Parses a deployment descriptor stored in a regular file.
|
Modifier and Type | Method and Description |
---|---|
static void |
WebXmlUtils.addContextParam(WebXml webXml,
String name,
String value)
Adds a new context-param element to the descriptor.
|
static void |
WebXmlUtils.addEjbRef(WebXml webXml,
EjbRef ref)
Add an EJB Reference.
|
static void |
WebXmlUtils.addFilter(WebXml webXml,
Filter filter) |
static void |
WebXmlUtils.addFilter(WebXml webXml,
String filterName,
String filterClass)
Add a filter to the descriptor.
|
static void |
WebXmlUtils.addFilterInitParam(WebXml webXml,
String name,
String paramName,
String paramValue)
Add an init param to a filter.
|
static void |
WebXmlUtils.addFilterMapping(WebXml webXml,
FilterMapping rhs) |
static void |
WebXmlUtils.addJspFile(WebXml webXml,
String theServletName,
String theJspFile)
Add a JSP file.
|
static void |
WebXmlUtils.addSecurityConstraint(WebXml webXml,
String theWebResourceName,
String theUrlPattern,
List theRoles)
Add a security constraint.
|
static void |
WebXmlUtils.addSecurityRole(WebXml webXml,
String theRoleName) |
static void |
WebXmlUtils.addServlet(WebXml webXml,
Servlet element)
Add a servlet to the web xml.
|
static void |
WebXmlUtils.addServlet(WebXml webXml,
String servletName,
String servletClass)
Add a servlet to the descriptor.
|
static void |
WebXmlUtils.addServletInitParam(WebXml webXml,
String theServletName,
String name,
String value)
Add an init param to a servlet.
|
static void |
WebXmlUtils.addServletMapping(WebXml webXml,
String theServletName,
String theUrlPattern) |
static void |
WebXmlUtils.addServletRunAsRoleName(WebXml webXml,
String theServletName,
String theRoleName) |
static org.jdom.Element |
WebXmlUtils.getContextParam(WebXml webXml,
String paramName)
Returns the element that contains the definition of a specific context param, or
null if a context param of the specified name is not defined in the
descriptor. |
static Filter |
WebXmlUtils.getFilter(WebXml theWebXml,
String filterName) |
static String |
WebXmlUtils.getFilterInitParam(WebXml theWebXml,
String filterName,
String paramName) |
static Iterator |
WebXmlUtils.getFilterInitParamNames(WebXml webXml,
String name)
Get the init parameter names for a filter.
|
static Iterator |
WebXmlUtils.getFilterMappingElements(WebXml webXml,
String theFilterName)
Returns the filter mappings that the specified filter is mapped to in an ordered list.
|
static Iterator |
WebXmlUtils.getFilterMappings(WebXml webXml,
String theFilterName)
Returns the URL-patterns that the specified filter is mapped to in an ordered list.
|
static Iterator |
WebXmlUtils.getFilterNames(WebXml webXml) |
static Iterator |
WebXmlUtils.getFilterNamesForClass(WebXml webXml,
String className)
Returns a list of names of filters that are mapped to the specified class.
|
static String |
WebXmlUtils.getLoginConfigAuthMethod(WebXml webXml)
Get the login config authorization method.
|
static SecurityConstraint |
WebXmlUtils.getSecurityConstraint(WebXml webXml,
String theUrlPattern)
Get a security constraint by URL.
|
static org.jdom.Element |
WebXmlUtils.getSecurityRole(WebXml webXml,
String theRoleName)
Get the security role by name.
|
static Iterator |
WebXmlUtils.getSecurityRoleNames(WebXml webXml)
Get the security role names.
|
static Servlet |
WebXmlUtils.getServlet(WebXml theWebXml,
String servletName) |
static String |
WebXmlUtils.getServletInitParam(WebXml theWebXml,
String servletName,
String paramName) |
static Iterator |
WebXmlUtils.getServletInitParamNames(WebXml webXml,
String theServletName)
Get the names of all the servlet init parameters.
|
static Iterator |
WebXmlUtils.getServletMappings(WebXml webXml,
String theServletName)
Get the servlet mappings to the named servlet.
|
static Iterator |
WebXmlUtils.getServletNames(WebXml webXml)
Get an iterator of the servlet names in the web xml.
|
static Iterator |
WebXmlUtils.getServletNamesForClass(WebXml webXml,
String className)
Get the names that this servlet uses.
|
static Iterator |
WebXmlUtils.getServletNamesForJspFile(WebXml webXml,
String theJspFile)
Returns a list of names of servlets that are mapped to the specified JSP file.
|
static String |
WebXmlUtils.getServletRunAsRoleName(WebXml webXml,
String theServletName)
For a named servlet, return the run-as role name.
|
static boolean |
WebXmlUtils.hasContextParam(WebXml webXml,
String theParamName)
Returns whether a context param by the specified name is defined in the deployment
descriptor.
|
static boolean |
WebXmlUtils.hasFilter(WebXml webXml,
String theFilterName)
Returns whether a servlet filter by the specified name is defined in the deployment
descriptor.
|
static boolean |
WebXmlUtils.hasLoginConfig(WebXml webXml)
Does the descriptor have a login config?
|
static boolean |
WebXmlUtils.hasSecurityConstraint(WebXml webXml,
String theUrlPattern)
Does the descriptor have a security constraint for a URL?
|
static boolean |
WebXmlUtils.hasSecurityRole(WebXml webXml,
String theRoleName)
Does the role have a security definition?
|
static boolean |
WebXmlUtils.hasServlet(WebXml webXml,
String servletName)
Does the web xml have a named servlet.
|
static void |
WebXmlUtils.setLoginConfig(WebXml webXml,
String theAuthMethod,
String theRealmName)
Set the login config.
|
Modifier and Type | Method and Description |
---|---|
WebXml |
MergedWarArchive.getWebXml()
Returns the deployment descriptor of the web application.
|
Modifier and Type | Method and Description |
---|---|
protected void |
WebXmlMerger.checkServletVersions(WebXml theWebXml)
Checks the versions of the servlet API in each descriptor, and logs a warning if a mismatch
might result in the loss of definitions.
|
protected VendorWebAppDescriptor |
WebXmlMerger.getVendorWebAppDescriptor(WebXml theWebXml,
Class clazz)
Get the vendor web app descriptor out of the web xml.
|
protected void |
WebXmlMerger.mergeFilters(WebXml theWebXml)
Merges the servlet definitions from the specified descriptor into the original descriptor.
|
protected void |
WebXmlMerger.mergeSecurityRoles(WebXml theWebXml)
Merges the security roles from the provided descriptor into the original descriptor.
|
protected void |
WebXmlMerger.mergeServlets(WebXml theWebXml)
Merges the servlet definitions from the specified descriptor into the original descriptor.
|
Copyright © 2004-2013 Codehaus. All Rights Reserved.