ResourceStreamFactory

public interface ResourceStreamFactory

Defines the methods that are required for creating a resource URL, instantiating, and releasing an output HTML resource stream.

The ResourceStreamFactory interface provides the necessary methods for creating a resource URL, as well as instantiating and releasing an output HTML resource stream. Implementations of this interface should provide the functionality to handle the creation, instantiation, and release of the resource stream and URL.

Example usage:

 ResourceStreamFactory resourceStreamFactory = new ResourceStreamFactory() {
     @Override
     public OutputStream createResourceStream(int pageNumber, Resource resource) {
         // Custom implementation to create an output HTML resource stream based on the given resource URL
     }

     @Override
     public String createResourceUrl(int pageNumber, Resource resource) {
         // Custom implementation to create a resource URL based on the given resource name
     }

     @Override
     public void closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream) {
         // Custom implementation to release any resources associated with the resource stream
     }
 };

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(pageStreamFactory, resourceStreamFactory);
 // Use htmlViewOptions in Viewer
 

Methods

createResourceStream(int pageNumber, Resource resource)

public abstract OutputStream createResourceStream(int pageNumber, Resource resource)

Creates the stream used to write output HTML resource data.

Parameters:

Returns: java.io.OutputStream - the stream used to write output resource data.

createResourceUrl(int pageNumber, Resource resource)

public abstract String createResourceUrl(int pageNumber, Resource resource)

Creates the URL for the specified HTML resource based on the page number and resource type.

Parameters:

Returns: java.lang.String - the URL string representing the location of the HTML resource.

closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream)

public abstract void closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream)

Releases the stream created by the createResourceStream(int, Resource) method for the specified page number and HTML resource.

Parameters: