org.apache.xml.resolver
public class Resolver extends Catalog
Version: 1.0
Field Summary | |
---|---|
static int | RESOLVER
The RESOLVER Catalog Entry type.
|
static int | SYSTEMREVERSE
The SYSTEMREVERSE Catalog Entry type.
|
static int | SYSTEMSUFFIX
The SYSTEMSUFFIX Catalog Entry type.
|
static int | URISUFFIX
The URISUFFIX Catalog Entry type.
|
Method Summary | |
---|---|
void | addEntry(CatalogEntry entry)
Cleanup and process a Catalog entry.
|
protected Resolver | queryResolver(String resolver, String command, String arg1, String arg2)
Query an external RFC2483 resolver.
|
Vector | resolveAllSystem(String systemId)
Return the applicable SYSTEM system identifiers.
|
Vector | resolveAllSystemReverse(String systemId)
Find the URNs for a given system identifier in all catalogs.
|
protected String | resolveExternalPublic(String publicId, String resolver)
Query an external RFC2483 resolver for a public identifier.
|
protected String | resolveExternalSystem(String systemId, String resolver)
Query an external RFC2483 resolver for a system identifier.
|
String | resolvePublic(String publicId, String systemId)
Return the applicable PUBLIC or SYSTEM identifier, resorting
to external resolvers if necessary.
|
String | resolveSystem(String systemId)
Return the applicable SYSTEM system identifier, resorting
to external RESOLVERs if necessary.
|
String | resolveSystemReverse(String systemId)
Find the URN for a given system identifier.
|
String | resolveURI(String uri)
Return the applicable URI.
|
void | setupReaders()
Setup readers. |
A hook for providing support for web-based backup resolvers.
This is a bit of a hack. There's no actual SYSTEMREVERSE entry, but this entry type is used to indicate that a reverse lookup is being performed. (This allows the Resolver to implement RFC2483 I2N and I2NS.)
System suffix entries match system identifiers that end in a specified suffix.
URI suffix entries match URIs that end in a specified suffix.
This method processes each Catalog entry, changing mapped relative system identifiers into absolute ones (based on the current base URI), and maintaining other information about the current catalog.
Parameters: entry The CatalogEntry to process.
Parameters: resolver The URL of the RFC2483 resolver. command The command to send the resolver. arg1 The first argument to the resolver. arg2 The second argument to the resolver, usually null.
Returns: The Resolver constructed.
If one or more SYSTEM entries exists in the Catalog for the system ID specified, return the mapped values.
The caller is responsible for doing any necessary normalization of the system identifier before calling this method. For example, a relative system identifier in a document might be converted to an absolute system identifier before attempting to resolve it.
Note that this function will force all subordinate catalogs to be loaded.
On Windows-based operating systems, the comparison between the system identifier provided and the SYSTEM entries in the Catalog is case-insensitive.
Parameters: systemId The system ID to locate in the catalog.
Returns: The system identifier to use for the notation.
Throws: MalformedURLException The formal system identifier of a subordinate catalog cannot be turned into a valid URL. IOException Error reading subordinate catalog file.
Parameters: systemId The system ID to locate.
Returns: A vector of URNs that map to the systemId.
Parameters: publicId The system ID to locate. resolver The name of the resolver to use.
Returns: The system identifier to use for the systemId.
Parameters: systemId The system ID to locate. resolver The name of the resolver to use.
Returns: The system identifier to use for the systemId.
This method searches the Catalog and returns the system identifier specified for the given system or public identifiers. If no appropriate PUBLIC or SYSTEM entry is found in the Catalog, null is returned.
Note that a system or public identifier in the current catalog (or subordinate catalogs) will be used in preference to an external resolver. Further, if a systemId is present, the external resolver(s) will be queried for that before the publicId.
Parameters: publicId The public identifier to locate in the catalog. Public identifiers are normalized before comparison. systemId The nominal system identifier for the entity in question (as provided in the source document).
Returns: The system identifier to use. Note that the nominal system identifier is not returned if a match is not found in the catalog, instead null is returned to indicate that no match was found.
Throws: MalformedURLException The formal system identifier of a subordinate catalog cannot be turned into a valid URL. IOException Error reading subordinate catalog file.
If a SYSTEM entry exists in the Catalog for the system ID specified, return the mapped value.
In the Resolver (as opposed to the Catalog) class, if the URI isn't found by the usual algorithm, SYSTEMSUFFIX entries are considered.
On Windows-based operating systems, the comparison between the system identifier provided and the SYSTEM entries in the Catalog is case-insensitive.
Parameters: systemId The system ID to locate in the catalog.
Returns: The system identifier to use for systemId.
Throws: MalformedURLException The formal system identifier of a subordinate catalog cannot be turned into a valid URL. IOException Error reading subordinate catalog file.
Parameters: systemId The system ID to locate.
Returns: A (single) URN that maps to the systemId.
If a URI entry exists in the Catalog for the URI specified, return the mapped value.
In the Resolver (as opposed to the Catalog) class, if the URI isn't found by the usual algorithm, URISUFFIX entries are considered.
URI comparison is case sensitive.
Parameters: uri The URI to locate in the catalog.
Returns: The resolved URI.
Throws: MalformedURLException The system identifier of a subordinate catalog cannot be turned into a valid URL. IOException Error reading subordinate catalog file.