Module cloud.piranha.webapp.impl
Package cloud.piranha.webapp.impl

Class WebXml

java.lang.Object
cloud.piranha.webapp.impl.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

  • Field Details

    • OTHERS_TAG

      public static final String OTHERS_TAG
      Stores the others tag.

    • majorVersion

      public int majorVersion
      Stores the major version.

    • minorVersion

      public int minorVersion
      Stores the minor version.

    • securityConstraints

      public List<WebXml.SecurityConstraint> securityConstraints
      Stores the security constraints

  • Constructor Details

    • WebXml

      public WebXml()

  • Method Details

    • getContextParams

      public List<WebXmlContextParam> getContextParams()
      Returns the context params.
      Returns:
      the context params

    • getDefaultContextPath

      public String getDefaultContextPath()
      Returns 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()
      Returns the display name.
      Returns:
      the display name

    • getErrorPages

      public List<WebXmlErrorPage> getErrorPages()
      Returns the error pages.
      Returns:
      the error pages

    • getFilters

      public List<WebXmlFilter> getFilters()
      Returns the filters.
      Returns:
      the filters

    • getFilterMappings

      public List<WebXmlFilterMapping> getFilterMappings()
      Returns the filter mappings.
      Returns:
      the filter mappings

    • getFragmentName

      public String getFragmentName()
      Returns the fragment name.
      Returns:
      the fragment name

    • getLoginConfig

      public WebXmlLoginConfig getLoginConfig()
      Returns the login config.
      Returns:
      the login config

    • getListeners

      public List<WebXmlListener> getListeners()
      Returns the listeners.
      Returns:
      the listeners

    • getMimeMappings

      public List<WebXmlMimeMapping> getMimeMappings()
      Returns the mime mappings.
      Returns:
      the mime mappings

    • getRequestCharacterEncoding

      public String getRequestCharacterEncoding()
      Returns the request character encoding.
      Returns:
      the request character encoding

    • getResponseCharacterEncoding

      public String getResponseCharacterEncoding()
      Returns the response character encoding.
      Returns:
      the response character encoding

    • getRoleNames

      public Set<String> getRoleNames()
      Get all the unique role names that have either been explicitly declared, or used in a constraint.
      Returns:
      the unique role names that have either been explicitly declared, or used in a constraint.

    • getServlets

      public List<WebXmlServlet> getServlets()
      Returns the servlets.
      Returns:
      the servlets

    • getServletMappings

      public List<WebXmlServletMapping> getServletMappings()
      Returns the servlet mappings.
      Returns:
      the servlet mappings

    • getSessionConfig

      public WebXmlSessionConfig getSessionConfig()
      Returns 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.

    • getMajorVersion

      public int getMajorVersion()
      Gets the major version as set by the version attribute in the web app element
      Returns:
      the major version.

    • setMajorVersion

      public void setMajorVersion​(int majorVersion)
      Sets the major version as set by the version attribute in the web app element
      Parameters:
      majorVersion - the major version.

    • getMinorVersion

      public int getMinorVersion()
      Gets the minor version as set by the version attribute in the web app element
      Returns:
      the major version.

    • setMinorVersion

      public void setMinorVersion​(int minorVersion)
      Sets the minor version as set by the version attribute in the web app element
      Parameters:
      minorVersion - the minor version.

    • setMetadataComplete

      public void setMetadataComplete​(boolean metadataComplete)
      Set the metadata complete flag.
      Parameters:
      metadataComplete - the metadata complete

    • getMetadataComplete

      public boolean getMetadataComplete()
      Get the metadata complete flag.
      Returns:
      the metadata complete

    • getAbsoluteOrdering

      public List<String> getAbsoluteOrdering()
      Returns the absolute ordering.
      Returns:
      the absolute ordering

    • getRelativeOrdering

      public WebXml.RelativeOrder getRelativeOrdering()
      Returns the relative ordering.
      Returns:
      the relative ordering

    • setAbsoluteOrdering

      public void setAbsoluteOrdering​(List<String> absoluteOrdering)
      Set the absolute ordering.
      Parameters:
      absoluteOrdering - the absolute ordering.

    • setRelativeOrdering

      public void setRelativeOrdering​(WebXml.RelativeOrder relativeOrdering)
      Set the relative ordering.
      Parameters:
      relativeOrdering - the relative ordering.

    • getLocaleEncodingMapping

      public Map<String,​String> getLocaleEncodingMapping()
      Returns the locale encoding mapping.
      Returns:
      the locale encoding mapping

    • setLocaleEncodingMapping

      public void setLocaleEncodingMapping​(Map<String,​String> localeEncodingMapping)
      Set the locale encoding mapping.
      Parameters:
      localeEncodingMapping - the locale encoding mapping.