Package org.apache.commons.configuration2.resolver

Class CatalogResolver

java.lang.Object
org.apache.commons.configuration2.resolver.CatalogResolver
All Implemented Interfaces:
EntityResolver
public class CatalogResolver extends Object implements EntityResolver
Thin wrapper around xml commons CatalogResolver to allow list of catalogs to be provided.
Since:
1.7

  • Constructor Details

  • Method Details

    • getLogger

      public ConfigurationLogger getLogger()
      Gets the logger used by this configuration object.
      Returns:
      the logger

    • resolveEntity

      public InputSource resolveEntity(String publicId, String systemId) throws SAXException

      Implements the resolveEntity method for the SAX interface.

      Presented with an optional public identifier and a system identifier, this function attempts to locate a mapping in the catalogs.

      If such a mapping is found, the resolver attempts to open the mapped value as an InputSource and return it. Exceptions are ignored and null is returned if the mapped value cannot be opened as an input source.

      If no mapping is found (or an error occurs attempting to open the mapped value as an input source), null is returned and the system will use the specified system identifier as if no entityResolver was specified.

      Specified by:
      resolveEntity in interface EntityResolver
      Parameters:
      publicId - The public identifier for the entity in question. This may be null.
      systemId - The system identifier for the entity in question. XML requires a system identifier on all external entities, so this value is always specified.
      Returns:
      An InputSource for the mapped identifier, or null.
      Throws:
      SAXException - if an error occurs.

    • setBaseDir

      public void setBaseDir(String baseDir)
      Sets the base path.
      Parameters:
      baseDir - The base path String.

    • setCatalogFiles

      public void setCatalogFiles(String catalogs)
      Sets the list of catalog file names
      Parameters:
      catalogs - The delimited list of catalog files.

    • setDebug

      public void setDebug(boolean debug)
      Enables debug logging of xml-commons Catalog processing.
      Parameters:
      debug - True if debugging should be enabled, false otherwise.

    • setFileSystem

      public void setFileSystem(FileSystem fileSystem)
      Sets the FileSystem.
      Parameters:
      fileSystem - The FileSystem.

    • setInterpolator

      public void setInterpolator(ConfigurationInterpolator ci)
      Sets the ConfigurationInterpolator.
      Parameters:
      ci - the ConfigurationInterpolator

    • setLogger

      public void setLogger(ConfigurationLogger log)
      Allows setting the logger to be used by this object. This method makes it possible for clients to exactly control logging behavior. Per default a logger is set that will ignore all log messages. Derived classes that want to enable logging should call this method during their initialization with the logger to be used. Passing in null as argument disables logging.
      Parameters:
      log - the new logger