Class Resolver

java.lang.Object

org.codehaus.mojo.xml.Resolver

All Implemented Interfaces:

URIResolver, LSResourceResolver, EntityResolver, EntityResolver2

public class Resolver
extends Object
implements EntityResolver2, URIResolver, LSResourceResolver

An implementation of EntityResolver, URIResolver, and LSResourceResolver, based on the Apache catalog resolver.

Field Summary

Fields

Modifier and Type	Field	Description
private final File	baseDir
private final AbstractXmlMojo.CatalogHandling	catalogHandling
private final org.codehaus.plexus.resource.ResourceManager	locator
private final org.apache.xml.resolver.tools.CatalogResolver	resolver
private boolean	validating
private boolean	xincludeAware

Constructor Summary

Constructors

Constructor	Description
Resolver(File pBaseDir, List<File> pFiles, List<URL> pUrls, org.codehaus.plexus.resource.ResourceManager pLocator, AbstractXmlMojo.CatalogHandling catalogHandling, boolean pLogging)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
private InputSource	asInputSource(URL url)
private Source	asSaxSource(InputSource isource)
(package private) String	filterPossibleURI(String pResource)
InputSource	getExternalSubset(String name, String baseURI)	Implementation of EntityResolver2.getExternalSubset(String, String)
boolean	isValidating()	Returns, whether the Resolver should create validating parsers.
boolean	isXincludeAware()	Returns, whether the transformer should create xinclude aware XML parsers for reading XML documents.
private final LSInput	newLSInput(InputSource pSource)
URL	resolve(String pResource)	Attempts to resolve the given URI.
Source	resolve(String pHref, String pBase)	Implementation of URIResolver.resolve(String, String).
private URL	resolve(String pResource, URI pBaseURI)
private URL	resolveAsFile(String pResource)
private URL	resolveAsResource(String pResource)
private URL	resolveAsURL(String pResource, URI pBaseURI)
InputSource	resolveEntity(String pPublicId, String pSystemId)	Implementation of EntityResolver.resolveEntity(String, String).
InputSource	resolveEntity(String pName, String pPublicId, String pBaseURI, String pSystemId)	Implementation of EntityResolver2.resolveEntity(String, String, String, String)
LSInput	resolveResource(String pType, String pNamespaceURI, String pPublicId, String pSystemId, String pBaseURI)	Implementation of LSResourceResolver.resolveResource(String, String, String, String, String).
void	setValidating(boolean pValidating)	Sets, whether the Resolver should create validating parsers.
void	setXincludeAware(boolean pXIncludeAware)	Sets, whether the transformer should create xinclude aware XML parsers for reading XML documents.

Methods inherited from class Object

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

Field Details

locator

private final org.codehaus.plexus.resource.ResourceManager locator

baseDir

private final File baseDir

resolver

private final org.apache.xml.resolver.tools.CatalogResolver resolver

validating

private boolean validating

xincludeAware

private boolean xincludeAware

catalogHandling

private final AbstractXmlMojo.CatalogHandling catalogHandling

Constructor Details

Resolver

Resolver(File pBaseDir,
 List<File> pFiles,
 List<URL> pUrls,
 org.codehaus.plexus.resource.ResourceManager pLocator,
 AbstractXmlMojo.CatalogHandling catalogHandling,
 boolean pLogging)
  throws org.apache.maven.plugin.MojoExecutionException

Creates a new instance.

Parameters:

pFiles - A set of files with catalog definitions to load

Throws:

org.apache.maven.plugin.MojoExecutionException - An error occurred while loading the resolvers catalogs.

Method Details

resolveEntity

public InputSource resolveEntity(String pPublicId,
 String pSystemId)
                          throws SAXException,
IOException

Implementation of EntityResolver.resolveEntity(String, String).

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

IOException

asInputSource

private InputSource asInputSource(URL url)
                           throws IOException

Throws:

IOException

resolve

public Source resolve(String pHref,
 String pBase)
               throws TransformerException

Implementation of URIResolver.resolve(String, String).

Specified by:

resolve in interface URIResolver

Throws:

TransformerException

asSaxSource

private Source asSaxSource(InputSource isource)
                    throws SAXException,
ParserConfigurationException

Throws:

SAXException

ParserConfigurationException

newLSInput

private final LSInput newLSInput(InputSource pSource)

resolveResource

public LSInput resolveResource(String pType,
 String pNamespaceURI,
 String pPublicId,
 String pSystemId,
 String pBaseURI)

Implementation of LSResourceResolver.resolveResource(String, String, String, String, String).

Specified by:

resolveResource in interface LSResourceResolver

setValidating

public void setValidating(boolean pValidating)

Sets, whether the Resolver should create validating parsers.

Parameters:

pValidating - True, if created parsers should validate. Otherwise false.

isValidating

public boolean isValidating()

Returns, whether the Resolver should create validating parsers.

Returns:

True, if created parsers should validate. Otherwise false.

resolveAsResource

private URL resolveAsResource(String pResource)

resolveAsFile

private URL resolveAsFile(String pResource)

resolveAsURL

private URL resolveAsURL(String pResource,
 URI pBaseURI)

resolve

public URL resolve(String pResource)

Attempts to resolve the given URI.

Parameters:

pResource - The URI to resolve.

Returns:

The URL, which is being referred to by the URI. Null, if no such URL can be found.

resolve

private URL resolve(String pResource,
 URI pBaseURI)

getExternalSubset

public InputSource getExternalSubset(String name,
 String baseURI)
                              throws SAXException,
IOException

Implementation of EntityResolver2.getExternalSubset(String, String)

Specified by:

getExternalSubset in interface EntityResolver2

Throws:

SAXException

IOException

resolveEntity

public InputSource resolveEntity(String pName,
 String pPublicId,
 String pBaseURI,
 String pSystemId)
                          throws SAXException,
IOException

Implementation of EntityResolver2.resolveEntity(String, String, String, String)

Specified by:

resolveEntity in interface EntityResolver2

Throws:

SAXException

IOException

isXincludeAware

public boolean isXincludeAware()

Returns, whether the transformer should create xinclude aware XML parsers for reading XML documents. The default value is false.

Returns:

True, if transformers parser should be xinclud aware. Otherwise false.

setXincludeAware

public void setXincludeAware(boolean pXIncludeAware)

Sets, whether the transformer should create xinclude aware XML parsers for reading XML documents. The default value is false.

Parameters:

pXIncludeAware - True, if transformers parser should be xinclud aware. Otherwise false.

filterPossibleURI

String filterPossibleURI(String pResource)