com.phloc.commons.xml.ls

Class SimpleLSResourceResolver

java.lang.Object

com.phloc.commons.xml.ls.SimpleLSResourceResolver

All Implemented Interfaces:

LSResourceResolver

public class SimpleLSResourceResolver
extends Object
implements LSResourceResolver

A simple LS resource resolver that can handle URLs, JAR files and file system resources.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
SimpleLSResourceResolver()
SimpleLSResourceResolver(LSResourceResolver aWrappedResourceResolver)

Method Summary

Methods

Modifier and Type	Method and Description
static IReadableResource	doStandardResourceResolving(String sSystemId, String sBaseURI) Do the standard resource resolving of sSystemId relative to sBaseURI
protected IReadableResource	internalResolveResource(String sType, String sNamespaceURI, String sPublicId, String sSystemId, String sBaseURI)
LSInput	resolveResource(String sType, String sNamespaceURI, String sPublicId, String sSystemId, String sBaseURI)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleLSResourceResolver

public SimpleLSResourceResolver()

SimpleLSResourceResolver

public SimpleLSResourceResolver(@Nullable
                        LSResourceResolver aWrappedResourceResolver)

Method Detail

doStandardResourceResolving

@Nonnull
public static IReadableResource doStandardResourceResolving(@Nullable
                                                    String sSystemId,
                                                    @Nullable
                                                    String sBaseURI)
                                                     throws IOException

Do the standard resource resolving of sSystemId relative to sBaseURI

Parameters:

sSystemId - The resource to search. May be null if base URI is set.

sBaseURI - The base URI from where the search is initiated. May be null if systemId is set.

Returns:

The non-null resource. May be non-existing!

Throws:

IOException - In case the file resolution (to an absolute file) fails.

internalResolveResource

@OverrideOnDemand
@Nullable
protected IReadableResource internalResolveResource(@Nonnull@Nonempty
                                                                  String sType,
                                                                  @Nullable
                                                                  String sNamespaceURI,
                                                                  @Nullable
                                                                  String sPublicId,
                                                                  @Nullable
                                                                  String sSystemId,
                                                                  @Nullable
                                                                  String sBaseURI)
                                             throws Exception

Parameters:

sType - The type of the resource being resolved. For XML [XML 1.0] resources (i.e. entities), applications must use the value "http://www.w3.org/TR/REC-xml". For XML Schema [XML Schema Part 1] , applications must use the value "http://www.w3.org/2001/XMLSchema". Other types of resources are outside the scope of this specification and therefore should recommend an absolute URI in order to use this method.

sNamespaceURI - The namespace of the resource being resolved, e.g. the target namespace of the XML Schema [XML Schema Part 1] when resolving XML Schema resources.

sPublicId - The public identifier of the external entity being referenced, or null if no public identifier was supplied or if the resource is not an entity.

sSystemId - the path of the resource to find - may be relative to the including resource. The system identifier, a URI reference [IETF RFC 2396], of the external resource being referenced, or null if no system identifier was supplied.

sBaseURI - The systemId of the including resource.The absolute base URI of the resource being parsed, or null if there is no base URI.

Returns:

null if the resource could not be resolved.

Throws:

Exception

resolveResource

@Nullable
public final LSInput resolveResource(@Nonnull@Nonempty
                               String sType,
                               @Nullable
                               String sNamespaceURI,
                               @Nullable
                               String sPublicId,
                               @Nullable
                               String sSystemId,
                               @Nullable
                               String sBaseURI)

Specified by:

resolveResource in interface LSResourceResolver

Parameters:

sType - The type of the resource being resolved. For XML [XML 1.0] resources (i.e. entities), applications must use the value "http://www.w3.org/TR/REC-xml". For XML Schema [XML Schema Part 1] , applications must use the value "http://www.w3.org/2001/XMLSchema". Other types of resources are outside the scope of this specification and therefore should recommend an absolute URI in order to use this method.

sNamespaceURI - The namespace of the resource being resolved, e.g. the target namespace of the XML Schema [XML Schema Part 1] when resolving XML Schema resources.

sPublicId - The public identifier of the external entity being referenced, or null if no public identifier was supplied or if the resource is not an entity.

sSystemId - the path of the resource to find - may be relative to the including resource. The system identifier, a URI reference [IETF RFC 2396], of the external resource being referenced, or null if no system identifier was supplied.

sBaseURI - The systemId of the including resource.The absolute base URI of the resource being parsed, or null if there is no base URI.

Returns:

null if the resource could not be resolved.