Package org.faceless.publisher

Class ReportFactory

java.lang.Object

org.faceless.publisher.ReportFactory

public class ReportFactory
extends Object

A ReportFactory is used to create Report objects.

A single instance of the factory may be used in multiple threads to create multiple Reports, in which case they will all share the same cache of external resources such as stylesheetlist, images and fonts.

Or, different instances of this factory may be created which are entirely independent.

The factory can be used to create a Report from a File or URL, or a new Report object can be returned which can be parsed externally

Constructor Summary

Constructors

Constructor	Description
ReportFactory()	Create a new ReportFactory

Method Summary

Modifier and Type	Method	Description
Report	createReport()	Create a new Report and intialize it to match the settings applied to this factory.
ReportOutput	createReportOutput(MediaType mediaType)	Create a new ReportOutput that matches the specified MediaType, or null if that type cannot be generated.
URL2	getBaseURL()	Return the Base URL as set by setBaseURL(org.faceless.publisher.type.URL2)
int	getCacheSize()	Return the cache size as set by setCacheSize(int)
CallbackHandler	getCallbackHandler()	Return the CallbackHandler, as set by setCallbackHandler(javax.security.auth.callback.CallbackHandler)
DocumentBuilderFactory	getDocumentBuilderFactory()	Return the DocumentBuilderFactory, as set by setDocumentBuilderFactory(javax.xml.parsers.DocumentBuilderFactory)
EgressFilter	getEgressFilter()	Return the EgressFilter, as set by setEgressFilter(org.faceless.publisher.type.EgressFilter)
Map<String,Object>	getEnvironment()	Return the modifiable Map of environment properties which is used to initialise the same value on any Report objects created by this factory.
ExecutorService	getExecutorService()	Return the ExecutorService as set by setExecutorService(java.util.concurrent.ExecutorService)
List<ProcessingInstruction>	getProcessingInstructions()	Return the modifiable List of processing-instructions which is used to initialise the same value on any Report objects created by this factory.
Provider	getProvider()	Return the Provider set by setProvider(java.security.Provider)
SecureRandom	getRandom()	Return the SecureRandom object as set by setRandom(java.security.SecureRandom)
ReferrerPolicy	getReferrerPolicy()	Return the ReferrerPolicy as set by setReferrerPolicy(org.faceless.publisher.type.ReferrerPolicy)
<T extends ReportFactoryExtension> T	getReportFactoryExtension(Class<T> clazz)	Return the first ReportFactoryExtension in the list returned by getReportFactoryExtensions() that is the specified class, or null if there is no match
List<ReportFactoryExtension>	getReportFactoryExtensions()	Return the list of ReportFactoryExtension objects added to this Factory to extend functionality.
<E> E	getResource(URL2 uri, MediaType mediaType, Class<E> resourceClass)	Load a resource, exactly as it would be loaded by a Report create from this factory.
Map<URL2,Resource>	getResourceCache()	Return the cache used by this ReportFactory to cache objects like fonts, images etc. across multiple Reports.
List<ResourceLoader>	getResourceLoaders()	Return the modifiable list of ResourceLoader objects which will be used to load any resources loaded by Reports created by this factory.
SAXParserFactory	getSAXParserFactory()	Return the SAXParserFactory, as set by setSAXParserFactory(javax.xml.parsers.SAXParserFactory)
SAXTransformerFactory	getSAXTransformerFactory()	Return the SAXTransformerFactory, as set by setSAXTransformerFactory(javax.xml.transform.sax.SAXTransformerFactory)
List<URLConnectionFactory>	getURLConnectionFactories()	Return the modifiable list of URLConnectionFactory objects which will be used to load any resources loaded by Reports created by this factory.
List<URLConnectionProcessor>	getURLConnectionProcessors()	Return the modifiable list of URLConnectionProcessor objects which will be used to load any resources loaded by Reports created by this factory.
List<URL2>	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>	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.
static String	getVersion()	Return the BFO Publisher version number, which is set within the Jar
XPathFactory	getXPathFactory()	Return the XPathFactory, as set by setXPathFactory(javax.xml.xpath.XPathFactory)
static boolean	isLicensed()	Return true if BFO Publisher is currently licensed, false if it's running the trial version
XMLReader	newXMLReader(MediaType mediaType, Map<String,Object> env)	Return a new XMLReader object for the specified content type.
void	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	setCacheSize(int size)	Set the number of Resources that can be help in the resource cache.
void	setCallbackHandler(CallbackHandler handler)	Set the CallbackHandler which will be used as the default by any Reports created by this ReportFactory.
void	setDocumentBuilderFactory(DocumentBuilderFactory factory)	Set the DocumentBuilderFactory to be used by all Reports generated by this ReportFactory.
void	setEgressFilter(EgressFilter filter)	Set the EgressFilter which is used to initialise the same value on any Report objects created by this factory.
void	setExecutorService(ExecutorService executor)	Set the ExecutorService to be used for any tasks run in separate threads during the parsing process, such as retrieval of network resources.
static void	setLicenseKey(String key)	Set the license key for use with BFO Publisher
void	setProvider(Provider provider)	Set the Provider to be used for any signature or encryption operations created by this factory.
void	setRandom(SecureRandom random)	Set the SecureRandom object to be used for any random numbers required during parsing - this is used mainly for network requests for resources.
void	setReferrerPolicy(ReferrerPolicy referrerPolicy)	Set the ReferrerPolicy which is used to initialise the same value on any Report objects created by this factory.
void	setSAXParserFactory(SAXParserFactory factory)	Set the SAXParserFactory to be used by all Reports generated by this ReportFactory.
void	setSAXTransformerFactory(SAXTransformerFactory factory)	Set the SAXTransformerFactory to be used by all Reports generated by this ReportFactory The factory will have flags set on it that reflect the current environment, so any flags that need to be set manually on the factory should be set after this method is called.
void	setXPathFactory(XPathFactory factory)	Set the XPathFactory to be used by all Reports generated by this ReportFactory.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReportFactory

public ReportFactory()

Create a new ReportFactory

Method Details

getVersion

public static String getVersion()

Return the BFO Publisher version number, which is set within the Jar

setCacheSize

public void setCacheSize(int size)

Set the number of Resources that can be help in the resource cache. The default is 200.

getCacheSize

public int getCacheSize()

Return the cache size as set by setCacheSize(int)

Returns:

the cache-size

getResourceCache

public Map<URL2,Resource> getResourceCache()

Return the cache used by this ReportFactory to cache objects like fonts, images etc. across multiple Reports. The returned object will be used across multiple threads, so any access to it should be synchronized.

Returns:

the cache.

getExecutorService

public ExecutorService getExecutorService()

Return the ExecutorService as set by setExecutorService(java.util.concurrent.ExecutorService)

Returns:

the ExecutorService

setExecutorService

public void setExecutorService(ExecutorService executor)

Set the ExecutorService to be used for any tasks run in separate threads during the parsing process, such as retrieval of network resources. The default will return a CachedThreadPool which creates threads that begin with "bfopub-". This is normally the bext choice, so should not need to be overridden

Parameters:

executor - the ExecutorService to use for background threads, or null to use the default

setBaseURL

public void 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. Relative URLs encounted during parsing are resolved against the document base URL (which may have been be derived from this)

Parameters:

uri - the base URL to use, or null to leave them relative. The default value is null

getBaseURL

public URL2 getBaseURL()

Return the Base URL as set by setBaseURL(org.faceless.publisher.type.URL2)

Returns:

the Base URL

getRandom

public SecureRandom getRandom()

Return the SecureRandom object as set by setRandom(java.security.SecureRandom)

Returns:

the SecureRandom object

setRandom

public void setRandom(SecureRandom random)

Set the SecureRandom object to be used for any random numbers required during parsing - this is used mainly for network requests for resources. The default is the native non-blocking PRNG random generator, which is normally the best choice.

Parameters:

random - the SecureRandom to use, or null to use the default.

getCallbackHandler

public CallbackHandler getCallbackHandler()

Return the CallbackHandler, as set by setCallbackHandler(javax.security.auth.callback.CallbackHandler)

Returns:

the CallbackHandler to use, which may be null

See Also:

• setCallbackHandler(javax.security.auth.callback.CallbackHandler)

setCallbackHandler

public void setCallbackHandler(CallbackHandler handler)

Set the CallbackHandler which will be used as the default by any Reports created by this ReportFactory. The default is null. The exact callbacks will depend on the type of authorization required but may include regular NameCallback and PasswordCallback for access to HTTP resources protected by Basic, Digest or AWS4 authentication, for access to KeyStores or (if configured) IMAP Mail Servers. It may also include OAuth2Callback callbacks if OAuth2 authentication is configured for access to HTTP or IMAP resources

Parameters:

handler - the handler, which may be null

See Also:

• Report.setCallbackHandler(javax.security.auth.callback.CallbackHandler)
• OAuth2
• AWS4AuthenticationURLConnectionProcessor
• OAuth2AuthenticationURLConnectionProcessor
• PasswordAuthenticationURLConnectionProcessor

setReferrerPolicy

public void setReferrerPolicy(ReferrerPolicy referrerPolicy)

Set the ReferrerPolicy which is used to initialise the same value on any Report objects created by this factory.

Parameters:

referrerPolicy - the policy, or null to use the default

See Also:

• Report.setReferrerPolicy(org.faceless.publisher.type.ReferrerPolicy)

getReferrerPolicy

public ReferrerPolicy getReferrerPolicy()

Return the ReferrerPolicy as set by setReferrerPolicy(org.faceless.publisher.type.ReferrerPolicy)

Returns:

the policy

getURLConnectionFactories

public List<URLConnectionFactory> getURLConnectionFactories()

Return the modifiable list of URLConnectionFactory objects which will be used to load any resources loaded by Reports created by this factory. The list may be modified to add custom loaders. Null or duplicate entries will be ignored.

Returns:

the list of URLConnectionFactory objects

getResourceLoaders

public List<ResourceLoader> getResourceLoaders()

Return the modifiable list of ResourceLoader objects which will be used to load any resources loaded by Reports created by this factory. The list may be modified to add custom loaders. Null or duplicate entries will be ignored. This method is unlikely to be useful for end users

Returns:

the list of ResourceLoader objects

getURLConnectionProcessors

public List<URLConnectionProcessor> getURLConnectionProcessors()

Return the modifiable list of URLConnectionProcessor objects which will be used to load any resources loaded by Reports created by this factory. The list may be modified to add custom processors. Null or duplicate entries will be ignored.

Returns:

the list of URLConnectionProcessor objects

See Also:

• PasswordAuthenticationURLConnectionProcessor
• SSLURLConnectionProcessor
• CookieStoreURLConnectionProcessor
• OAuth2AuthenticationURLConnectionProcessor
• AWS4AuthenticationURLConnectionProcessor

getReportFactoryExtensions

public List<ReportFactoryExtension> getReportFactoryExtensions()

Return the list of ReportFactoryExtension objects added to this Factory to extend functionality. The returned list can be modified; but cannot have null or duplicate values added (doing so will throw an exception). Adding to or removing an item from the list will automatically call the ReportFactoryExtension.register(org.faceless.publisher.ReportFactory) or ReportFactoryExtension.unregister(org.faceless.publisher.ReportFactory) method on the extension.

Returns:

the list of ReportFactoryExtension objects

getReportFactoryExtension

public <T extends ReportFactoryExtension> T getReportFactoryExtension(Class<T> clazz)

Return the first ReportFactoryExtension in the list returned by getReportFactoryExtensions() that is the specified class, or null if there is no match

Since:

1.3

getSAXParserFactory

public SAXParserFactory getSAXParserFactory()

Return the SAXParserFactory, as set by setSAXParserFactory(javax.xml.parsers.SAXParserFactory)

Returns:

the SAXParserFactory used to create SAX parsers.

See Also:

• setSAXParserFactory(javax.xml.parsers.SAXParserFactory)

getDocumentBuilderFactory

public DocumentBuilderFactory getDocumentBuilderFactory()

Return the DocumentBuilderFactory, as set by setDocumentBuilderFactory(javax.xml.parsers.DocumentBuilderFactory)

Returns:

the DocumentBuilderFactory used to create DocumentBuilders.

See Also:

• setDocumentBuilderFactory(javax.xml.parsers.DocumentBuilderFactory)

getSAXTransformerFactory

public SAXTransformerFactory getSAXTransformerFactory()

Return the SAXTransformerFactory, as set by setSAXTransformerFactory(javax.xml.transform.sax.SAXTransformerFactory)

Returns:

the SAXTransformerFactory used to create SAX parsers, or null if none is available

See Also:

• setSAXTransformerFactory(javax.xml.transform.sax.SAXTransformerFactory)

getXPathFactory

public XPathFactory getXPathFactory()

Return the XPathFactory, as set by setXPathFactory(javax.xml.xpath.XPathFactory)

Returns:

the XPathFactory, or null if none is available

See Also:

• setXPathFactory(javax.xml.xpath.XPathFactory)

setSAXParserFactory

public void setSAXParserFactory(SAXParserFactory factory)

Set the SAXParserFactory to be used by all Reports generated by this ReportFactory. The factory will have flags set on it that reflect the current environment, so any flags that need to be set manually on the factory should be set after this method is called.

Parameters:

factory - the SAXParserFactory to use (must not be null)

setDocumentBuilderFactory

public void setDocumentBuilderFactory(DocumentBuilderFactory factory)

Set the DocumentBuilderFactory to be used by all Reports generated by this ReportFactory. The factory will have flags set on it that reflect the current environment, so any flags that need to be set manually on the factory should be set after this method is called.

Parameters:

factory - the DocumentBuilder to use (must not be null)

setSAXTransformerFactory

public void setSAXTransformerFactory(SAXTransformerFactory factory)

Set the SAXTransformerFactory to be used by all Reports generated by this ReportFactory The factory will have flags set on it that reflect the current environment, so any flags that need to be set manually on the factory should be set after this method is called.

Parameters:

factory - the SAXTransformerFactory to use (must not be null)

setXPathFactory

public void setXPathFactory(XPathFactory factory)

Set the XPathFactory to be used by all Reports generated by this ReportFactory. The factory will have flags set on it that reflect the current environment, so any flags that need to be set manually on the factory should be set after this method is called. XPath is currently only used by the XIncludeExtension

Parameters:

factory - the XPathFactory to use (must not be null)

getResource

public <E> E getResource(URL2 uri,
 MediaType mediaType,
 Class<E> resourceClass)

Load a resource, exactly as it would be loaded by a Report create from this factory. This can be used to load any resources required for pre-processing, for example XSLT stylesheets.

Parameters:

uri - the URL to load from (required)

mediaType - the mediaType to load from, which will be used if the type is not specified. May be null

resourceClass - the type of object that will be returned from this method (required)

Returns:

the resource, which will be of type E, or null if it could not be loaded

setEgressFilter

public void setEgressFilter(EgressFilter filter)

Set the EgressFilter which is used to initialise the same value on any Report objects created by this factory. by this factory. The default value is EgressFilter.DEFAULT which works essentialy as it does for browsers - documents loaded from "http" URLs cannot access the file-system, for example.

Parameters:

filter - the EgressFilter to use, or null to use the default.

getEgressFilter

public EgressFilter getEgressFilter()

Return the EgressFilter, as set by setEgressFilter(org.faceless.publisher.type.EgressFilter)

Returns:

the EgressFilter

getUserStylesheets

public List<URL2> 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.

Returns:

the list of stylesheet URLs

See Also:

• Report.getUserStylesheets()

getUserAgentStylesheets

public List<URL2> 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.

Returns:

the list of stylesheet URLs

See Also:

• Report.getUserAgentStylesheets()

getProcessingInstructions

public List<ProcessingInstruction> getProcessingInstructions()

Return the modifiable List of processing-instructions which is used to initialise the same value on any Report objects created by this factory.

See Also:

• Report.getProcessingInstructions()

setProvider

public void setProvider(Provider provider)

Set the Provider to be used for any signature or encryption operations created by this factory. If set to a not-null value, the Provider will be asked first for any resource, but if it is unable to provide one the default provider will be used as a fallback.

Parameters:

provider - the Provider to use for anything cryptographic, or null to use the default

getProvider

public Provider getProvider()

Return the Provider set by setProvider(java.security.Provider)

Returns:

the Provider

getEnvironment

public Map<String,Object> getEnvironment()

Return the modifiable Map of environment properties which is used to initialise the same value on any Report objects created by this factory.

See Also:

• Report.getEnvironment()

createReport

public Report createReport()

Create a new Report and intialize it to match the settings applied to this factory.

Returns:

a new Report

createReportOutput

public ReportOutput createReportOutput(MediaType mediaType)

Create a new ReportOutput that matches the specified MediaType, or null if that type cannot be generated.

Parameters:

mediaType - the MediaType to target.

Returns:

a new ReportOutput which matches the supplier MediaType, or null if no matching output is known

newXMLReader

public XMLReader newXMLReader(MediaType mediaType,
 Map<String,Object> env)

Return a new XMLReader object for the specified content type. Calling this method is preferred over calling SAXParserFactory.newInstance().newSAXParser(), as a) different factories will be used depending on the content-type, and b) the parser will be initialized to use the shared cache, XInclude handling and other features that would otherwise have to be configured manually.

Parameters:

mediaType - the mediaType we want to create an XMLReader for

env - any environment variables that may influence this (may be null)

setLicenseKey

public static void setLicenseKey(String key)

Set the license key for use with BFO Publisher

Parameters:

key - the key

isLicensed

public static boolean isLicensed()

Return true if BFO Publisher is currently licensed, false if it's running the trial version