All Classes and Interfaces
Class
Description
A subclass of URLConnection for the "about" scheme
An generic "Blob" interface, which represents a resource that may be used
by BFO Publisher.
An abstraction of an HTTP request/response sesssion, such as one corresponding
to the HttpServletRequest/Response pair passed inth an HttpServlet.
A base implementation of
URLConnectionProcessor that does nothing,
but is suitable for extending.An abstraction of a Websocket sesssion.
An object used to determine the used value of an alignment.
An Authority authorizes "grants" on a ServiceEngine to be run remotely.
An Authorization is granted by an Authority in response to an access token.
A URLConnectionProcessor that supports the AWS4 authentication used by Amazon's S3 storage
and compatible systems.
A general purpose blob of data which can be text or binary.
A subclass of URLConnection for the custom "classpath" scheme, e.g.
A ReportFactoryExtension which will convert any content MathML to presentation MathML,
allowing it to be rendered.
A subclass of
URLConnectionProcessor which can be used to serve, store and
persist HTTP Cookies for any HTTP connections made to request resources.A subclass of URLConnection that can be used to read from "data" URLs.
The DefaultSignatureExtension handles the signing process for
PDF digital signatures with an engine of "default" (which is the default
value if the "engine" param is not specified).
An inner display layout model.
A value that specifies the element’s outer display type, which is essentially its principal box’s role
in flow layout.
An experimental top-level ResourceLoader for loading DOCX documents by converting them to first to HTML, for processing with BFO Publisher
An interface which can be used to limit access to a resource at a particular URL.
An implementation of
EgressFilter which delegates to chain of other filters.A top-level ResourceLoader for loading EPUB documents by converting them to first to HTML, for processing with BFO Publisher.
An implementation of
Store that writes to the file systemA URLConnectionFactory that handles the "jar" and "file"
URLs, ie. those handled by Java by default.
A subclass of URLConnection for the "fonts" scheme, which generates a dynamic stylesheet of all
fonts matching the specified path.
An extension to use the Apache FreeMarker
template library as a pre-processor to generate the HTML/XML parsed by BFO Publisher.
A ResourceLoader for PDFFonts, matching all known "font/*" types.
Supports GlobalSign DSS signatures with the "globalsign.dss" or "globalsign.qss" engine.
A ReportFactoryExtension which is required to support the
dir="auto" attribute when parsing HTML, this
extension will convert those to "left" or "right" based on the content of the element.A ReportFactoryExtension that will add support for the "xmlns" prefix to defined
namespaces for HTML parsing, in the same way it already exists for XML.
Determines how namespaces are inferred in HTML.
A URLConnectionFactory that handles the "http", "https", "ftp"
URLs, ie. those handled by Java by default
An abstraction of an HTTP interface onto the ServiceEngine.
A top-level ResourceLoader for loading bitmap images, converting them to HTML for processing with BFO Publisher
An XMLFilter which can be specified with "bfo:xslt" on the
about:index resource to style the generated
index as a book index.A ResourceLoader returning a KeyStore or Certificate.
Like Locale.Language but useful and fast.
Abstract interface encapsulating the sum total of information needed from
the layout module.
The LessStylesheetExtension adds the ability to natively use the "Less"
stylesheet format defined at https://lesscss.org.
A ReportFactoryExtension that will process any <?
A subclass of URLConnection for the "font-local" scheme
Allow the loading of
javax.mail.internet.MimeMessage Mail messages
into the Report.A Configuration controls how an arbitrary mail message is converted to input that can be
used by BFO Publisher.
The MailServerExtension offers a standard way to access email
messages, using the "imap" URL schema described in
RFC5092.
A static helper class that allows easy creation of configuration for loading messages from Google Mail
A simple class representing a Media-Type (aka Content-Type or MIME-Type).
A general purpose URLConnectionFactory which can be used to map particular
URLs to a preloaded byte array, known as a "Blob" (after the same term in
web browsers).
Represents a single OAuth2 authorization.
A wrapper around the
OAuth2 object which allows it to be used as part of
the resource loading process - i.e. it allows HTML, stylesheets, images etc. protected
by OAuth2 authorization to be loaded like any other resourceThe callback which must be populated to complete an OAuth2 transaction.
An implementation of
CallbackHandler that can support OAuth2Callback
It uses the com.sun.net.httpserver package to create a local webserver
and then directs the user to that URL to begin the authentication process.An experimental top-level ResourceLoader for loading ODF documents, converting them to HTML for processing with BFO Publisher
Any URL2 has an Origin associated with it,
for security filtering.
A
URLConnectionProcessor that handles password authentication.A ResourceLoader for PDFSound, matching the "audio/*" type for a PDFReportOutput.
A ResourceLoader for PDFImages, matching the "image" type for a PDFReportOutput.
A PDFReportOutput is an implementation of
ReportOutput
that creates a PDF file.A ResourceLoader for PDF, matching the "video/*" and "model/u3d" "model/prc" type for a PDFReportOutput.
A URLConnectionFactory that handles the "pkcs11" scheme from
A ResourceLoader returning a KeyStore or Certificate.
Represents a single XML processing-instruction, with a "type" and "data".
This enum represents the Referrer Policy used by the Document
or one of its resources.
An implementation of
EgressFilter which works on regluar expressions.
Represents a single Report, as created by
ReportFactory.createReport().A ReportConfiguration is a means of configuring a Report object
to a predetermined state.
A ReportFactory is used to create Report objects.
Represents an extension to the ReportFactory, adding the ability to parse
new types of input or process it in a different way in response to a
processing instruction.
A ReportOutput is used to render a Report to some sort of Output.
A Resource represents an resource such as an HTML page, a stylesheet, an image,
a font etc.
Describes a Resource.
A
Resource may have one or more ResourceFlavorsA ResourceLoader loads an Object from a URI
The ScssStylesheetExtension adds the ability to natively use the "Scss"
stylesheet format defined at https://sass-lang.com.
The core "engine" that drives the Web Service, which has
HttpController and WebsocketController interfaces onto itWhen running BFO Publisher under a Java EE Servlet Engine, this is the entry-point
that manages the setup for that configuration.
A subtype of ReportFactoryExtension that should be implemented
to add support for particular types of digital signature
The Sniffer is used to determine the Media-Type of a URL based on its
content if possible, or the filename in the URL if not
A ReportFactoryExtension that will listen for any hyperlinks in the document,
consider whether the document being linked to is "local" and if it is, attach
it to the PDF as another PDF and redirect all links to that document.
A URLConnectionProcessor which can be used to add SSL client certifcates,
to modify the list of trusted certificates, or to modify other parameters of any
TLS based network connection.
An XML filter that will expand the "single attribute" values used with
SSML
to their expanded versions, which are used by the PDF output
An interface representing an abstract store, eg a FileSystem, which is used to store and retrieve files
A
ResourceLoader to load SVG imagesA ReportOutput that writes the output to one or more SVG files.
An interface which can be set on an
SVGReportOutput to control
where the individual pages are written.A top-level ResourceLoader for loading text/plain documents, converting them to HTML for processing with BFO Publisher
A replacement for the
URI class that always try to parse the URI
and not throw a URISyntaxException, ever.An interface which is analogous to the awful
URLConnection
but designed for implementation and extensionA base class implementing an instance of
URL2ConnectionA URL2Connection that wraps another URL2Connection, for filtering
The URLConnectionFactory interface defines a method of requesting and loading
content from a particular type of URL.
A URLConnectionProcessor can be applied to any
URL2Connection
to modify it either before or after connection is made.A collection of static Utility methods
A ResourceLoader that handles many basic types.
A Websocket-based means of controlling the Webserver.
A ReportFactoryExtension that adds support for XML Inclusions (XInclude).
A top-level ResourceLoader for loading HTML, XML and SVG documents for processing with BFO Publisher.
A ReportFactoryExtension that will process any <?
A ReportFactoryExtension that will apply the XSLT stylesheet
referenced by the "bfo:xslt" attribute on any element,
to that element.
A URLConnectionFactory that can be used to load resources from a Zip file.
Which variation of Zip file we're loading
An extension to use the ZTemplate
template language
as a pre-processor to generate the HTML/XML parsed by BFO Publisher.