fop 2.1

org.apache.fop.apps.io
Class InternalResourceResolver

java.lang.Object
  extended by org.apache.fop.apps.io.InternalResourceResolver

public class InternalResourceResolver
extends java.lang.Object

This object holds the base URI from which to resolve URIs against as well as the resolver for resource acquisition. It also does some URI sanitization of common URI syntactical errors. This class takes in a ResourceResolver and delegates all relevant URIs to it.


Method Summary
static java.net.URI cleanURI(java.lang.String uriStr)
          Performs some sanitation for some of the most common URI syntax mistakes.
 java.net.URI getBaseURI()
          Returns the base URI from which to resolve all URIs against.
static java.net.URI getBaseURI(java.lang.String base)
          Performs some sanitation for some of the most common URI syntax mistakes but returns a directory URI rather than a file URI.
 java.io.OutputStream getOutputStream(java.net.URI uri)
          Returns the OutputStream for a given URI.
 org.apache.xmlgraphics.io.Resource getResource(java.lang.String stringUri)
          Retrieve a resource given a URI in String form.
 org.apache.xmlgraphics.io.Resource getResource(java.net.URI uri)
          Retrieve a resource given a URI in String form.
 java.net.URI resolveFromBase(java.net.URI uri)
          Resolves a URI against the base URI.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getBaseURI

public java.net.URI getBaseURI()
Returns the base URI from which to resolve all URIs against.

Returns:
the base URI

getResource

public org.apache.xmlgraphics.io.Resource getResource(java.lang.String stringUri)
                                               throws java.io.IOException,
                                                      java.net.URISyntaxException
Retrieve a resource given a URI in String form. This also does some syntactical sanitaion on the URI.

Parameters:
stringUri - the URI in String form
Returns:
the resource
Throws:
java.io.IOException - if an I/O error occurred
java.net.URISyntaxException - if the URI syntax was invalid

getResource

public org.apache.xmlgraphics.io.Resource getResource(java.net.URI uri)
                                               throws java.io.IOException
Retrieve a resource given a URI in String form.

Parameters:
uri - the resource URI
Returns:
the resource
Throws:
java.io.IOException - if an I/O error occurred

getOutputStream

public java.io.OutputStream getOutputStream(java.net.URI uri)
                                     throws java.io.IOException
Returns the OutputStream for a given URI.

Parameters:
uri - the URI for the inteded stream
Returns:
the output stream
Throws:
java.io.IOException - if an I/O error occurrred

resolveFromBase

public java.net.URI resolveFromBase(java.net.URI uri)
Resolves a URI against the base URI.

Parameters:
uri - the URI that requires resolution
Returns:
the resolved URI

cleanURI

public static java.net.URI cleanURI(java.lang.String uriStr)
                             throws java.net.URISyntaxException
Performs some sanitation for some of the most common URI syntax mistakes.

Parameters:
uriStr - the URI in String form
Returns:
a valid URI
Throws:
java.net.URISyntaxException - if the given String was too erroneous to validate

getBaseURI

public static java.net.URI getBaseURI(java.lang.String base)
                               throws java.net.URISyntaxException
Performs some sanitation for some of the most common URI syntax mistakes but returns a directory URI rather than a file URI.

Parameters:
base - the directory URI in String form
Returns:
the directory URI
Throws:
java.net.URISyntaxException - if the given String was too erroneous to validate

fop 2.1

Copyright 1999-2016 The Apache Software Foundation. All Rights Reserved.