/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id: ResourceResolver.java 1732018 2016-02-24 04:51:06Z gadams $ */
package org.apache.xmlgraphics.io;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
Implementations of this resource resolver allow XGC users to control the URI resolution
mechanism. All resource and output stream acquisition goes through this when its implementation
is given to the org.apache.fop.apps.EnvironmentProfile.
/**
* Implementations of this resource resolver allow XGC users to control the URI resolution
* mechanism. All resource and output stream acquisition goes through this when its implementation
* is given to the org.apache.fop.apps.EnvironmentProfile.
*/
public interface ResourceResolver {
Get a resource given the URI pointing to said resource.
Params: - uri – the resource URI
Throws: - IOException – if an I/O error occured during resource acquisition
Returns: the resource
/**
* Get a resource given the URI pointing to said resource.
*
* @param uri the resource URI
* @return the resource
* @throws IOException if an I/O error occured during resource acquisition
*/
Resource getResource(URI uri) throws IOException;
Gets an output stream of a given URI.
Params: - uri – the output stream URI
Throws: - IOException – if an I/O error occured while creating an output stream
Returns: the output stream
/**
* Gets an output stream of a given URI.
*
* @param uri the output stream URI
* @return the output stream
* @throws IOException if an I/O error occured while creating an output stream
*/
OutputStream getOutputStream(URI uri) throws IOException;
}