Uses of Class
org.faceless.publisher.type.URL2

Packages that use URL2

Package	Description
org.faceless.publisher	Provides the main classes for BFO Publisher
org.faceless.publisher.ext	Contains extensions to BFO Publisher which are used to add functionality
org.faceless.publisher.output	Provides the base classes for output from BFO Publisher, extended by type-specific subpackages
org.faceless.publisher.output.pdf	Provides the classes used to write output to PDF
org.faceless.publisher.output.svg	Provides the classes used to write output to SVG
org.faceless.publisher.resource	Provides the classes and interfaces used for loading external resources
org.faceless.publisher.type	Contains utility classes and interfaces which are used across BFO Publisher

Uses of URL2 in org.faceless.publisher

Methods in org.faceless.publisher that return URL2

Modifier and Type	Method	Description
URL2	ReportFactory.getBaseURL()	Return the Base URL as set by ReportFactory.setBaseURL(org.faceless.publisher.type.URL2)
URL2	Document.getURL()	Return the base URL of this document, which must be set in order to resolve relative URLs
URL2	Report.getURL()	Return the URL as set by Report.setURL(org.faceless.publisher.type.URL2)

Methods in org.faceless.publisher that return types with arguments of type URL2

Modifier and Type	Method	Description
Map<URL2,Resource>	ReportFactory.getResourceCache()	Return the cache used by this ReportFactory to cache objects like fonts, images etc. across multiple Reports.
List<URL2>	Report.getUserAgentStylesheets()	Return the list of "user-agent" Stylesheets to add to this Report.
List<URL2>	ReportFactory.getUserAgentStylesheets()	Return the modifiable List of URLs to "user-agent" styleshets, which is used to initialise the same value on any Report objects created by this factory.
List<URL2>	Report.getUserStylesheets()	Return the list of "user" Stylesheets to add to this Report.
List<URL2>	ReportFactory.getUserStylesheets()	Return the modifiable List of URLs to "user" styleshets, which is used to initialise the same value on any Report objects created by this factory.

Methods in org.faceless.publisher with parameters of type URL2

Modifier and Type	Method	Description
org.faceless.publisher.type.AbstractTreeNode	Document.getElement(URL2 uri)	Retrieve an element from this document.
Blob	Report.getResource(URL2 uri)	Retrieve a Resource as it would be seen by this Report.
<E> E	ReportFactory.getResource(URL2 uri, MediaType mediaType, Class<E> resourceClass)	Load a resource, exactly as it would be loaded by a Report create from this factory.
void	Document.putElement(URL2 uri, org.faceless.publisher.type.AbstractTreeNode node)	Store an element.
void	Document.putElementDescription(URL2 uri, String description)
void	ReportFactory.setBaseURL(URL2 uri)	Set the Base URL to resolve any relative URLs passed directly into the Report class - specifically this is the Report.load(java.lang.Object) method and user and user-agent stylesheet methods.
void	Document.setURL(URL2 uri)	Set the base URL of the document.
void	Report.setURL(URL2 uri)	Set the URL which this Report will be loaded from in Report.load(java.lang.Object).

Uses of URL2 in org.faceless.publisher.ext

Methods in org.faceless.publisher.ext that return URL2

Modifier and Type	Method	Description
URL2	MailServerExtension.createStore(Json json)	Given a Json configuration, connect to the IMAP server it defines and return a URL which can be used to access that Store.
URL2	SpiderExtension.State.getBaseURL()
URL2	ASCIIDocResourceLoader.getCSS()	Return the URL of the CSS stylesheet applied to any ASCIIDoc documents processed with this ResourceLoader.
URL2	EpubResourceLoader.getCSS()	Return the URL of the CSS stylesheet applied to any EPUB documents processed with this ResourceLoader.
URL2	MarkdownResourceLoader.getCSS()	Return the URL of the CSS stylesheet applied to any Markdown documents processed with this ResourceLoader.
URL2	EpubResourceLoader.getItemXSLT()	Return the URL of the XSLT stylesheet applied to each item in EPUB documents processed with this ResourceLoader.
URL2	MailExtension.ParsedMimeMessage.getMainPart()	Return the URL of the "main" part of the message.
URL2	SpiderExtension.State.getURL()
URL2	EpubResourceLoader.getXSLT()	Return the URL of the XSLT stylesheet applied to any EPUB documents processed with this ResourceLoader.

Methods in org.faceless.publisher.ext that return types with arguments of type URL2

Modifier and Type	Method	Description
Map<URL2,AbstractBlob>	MailExtension.ParsedMimeMessage.getParts()	Return a collection of MIME Parts used in this message.

Methods in org.faceless.publisher.ext with parameters of type URL2

Modifier and Type	Method	Description
void	SimpleReportConfiguration.addResource(URL2 uri, Blob blob)
Store	MailServerExtension.getStore(URL2 uri)	Return a Store matching the specified URL.
boolean	SpiderExtension.isLocal(URL2 base, URL2 target)	Return true if a target URL is considered "local" for the base URL, and therefore attachable.
static MailExtension.Configuration	MailExtension.newTemplateConfiguration(String name, String type, boolean xml, URL2 url)	Create a new Configuration that will apply a template (eg ZTemplate or FreeMarker) to the JSON representation of the message
void	MailServerExtension.removeStore(URL2 uri)	Remove a Store matching the specified URL.
void	ASCIIDocResourceLoader.setCSS(URL2 uri)	Set the URL of the CSS stylesheet applied to any ASCIIDoc documents processed with this ResourceLoader
void	EpubResourceLoader.setCSS(URL2 uri)	Set the URL of the CSS stylesheet applied to any EPUB documents processed with this ResourceLoader
void	MarkdownResourceLoader.setCSS(URL2 uri)	Set the URL of the CSS stylesheet applied to any Markdown documents processed with this ResourceLoader
void	EpubResourceLoader.setItemXSLT(URL2 uri)	Set the URL of the XSLT stylesheet applied to each item included in any EPUB documents processed with this ResourceLoader.
void	ASCIIDocResourceLoader.setTemplatePostprocessor(URL2 uri, ReportFactory factory)	Set the URL of the XML template to apply to the generated output.
void	EpubResourceLoader.setXSLT(URL2 uri)	Set the URL of the XSLT stylesheet applied to any EPUB documents processed with this ResourceLoader

Uses of URL2 in org.faceless.publisher.output

Methods in org.faceless.publisher.output that return URL2

Modifier and Type	Method	Description
URL2	LinkTarget.getBase()

Methods in org.faceless.publisher.output with parameters of type URL2

Modifier and Type	Method	Description
void	DiscardReportOutput.addBookmark(CharSequence label, URL2 uri, int level, boolean open)
void	ReportOutputFilter.addBookmark(CharSequence label, URL2 uri, int level, boolean open)
void	BitmapCanvas.markElement(URL2 uri)
void	ReportCanvas.markElement(URL2 uri)	Mark the next fill, text or image as belonging to the specified URI.
void	ReportCanvasFilter.markElement(URL2 uri)

Constructors in org.faceless.publisher.output with parameters of type URL2

Modifier	Constructor	Description
	LinkTarget(ReportOutput output, URL2 base, Collection<String> ids)

Uses of URL2 in org.faceless.publisher.output.pdf

Methods in org.faceless.publisher.output.pdf with parameters of type URL2

Modifier and Type	Method	Description
void	PDFReportCanvas.markElement(URL2 uri)

Uses of URL2 in org.faceless.publisher.output.svg

Methods in org.faceless.publisher.output.svg with parameters of type URL2

Modifier and Type	Method	Description
void	SVGReportCanvas.markElement(URL2 uri)

Uses of URL2 in org.faceless.publisher.resource

Fields in org.faceless.publisher.resource declared as URL2

Modifier and Type	Field	Description
static final URL2	InputSourceBuilder.INDEXURL

Methods in org.faceless.publisher.resource that return URL2

Modifier and Type	Method	Description
static URL2	DataURLConnectionFactory.create(MediaType mediaType, InputStream data, Origin origin)	Create a data URI
static URL2	DataURLConnectionFactory.create(MediaType mediaType, String data, Origin origin)	Create a data URI
static URL2	ResourceDescriptor.getLinkParametersAsStylesheet(Map<String,List<? extends Term>> params)
URL2	Resource.getRedirectURL()	Return the final URL that was actually used to load the resource, which often be the same as Resource.getURL().
URL2	Resource.getURL()	Return the URL for the Resource
URL2	ResourceDescriptor.getURL()	Return the URL

Methods in org.faceless.publisher.resource that return types with arguments of type URL2

Modifier and Type	Method	Description
Map<URL2,AbstractBlob>	MemoryURLConnectionFactory.getMap()	Return the Map of URLs to {link AbstractBlob} values.

Methods in org.faceless.publisher.resource with parameters of type URL2

Modifier and Type	Method	Description
void	Http1URLConnectionFactory.close(URL2 uri, URL2Connection con)
default void	URLConnectionFactory.close(URL2 uri, URL2Connection con)	Close the specified URLConnection and free any resources allocated by this factory.
static String	KeyStoreResourceLoader.createSelfSignedCertificate(KeyStore keystore, URL2 uri)	Create a self-signed entry in the KeyStore based on the supplied "magic" URL.
long	FileURLConnectionFactory.getExpiry(URL2 uri, URL2Connection con)
long	FontDirURLConnectionFactory.getExpiry(URL2 uri, URL2Connection con)
long	Http1URLConnectionFactory.getExpiry(URL2 uri, URL2Connection con)
long	PKCS11ConnectionFactory.getExpiry(URL2 uri, URL2Connection con)
default long	URLConnectionFactory.getExpiry(URL2 uri, URL2Connection con)	Return the absolute expiry time of the resource reeturned by the specified URLConnection, or Long.MAX_VALUE for forever.
<E> E	ResourceManager.getResource(URL2 uri, Class<E> resourceClass)	Return the Resource of the specified type from the specified URL.
Object	ResourceManager.getResource(URL2 uri, ResourceDescriptor descriptor)	Return the Resource that matches the specified types from the specified URL.
<E> E	ResourceManager.getResource(URL2 uri, MediaType mediaType, Class<E> resourceClass)
URL2Connection	AboutURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	ClasspathConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	DataURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	FileURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	FileWithHeadersURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	FontDirURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	Http1URLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	LocalFontURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	MemoryURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	PKCS11ConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)
URL2Connection	URLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)	Return a URLConnection for the specified URI, or null if not possible with this factory.
URL2Connection	ZipURLConnectionFactory.getURLConnection(URL2 uri, ReportFactory reportFactory)	Return a URLConnection for the specified URI, or null if not possible with this factory.
boolean	ClasspathConnectionFactory.isTrusted(URL2 uri)
boolean	FileURLConnectionFactory.isTrusted(URL2 uri)
boolean	MemoryURLConnectionFactory.isTrusted(URL2 url)
default boolean	URLConnectionFactory.isTrusted(URL2 uri)	Return true if the supplied URL (which will be loadable by this Factory) should be considered trusted.
boolean	FileURLConnectionFactory.isUnchanged(URL2 uri, URL2Connection con)
boolean	FontDirURLConnectionFactory.isUnchanged(URL2 uri, URL2Connection con)
boolean	Http1URLConnectionFactory.isUnchanged(URL2 uri, URL2Connection con)
default boolean	URLConnectionFactory.isUnchanged(URL2 uri, URL2Connection con)	Return true if a previous resource loaded by this factory should be considered valid, based on the supplied response for a subsequent request for the same resource.
Object	NodeResourceLoader.load(ResourceDescriptor d, URL2 uri, org.faceless.publisher.type.AbstractTreeNode node, org.faceless.publisher.Document document)	Attempt to load a Resource from the specified AbstractTreeNode.
Object	SVGInternalResourceLoader.load(ResourceDescriptor d, URL2 uri, org.faceless.publisher.type.AbstractTreeNode node, org.faceless.publisher.Document document)
void	ResourceManager.putSpecialResource(URL2 uri, ResourceFlavor flavor)	Store an XML resource that may be accessed later against the specified ID.
boolean	AboutURLConnectionFactory.supports(URL2 uri)
boolean	ClasspathConnectionFactory.supports(URL2 uri)
boolean	DataURLConnectionFactory.supports(URL2 uri)
boolean	FileURLConnectionFactory.supports(URL2 uri)
boolean	FontDirURLConnectionFactory.supports(URL2 uri)
boolean	Http1URLConnectionFactory.supports(URL2 uri)
boolean	LocalFontURLConnectionFactory.supports(URL2 uri)
boolean	MemoryURLConnectionFactory.supports(URL2 url)	Return true if this URLConnectionFactory supports the specified URL.
boolean	PKCS11ConnectionFactory.supports(URL2 uri)
boolean	URLConnectionFactory.supports(URL2 uri)	Return true if this factory can load the specified URI schema (eg http, ftp, jar, jdbc)
boolean	ZipURLConnectionFactory.supports(URL2 uri)	Return true if this factory can load the specified URI schema (eg http, ftp, jar, jdbc)
ResourceDescriptor	ResourceDescriptor.withURL(URL2 url)

Constructors in org.faceless.publisher.resource with parameters of type URL2

Modifier	Constructor	Description
	InputSourceBuilder(URL2 uri)
	Resource(URL2 uri, ReportFactory reportFactory)	Create a new Resource associated with the specified URL
	ZipURLConnectionFactory(BackedZipFile zip, URL2 base, ZipURLConnectionFactory.Flavor flavor)	Create a URLConnectionFactory that will read entries from a ZIP file.

Constructor parameters in org.faceless.publisher.resource with type arguments of type URL2

Modifier	Constructor	Description
	MemoryURLConnectionFactory(Map<? extends URL2,? extends AbstractBlob> map)	Create a new MemoryURLConnectionFactory.

Uses of URL2 in org.faceless.publisher.type

Fields in org.faceless.publisher.type declared as URL2

Modifier and Type	Field	Description
static final URL2	Metadata.CREATOR
static final URL2	Metadata.DESCRIPTION
static final URL2	Metadata.LDJSON
static final URL2	Metadata.RDFXML
static final URL2	Metadata.RNGSCHEMA
static final URL2	Metadata.SNIFF
static final URL2	Metadata.TITLE

Methods in org.faceless.publisher.type that return URL2

Modifier and Type	Method	Description
static URL2	Util.createDataURL(Blob blob)	Create a "data:" URL from the specified Blob
static URL2	Util.createDataURL(MediaType mediaType, InputStream in)	Create a "data:" URL which will be Base-64 encoded.
static URL2	Util.createDataURL(MediaType mediaType, String data)	Create a "data:" URL
URL2	BfoLayerType.getAction(org.faceless.publisher.type.CSSStyle style, org.faceless.publisher.type.Action action)	Return the "onNNN" property for the specified action, or null if undefined If specified as relative, it's relative
URL2	FormSignatureResource.getBase()
URL2	CSSStyle.getBFOBookmarkTarget()	Return null if it's a link to the current element
URL2	FilterCSSStyle.getBFOBookmarkTarget()
URL2	CSSStyle.getBorderImageSource()	Returns the value of the border-image-source property.
URL2	FilterCSSStyle.getBorderImageSource()
URL2	FilterPropertyDeclarationEvaluationContext.getDocumentURL()
URL2	PropertyDeclarationEvaluationContext.getDocumentURL()
default URL2	EnvSource.getEnvironmentAsURL(String name, URL2 dflt)
URL2	Background.getImage()	Returns the image associated with this layer.
URL2	Mask.getImage()	Returns the image associated with this layer.
URL2	CSSStyle.getListStyleImage()	Returns the value of the list-style-image property.
URL2	FilterCSSStyle.getListStyleImage()
URL2	CSSStyle.getMarkerEnd()
URL2	FilterCSSStyle.getMarkerEnd()
URL2	CSSStyle.getMarkerMid()
URL2	FilterCSSStyle.getMarkerMid()
URL2	CSSStyle.getMarkerStart()
URL2	FilterCSSStyle.getMarkerStart()
URL2	CSSStyle.getMaskBorderSource()	Returns the value of the mask-border-source property.
URL2	FilterCSSStyle.getMaskBorderSource()
URL2	ReportResource.getStylesheet()
default URL2	AbstractBlob.getURL()	Return the URL2 associated with this Blob, or null if unspecified.
URL2	AbstractNode.getURL(String uri)	Given a string, resolve against any base URL adjustments between here and the document root.
URL2	AbstractStyledNode.getURL(String href)
URL2	Blob.getURL()	Return the URL as set in the constructor, which may be null
URL2	ContentHandlerWrapper.getURL(String uri)
URL2	DocumentSink.getURL(String uri)	Resolve a URL against the base URL for the currently open Element
URL2	FontResourceDescriptor.getURL()
URL2	LinkResource.getURL()	Get the URL of the link
URL2	Origin.getURL()	Return the URL2 of the origin.
URL2	Position.getURL()
URL2	ReportResource.getURL()
URL2	URL2Connection.getURL()	Get the URL.
URL2	URL2ConnectionBase.getURL()
URL2	URL2ConnectionWrapper.getURL()
URL2	URLClipPath.getURL()
URL2	URL2.normalize()	Return a new URL which is the normalized equivalent of this URL
static URL2	URL2.parse(String s)	Create a URL from the specified String, or return null if it is so invalid it's beyond salvage
URL2	URL2.relativize(URL2 uri, boolean safe)	Relativize the supplied URL aginst the current one.
URL2	URL2.resolve(String s)	Constructs a new URL by parsing the given string and then resolving it against this URL.
URL2	EgressFilter.rewrite(URL2 uri, URL2 src)	This method will be supplied with the URL about to be loaded, and the base URL of the Document loading it.
URL2	EgressFilterSequence.rewrite(URL2 uri, URL2 base)
URL2	RegexEgressFilter.rewrite(URL2 uri, URL2 base)
URL2	URL2.setFragment(String fragment)	Set the fragment on this URL
URL2	URL2.setFragmentParameters(Map<String,List<String>> params)	Set the Fragment to be the supplied set of fragment parameters
URL2	URL2.setQuery(String query)	Set the query on this URL
URL2	URL2.setUserInfo(String userInfo)	Set the userInfo on this URL
URL2	MetadataValue.uriValue()

Methods in org.faceless.publisher.type that return types with arguments of type URL2

Modifier and Type	Method	Description
List<URL2>	CSSStyle.getBFOMetadataProperty()	Return the "-bfo-metadata-property" property, which is either none, a list or URLs, or a string which will be split on spaces into a list of URLs
List<URL2>	FilterCSSStyle.getBFOMetadataProperty()
List<URL2>	CSSStyle.getBFOMetadataSubject()	Return the "-bfo-metadata-subject" property, which is either none, a list of URLs or a string which will be split on spaces into a list of URLs
List<URL2>	FilterCSSStyle.getBFOMetadataSubject()
List<URL2>	LinkResource.getStylesheets()	Return the list of any XSLT stylesheets that should be applied to the output
List<URL2>	Metadata.getSubjects()

Methods in org.faceless.publisher.type with parameters of type URL2

Modifier and Type	Method	Description
void	CounterFormatOutput.add(URL2 uri)
void	ContentHandlerWrapper.addMetadata(URL2 subject, URL2 property, Object value, Language lang, Object source)
void	DocumentSink.addMetadata(URL2 subject, URL2 property, Object value, Language lang, Object source)	Add a Metadata value to the nearest scoped ancestor, or (if called before the root element), add to the root element.
void	Metadata.addTriple(URL2 subject, URL2 property, Object value, Language lang, Object source)
org.faceless.publisher.type.Content	Content.addURI(URL2 s)
default URL2	EnvSource.getEnvironmentAsURL(String name, URL2 dflt)
<E> E	FilterPropertyDeclarationEvaluationContext.getResource(URL2 uri, MediaType mediaType, Class<E> resourceClass)
<E> E	PropertyDeclarationEvaluationContext.getResource(URL2 uri, MediaType mediaType, Class<E> resourceClass)	Return the specified resource.
boolean	URL2.isSameDocument(URL2 uri)	Return true if this URL is, or is a fragment of the base URL.
URL2	URL2.relativize(URL2 uri, boolean safe)	Relativize the supplied URL aginst the current one.
URL2	EgressFilter.rewrite(URL2 uri, URL2 src)	This method will be supplied with the URL about to be loaded, and the base URL of the Document loading it.
URL2	EgressFilterSequence.rewrite(URL2 uri, URL2 base)
URL2	RegexEgressFilter.rewrite(URL2 uri, URL2 base)
void	FontResourceDescriptor.setURL(URL2 uri, MediaType format, int uuid, int srcIndex)
void	ReportResource.setURL(URL2 url)	Override the base URL set in the constructor.
void	URL2ConnectionBase.setURL(URL2 uri)	Set the URL, overriding the parameter passed into the constructor
static MediaType	Sniffer.sniff(InputStream in, URL2 uri)	Given a mark-capable InputStream, attempt to guess the MediaType.

Method parameters in org.faceless.publisher.type with type arguments of type URL2

Modifier and Type	Method	Description
void	LinkResource.setStylesheets(List<URL2> stylesheets)	Set the list of XSLT stylesheets that should be applied to this link
void	Metadata.setSubjects(List<URL2> subjects)

Constructors in org.faceless.publisher.type with parameters of type URL2

Modifier	Constructor	Description
	Background(org.faceless.publisher.type.BackgroundAttachmentProp attach, org.faceless.publisher.type.BoxProp clip, Paint color, URL2 image, org.faceless.publisher.type.BoxProp origin, org.faceless.publisher.type.BackgroundPosition position, org.faceless.publisher.type.RepeatStyle repeat, org.faceless.publisher.type.BackgroundSize size, org.faceless.publisher.type.BlendModeProp blendMode)	Create a new Background with an image.
	Blob(URL2 uri, MediaType type, byte[] buf, long lastModified)
	Blob(URL2 uri, MediaType type, InputStream in, long lastModified)
	Blob(URL2 uri, MediaType type, String data, long lastModified)
	Blob(URL2 uri, MediaType type, ByteBuffer buf, long lastModified)
	FormSignatureResource(Report report, URL2 base)
	ImageThresholdClipPath(org.faceless.publisher.type.CSSStyle style, URL2 uri)
	LinkResource(org.faceless.publisher.Document document, org.faceless.publisher.resource.ResourceManager resourceManager, URL2 uri, String rel)	Create a link
	Locators(URL2 uri)
	Mask(org.faceless.publisher.type.BoxProp clip, org.faceless.publisher.type.MaskCompositeProp composite, URL2 image, org.faceless.publisher.type.MaskModeProp mode, org.faceless.publisher.type.BoxProp origin, org.faceless.publisher.type.BackgroundPosition position, org.faceless.publisher.type.RepeatStyle repeat, org.faceless.publisher.type.BackgroundSize size)	Create a new Mask.
	MetadataValue(URL2 url)
	Origin(URL2 uri)
	Origin(URL2 uri, String tostring)
	Origin(URL2 uri, String tostring, Origin.CrossOrigin crossOrigin, ReferrerPolicy referrerPolicy)
	ReportResource(ReportFactory factory, URL2 url, MediaType mediaType, Blob source)
	SSLURLConnectionProcessor(URL2 trust, URL2 identity, char[] password, ReportFactory reportFactory)	Create a new SSLURLConnectionProcessor
	URL2(URL2 uri)	Create a new URL2 that is a clone of the supplied value
	URL2ConnectionBase(int code, URL2 uri, InputStream in)	Create a URL2Connection with no headers and which will return the specified InputStream when URL2ConnectionBase.getInputStream() is called
	URL2ConnectionBase(URL2 uri, URLConnection con)	Create a URL2Connection which will wrap the specified URLConnection
	URLClipPath(org.faceless.publisher.Document document, URL2 uri)