java.lang.Object
- cloud.piranha.webapp.webxml.WebXml

All Implemented Interfaces:

Serializable
```
public class WebXml
extends Object
implements Serializable
```
The web.xml in object format.

Author:

Manfred Riem ([email protected])

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class WebXml.SecurityConstraint
The <security-constraint> snippet inside a web.xml / webfragment.xml.

Field Summary

Fields
Modifier and Type Field Description

List<WebXml.SecurityConstraint> securityConstraints
Stores the security constraints

Constructor Summary

Constructors
Constructor Description

WebXml()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<WebXmlContextParam>`	`getContextParams()`	Get the context params.
`String`	`getDefaultContextPath()`	Get the default context path.
`boolean`	`getDenyUncoveredHttpMethods()`	Get if we are denying uncovered HTTP methods.
`String`	`getDisplayName()`	Get the display name.
`List<WebXmlErrorPage>`	`getErrorPages()`	Get the error pages.
`List<WebXmlFilterMapping>`	`getFilterMappings()`	Get the filter mappings.
`List<WebXmlFilter>`	`getFilters()`	Get the filters.
`String`	`getFragmentName()`	Get the fragment name.
`List<WebXmlListener>`	`getListeners()`	Get the listeners.
`WebXmlLoginConfig`	`getLoginConfig()`	Get the login config.
`List<WebXmlMimeMapping>`	`getMimeMappings()`	Get the mime mappings.
`String`	`getRequestCharacterEncoding()`	Get the request character encoding.
`String`	`getResponseCharacterEncoding()`	Get the response character encoding.
`List<WebXmlServletMapping>`	`getServletMappings()`	Get the servlet mappings.
`List<WebXmlServlet>`	`getServlets()`	Get the servlets.
`WebXmlSessionConfig`	`getSessionConfig()`	Get the session config.
`List<String>`	`getWelcomeFiles()`	Get the welcome files.
`boolean`	`isDistributable()`	Is the application distributable.
`boolean`	`isFragment()`	Is this a web-fragment.
`void`	`setDefaultContextPath(String defaultContextPath)`	Set the default context path.
`void`	`setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)`	Set if we are denying uncovered HTTP methods.
`void`	`setDisplayName(String displayName)`	Set the display name.
`void`	`setDistributable(boolean distributable)`	Set if we are distributable.
`void`	`setFragment(boolean fragment)`	Set if we are a fragment.
`void`	`setFragmentName(String fragmentName)`	Set the fragment name.
`void`	`setLoginConfig(WebXmlLoginConfig loginConfig)`	Set the login config.
`void`	`setRequestCharacterEncoding(String requestCharacterEncoding)`	Set the request character encoding.
`void`	`setResponseCharacterEncoding(String responseCharacterEncoding)`	Set the response character encoding.
`void`	`setSessionConfig(WebXmlSessionConfig sessionConfig)`	Set the session config.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - securityConstraints
```
public List<WebXml.SecurityConstraint> securityConstraints
```
    Stores the security constraints
- Constructor Detail
  - WebXml
```
public WebXml()
```
- Method Detail
  - getContextParams
```
public List<WebXmlContextParam> getContextParams()
```
    Get the context params.
    
    Returns:
    
    the context params.
  - getDefaultContextPath
```
public String getDefaultContextPath()
```
    Get the default context path.
    
    Returns:
    
    the default context path.
  - getDenyUncoveredHttpMethods
```
public boolean getDenyUncoveredHttpMethods()
```
    Get if we are denying uncovered HTTP methods.
    
    Returns:
    
    true if we are, false otherwise.
  - getDisplayName
```
public String getDisplayName()
```
    Get the display name.
    
    Returns:
    
    the display name.
  - getErrorPages
```
public List<WebXmlErrorPage> getErrorPages()
```
    Get the error pages.
    
    Returns:
    
    the error pages.
  - getFilters
```
public List<WebXmlFilter> getFilters()
```
    Get the filters.
    
    Returns:
    
    the filters.
  - getFilterMappings
```
public List<WebXmlFilterMapping> getFilterMappings()
```
    Get the filter mappings.
    
    Returns:
    
    the filter mappings.
  - getFragmentName
```
public String getFragmentName()
```
    Get the fragment name.
    
    Returns:
    
    the fragment name.
  - getLoginConfig
```
public WebXmlLoginConfig getLoginConfig()
```
    Get the login config.
    
    Returns:
    
    the login config.
  - getListeners
```
public List<WebXmlListener> getListeners()
```
    Get the listeners.
    
    Returns:
    
    the listeners.
  - getMimeMappings
```
public List<WebXmlMimeMapping> getMimeMappings()
```
    Get the mime mappings.
    
    Returns:
    
    the mime mappings.
  - getRequestCharacterEncoding
```
public String getRequestCharacterEncoding()
```
    Get the request character encoding.
    
    Returns:
    
    the request character encoding.
  - getResponseCharacterEncoding
```
public String getResponseCharacterEncoding()
```
    Get the response character encoding.
    
    Returns:
    
    the response character encoding.
  - getServlets
```
public List<WebXmlServlet> getServlets()
```
    Get the servlets.
    
    Returns:
    
    the servlets.
  - getServletMappings
```
public List<WebXmlServletMapping> getServletMappings()
```
    Get the servlet mappings.
    
    Returns:
    
    the servlet mappings.
  - getSessionConfig
```
public WebXmlSessionConfig getSessionConfig()
```
    Get the session config.
    
    Returns:
    
    the session config.
  - getWelcomeFiles
```
public List<String> getWelcomeFiles()
```
    Get the welcome files.
    
    Returns:
    
    welcome files.
  - isDistributable
```
public boolean isDistributable()
```
    Is the application distributable.
    
    Returns:
    
    true if it is, false otherwise.
  - isFragment
```
public boolean isFragment()
```
    Is this a web-fragment.
    
    Returns:
    
    true if it, false otherwise.
  - setDefaultContextPath
```
public void setDefaultContextPath(String defaultContextPath)
```
    Set the default context path.
    
    Parameters:
    
    defaultContextPath - the default context path.
  - setDenyUncoveredHttpMethods
```
public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
```
    Set if we are denying uncovered HTTP methods.
    
    Parameters:
    
    denyUncoveredHttpMethods - the boolean value.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Set the display name.
    
    Parameters:
    
    displayName - the display name.
  - setDistributable
```
public void setDistributable(boolean distributable)
```
    Set if we are distributable.
    
    Parameters:
    
    distributable - the boolean value.
  - setFragment
```
public void setFragment(boolean fragment)
```
    Set if we are a fragment.
    
    Parameters:
    
    fragment - the boolean value.
  - setFragmentName
```
public void setFragmentName(String fragmentName)
```
    Set the fragment name.
    
    Parameters:
    
    fragmentName - the fragment name.
  - setLoginConfig
```
public void setLoginConfig(WebXmlLoginConfig loginConfig)
```
    Set the login config.
    
    Parameters:
    
    loginConfig - the login config.
  - setRequestCharacterEncoding
```
public void setRequestCharacterEncoding(String requestCharacterEncoding)
```
    Set the request character encoding.
    
    Parameters:
    
    requestCharacterEncoding - the request character encoding.
  - setResponseCharacterEncoding
```
public void setResponseCharacterEncoding(String responseCharacterEncoding)
```
    Set the response character encoding.
    
    Parameters:
    
    responseCharacterEncoding - the response character encoding.
  - setSessionConfig
```
public void setSessionConfig(WebXmlSessionConfig sessionConfig)
```
    Set the session config.
    
    Parameters:
    
    sessionConfig - the session comfig.

Class WebXml

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

securityConstraints

Constructor Detail

WebXml

Method Detail

getContextParams

getDefaultContextPath

getDenyUncoveredHttpMethods

getDisplayName

getErrorPages

getFilters

getFilterMappings

getFragmentName

getLoginConfig

getListeners

getMimeMappings

getRequestCharacterEncoding

getResponseCharacterEncoding

getServlets

getServletMappings

getSessionConfig

getWelcomeFiles

isDistributable

isFragment

setDefaultContextPath

setDenyUncoveredHttpMethods

setDisplayName

setDistributable

setFragment

setFragmentName

setLoginConfig

setRequestCharacterEncoding

setResponseCharacterEncoding

setSessionConfig