org.apache.xml.resolver
public class CatalogManager extends Object
Properties can come from two places: from system properties or from a CatalogManager.properties file. This class provides a transparent interface to both, with system properties preferred over property file values.
The following table summarizes the properties:
System Property | CatalogManager.properties Property |
Description |
xml.catalog.ignoreMissing | If true, a missing CatalogManager.properties file or missing properties within that file will not generate warning messages. See also the ignoreMissingProperties method. | |
xml.catalog.files | catalogs | The |
relative-catalogs | If false, relative catalog URIs are made absolute with respect to the base URI of
the CatalogManager.properties file. This setting only applies to catalog
URIs obtained from the catalogs property |
|
xml.catalog.verbosity | verbosity | If non-zero, the Catalog classes will print informative and debugging messages. The higher the number, the more messages. |
xml.catalog.prefer | prefer | Which identifier is preferred, "public" or "system"? |
xml.catalog.staticCatalog | static-catalog | Should a single catalog be constructed for all parsing, or should a different catalog be created for each parser? |
xml.catalog.allowPI | allow-oasis-xml-catalog-pi | If the source document contains "oasis-xml-catalog" processing instructions, should they be used? |
xml.catalog.className | catalog-class-name | If you're using the convenience classes org.apache.xml.resolver.tools.*), this setting allows you to specify an alternate class name to use for the underlying catalog. |
Version: 1.0
Field Summary | |
---|---|
Debug | debug The manager's debug object. |
Constructor Summary | |
---|---|
CatalogManager() Constructor. | |
CatalogManager(String propertyFile) Constructor that specifies an explicit property file. |
Method Summary | |
---|---|
boolean | allowOasisXMLCatalogPI()
Get the current XML Catalog PI setting.
|
String | catalogClassName()
Get the current Catalog class name.
|
Vector | catalogFiles()
Return the current list of catalog files.
|
boolean | getAllowOasisXMLCatalogPI()
Get the current XML Catalog PI setting. |
BootstrapResolver | getBootstrapResolver() Get the bootstrap resolver. |
Catalog | getCatalog()
Get a catalog instance.
|
String | getCatalogClassName()
Get the current Catalog class name. |
Vector | getCatalogFiles()
Return the current list of catalog files.
|
boolean | getIgnoreMissingProperties()
How are missing properties handled?
|
boolean | getPreferPublic()
Return the current prefer public setting.
|
Catalog | getPrivateCatalog()
Get a new catalog instance.
|
boolean | getRelativeCatalogs()
Get the relativeCatalogs setting.
|
static CatalogManager | getStaticManager()
Allow access to the static CatalogManager |
boolean | getUseStaticCatalog()
Get the current use static catalog setting. |
int | getVerbosity()
What is the current verbosity? |
void | ignoreMissingProperties(boolean ignore)
How are missing properties handled?
|
boolean | preferPublic()
Return the current prefer public setting.
|
boolean | queryAllowOasisXMLCatalogPI() Obtain the oasisXMLCatalogPI setting from the properties. In the properties, a value of 'yes', 'true', or '1' is considered true, anything else is false. |
String | queryCatalogClassName()
Obtain the Catalog class name setting from the properties.
|
boolean | relativeCatalogs()
Get the relativeCatalogs setting.
|
void | setAllowOasisXMLCatalogPI(boolean allowPI)
Set the XML Catalog PI setting |
void | setBootstrapResolver(BootstrapResolver resolver) Set the bootstrap resolver. |
void | setCatalogClassName(String className)
Set the Catalog class name. |
void | setCatalogFiles(String fileList)
Set the list of catalog files. |
void | setIgnoreMissingProperties(boolean ignore)
How should missing properties be handled?
|
void | setPreferPublic(boolean preferPublic)
Set the prefer public setting.
|
void | setRelativeCatalogs(boolean relative)
Set the relativeCatalogs setting.
|
void | setUseStaticCatalog(boolean useStatic)
Set the use static catalog setting. |
void | setVerbosity(int verbosity)
Set the current verbosity. |
boolean | staticCatalog()
Get the current use static catalog setting.
|
int | verbosity()
What is the current verbosity?
|
This field is public so that objects that have access to this CatalogManager can use this debug object.
Deprecated: No longer static; use get/set methods.
Get the current XML Catalog PI setting.Deprecated: No longer static; use get/set methods.
Get the current Catalog class name.Deprecated: No longer static; use get/set methods.
Return the current list of catalog files.Returns: A vector of the catalog file names or null if no catalogs are available in the properties.
Returns: A vector of the catalog file names or null if no catalogs are available in the properties.
If true, missing or unreadable property files will not be reported. Otherwise, a message will be sent to System.err.
Returns: True if public identifiers are preferred.
This property is used when the catalogFiles property is interrogated. If true, then relative catalog entry file names are returned. If false, relative catalog entry file names are made absolute with respect to the properties file before returning them.
This property
In the properties, a value of 'yes', 'true', or '1' is considered true, anything else is false.
Returns: The relativeCatalogs setting from the propertyFile or the defaultRelativeCatalogs.
Deprecated: No longer static; use get/set methods.
How are missing properties handled?If ignore is true, missing or unreadable property files will not be reported. Otherwise, a message will be sent to System.err.
Deprecated: No longer static; use get/set methods.
Return the current prefer public setting.Returns: True if public identifiers are preferred.
Obtain the oasisXMLCatalogPI setting from the properties.
In the properties, a value of 'yes', 'true', or '1' is considered true, anything else is false.
Returns: The oasisXMLCatalogPI setting from the propertyFile or the defaultOasisXMLCatalogPI.
Deprecated: No longer static; use get/set methods.
Get the relativeCatalogs setting.If ignore is true, missing or unreadable property files will not be reported. Otherwise, a message will be sent to System.err.
Returns: True if public identifiers are preferred.
Returns: The relativeCatalogs setting from the propertyFile or the defaultRelativeCatalogs.
See Also: getRelativeCatalogs
Deprecated: No longer static; use get/set methods.
Get the current use static catalog setting.Deprecated: No longer static; use get/set methods.
What is the current verbosity?