Interface ConfigurationSource

All Known Implementing Classes:
CatalinaBaseConfigurationSource

public interface ConfigurationSource
Abstracts configuration file storage. Allows Tomcat embedding using the regular configuration style. This abstraction aims to be very simple and does not cover resource listing, which is usually used for dynamic deployments that are usually not used when embedding, as well as resource writing.
  • Field Details

  • Method Details

    • getServerXml

      default ConfigurationSource.Resource getServerXml() throws IOException
      Returns the contents of the main conf/server.xml file.
      Returns:
      the server.xml as an InputStream
      Throws:
      IOException - if an error occurs or if the resource does not exist
    • getSharedWebXml

      default ConfigurationSource.Resource getSharedWebXml() throws IOException
      Returns the contents of the shared conf/web.xml file. This usually contains the declaration of the default and JSP servlets.
      Returns:
      the web.xml as an InputStream
      Throws:
      IOException - if an error occurs or if the resource does not exist
    • getConfResource

      default ConfigurationSource.Resource getConfResource(String name) throws IOException
      Get a resource, based on the conf path.
      Parameters:
      name - The resource name
      Returns:
      the resource as an InputStream
      Throws:
      IOException - if an error occurs or if the resource does not exist
    • getResource

      Get a resource, not based on the conf path.
      Parameters:
      name - The resource name
      Returns:
      the resource
      Throws:
      IOException - if an error occurs or if the resource does not exist
    • getURI

      URI getURI(String name)
      Get a URI to the given resource. Unlike getResource, this will also return URIs to locations where no resource exists.
      Parameters:
      name - The resource name
      Returns:
      a URI representing the resource location