Package org.apache.tomcat.util.file
Interface ConfigurationSource
- 
- All Known Implementing Classes:
- CatalinaBaseConfigurationSource
 
 public interface ConfigurationSourceAbstracts 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.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static classConfigurationSource.ResourceRepresents a resource: a stream to the resource associated with its URI.
 - 
Field SummaryFields Modifier and Type Field Description static ConfigurationSourceDEFAULT
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ConfigurationSource.ResourcegetConfResource(java.lang.String name)Get a resource, based on the conf path.ConfigurationSource.ResourcegetResource(java.lang.String name)Get a resource, not based on the conf path.default ConfigurationSource.ResourcegetServerXml()Returns the contents of the main conf/server.xml file.default ConfigurationSource.ResourcegetSharedWebXml()Returns the contents of the shared conf/web.xml file.java.net.URIgetURI(java.lang.String name)Get a URI to the given resource.
 
- 
- 
- 
Field Detail- 
DEFAULTstatic final ConfigurationSource DEFAULT 
 
- 
 - 
Method Detail- 
getServerXmldefault ConfigurationSource.Resource getServerXml() throws java.io.IOException Returns the contents of the main conf/server.xml file.- Returns:
- the server.xml as an InputStream
- Throws:
- java.io.IOException- if an error occurs or if the resource does not exist
 
 - 
getSharedWebXmldefault ConfigurationSource.Resource getSharedWebXml() throws java.io.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:
- java.io.IOException- if an error occurs or if the resource does not exist
 
 - 
getConfResourcedefault ConfigurationSource.Resource getConfResource(java.lang.String name) throws java.io.IOException Get a resource, based on the conf path.- Parameters:
- name- The resource name
- Returns:
- the resource as an InputStream
- Throws:
- java.io.IOException- if an error occurs or if the resource does not exist
 
 - 
getResourceConfigurationSource.Resource getResource(java.lang.String name) throws java.io.IOException Get a resource, not based on the conf path.- Parameters:
- name- The resource name
- Returns:
- the resource
- Throws:
- java.io.IOException- if an error occurs or if the resource does not exist
 
 - 
getURIjava.net.URI getURI(java.lang.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
 
 
- 
 
-