Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AboutURLConnectionFactory - Class in org.faceless.publisher.resource
-
A subclass of URLConnection for the "about" scheme
- AboutURLConnectionFactory() - Constructor for class org.faceless.publisher.resource.AboutURLConnectionFactory
- AbstractBlob - Interface in org.faceless.publisher.type
-
An generic "Blob" interface, which represents a resource that may be used by BFO Publisher.
- AbstractHttpSession - Class in org.faceless.publisher.web
-
An abstraction of an HTTP request/response sesssion, such as one corresponding to the HttpServletRequest/Response pair passed inth an HttpServlet.
- AbstractHttpSession() - Constructor for class org.faceless.publisher.web.AbstractHttpSession
- AbstractURLConnectionProcessor - Class in org.faceless.publisher.type
-
A base implementation of
URLConnectionProcessor
that does nothing, but is suitable for extending. - AbstractURLConnectionProcessor() - Constructor for class org.faceless.publisher.type.AbstractURLConnectionProcessor
- AbstractWebsocketSession - Class in org.faceless.publisher.web
-
An abstraction of a Websocket sesssion.
- AbstractWebsocketSession() - Constructor for class org.faceless.publisher.web.AbstractWebsocketSession
- addDataList(String, List<String>) - Method in class org.faceless.publisher.output.pdf.PDFReportOutput
- addDataList(String, List<String>) - Method in interface org.faceless.publisher.output.ReportOutput
- addDataList(String, List<String>) - Method in class org.faceless.publisher.output.svg.SVGReportOutput
- addListener(EventListener) - Method in class org.faceless.publisher.web.ServiceEngine
- addReportEventListener(ReportEventListener) - Method in class org.faceless.publisher.Report
-
Add a listener for one or more events fired on the Report during the parse.
- after(URL2Connection) - Method in class org.faceless.publisher.type.AbstractURLConnectionProcessor
- after(URL2Connection) - Method in class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
- after(URL2Connection) - Method in class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
- after(URL2Connection) - Method in interface org.faceless.publisher.type.URLConnectionProcessor
-
If this processer
matches
, this method is called after the supplied URL connection is made. - AlignmentContext - Interface in org.faceless.publisher.type
-
An object used to determine the used value of an alignment.
- ALLOWALL - Static variable in class org.faceless.publisher.web.Authority
- ALWAYS - Static variable in interface org.faceless.publisher.type.EgressFilter
-
An EgressFilter that allows all URLs, unchanged.
- apply(MailExtension.ParsedMimeMessage, Report) - Method in interface org.faceless.publisher.ext.MailExtension.Configuration
-
Apply the supplied
MailExtension.ParsedMimeMessage
to theReport
. - apply(Report) - Method in interface org.faceless.publisher.ext.ReportConfiguration
-
Apply this configuration to the Report
- apply(FormSignatureResource, FormSignature) - Method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
Sign the signature
- apply(FormSignatureResource, FormSignature) - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
Sign the signature
- apply(FormSignatureResource, FormSignature) - Method in interface org.faceless.publisher.ext.SignatureExtension
-
Sign the signature
- applyBasics(FormSignatureResource, FormSignature) - Static method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
Apply universal properties to the signature.
- applyDefaultsAndOverrides(String, Json) - Method in class org.faceless.publisher.web.Authorization
-
Apply the defaults for this type under the supplied json object, and the overrides over it
- applyTSA(FormSignatureResource, AcrobatSignatureHandlerFactory) - Method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
Apply the time-stamp property "tsa" to the signature
- Authority - Class in org.faceless.publisher.web
-
An Authority authorizes "grants" on a ServiceEngine to be run remotely.
- Authority() - Constructor for class org.faceless.publisher.web.Authority
- Authority(Json) - Constructor for class org.faceless.publisher.web.Authority
- Authorization - Class in org.faceless.publisher.web
-
An Authorization is granted by an Authority in response to an access token.
- Authorization(String, Collection<String>, long, String, Json, Json) - Constructor for class org.faceless.publisher.web.Authorization
-
Create a new Authorization
- Auto - Enum constant in enum class org.faceless.publisher.ext.HtmlNamespaceExtension.Mode
-
Additional namespaces are added to HTML by either the use of the "xmlns" or by mapping known elements to a particular namespace.
- AWS4AuthenticationURLConnectionProcessor - Class in org.faceless.publisher.type
-
A URLConnectionProcessor that supports the AWS4 authentication used by Amazon's S3 storage and compatible systems.
- AWS4AuthenticationURLConnectionProcessor() - Constructor for class org.faceless.publisher.type.AWS4AuthenticationURLConnectionProcessor
-
Create a new AWS4AuthenticationURLConnectionProcessor.
- AWS4AuthenticationURLConnectionProcessor(String, String) - Constructor for class org.faceless.publisher.type.AWS4AuthenticationURLConnectionProcessor
-
Create a new AWS4AuthenticationURLConnectionProcessor.
- AWS4AuthenticationURLConnectionProcessor(CallbackHandler) - Constructor for class org.faceless.publisher.type.AWS4AuthenticationURLConnectionProcessor
-
Create a new AWS4AuthenticationURLConnectionProcessor.
B
- before(URL2Connection) - Method in class org.faceless.publisher.type.AbstractURLConnectionProcessor
- before(URL2Connection) - Method in class org.faceless.publisher.type.AWS4AuthenticationURLConnectionProcessor
- before(URL2Connection) - Method in class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
- before(URL2Connection) - Method in class org.faceless.publisher.type.OAuth2AuthenticationURLConnectionProcessor
- before(URL2Connection) - Method in interface org.faceless.publisher.type.URLConnectionProcessor
-
If this processer
matches
, this method is called before the supplied URL connection is made. - beginAsync() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Begin an "async" sequence - the thread can be freed
- Blob - Class in org.faceless.publisher.type
-
A general purpose blob of data which can be text or binary.
- Blob(Blob, int, int, boolean) - Constructor for class org.faceless.publisher.type.Blob
- Blob(URL2, MediaType, byte[], long) - Constructor for class org.faceless.publisher.type.Blob
- Blob(URL2, MediaType, InputStream, long) - Constructor for class org.faceless.publisher.type.Blob
- Blob(URL2, MediaType, String, long) - Constructor for class org.faceless.publisher.type.Blob
- Blob(URL2, MediaType, ByteBuffer, long) - Constructor for class org.faceless.publisher.type.Blob
- BLOCK - Enum constant in enum class org.faceless.publisher.type.DisplayOutside
-
The element generates a box that is block-level when placed in flow layout.
- byteLength() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return the byte-length of this attachment, or -1 if can't be determined yet
- byteLength() - Method in class org.faceless.publisher.type.Blob
C
- cacheClear() - Method in class org.faceless.publisher.web.ServiceEngine
-
Clear the Resource cache used by the ReportFactory
- CBOR - Static variable in class org.faceless.publisher.web.AbstractWebsocketSession
-
The Media Type for CBOR
- challengeBasic(URL2Connection, Map<String, String>, CallbackHandler) - Method in class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Handle a Basic challenge
- challengeDigest(URL2Connection, Map<String, String>, CallbackHandler) - Method in class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Handle a Digest challenge
- challengeUnknown(URL2Connection, String, Map<String, String>, CallbackHandler) - Method in class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Handle an unrecognised challenge type
- characters(char[], int, int) - Method in class org.faceless.publisher.ext.IndexFilter
- ClasspathConnectionFactory - Class in org.faceless.publisher.resource
-
A subclass of URLConnection for the custom "classpath" scheme, e.g.
- ClasspathConnectionFactory() - Constructor for class org.faceless.publisher.resource.ClasspathConnectionFactory
- clear() - Method in class org.faceless.publisher.web.FileStore
- clear() - Method in interface org.faceless.publisher.web.Store
-
Clear the store of all data
- close(int, String) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Called when the Web Socket connection is closed
- close(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- close(URL2, URL2Connection) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Close the specified URLConnection and free any resources allocated by this factory.
- completeAsync() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Complete an "async" sequence started earlier
- configure(Json) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
-
Configure the FreeMarker extension.
- configure(Json) - Method in class org.faceless.publisher.ext.HtmlNamespaceExtension
- configure(Json) - Method in class org.faceless.publisher.ext.MailExtension
- configure(Json) - Method in class org.faceless.publisher.ext.MailServerExtension
- configure(Json) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Configure the helper with Json
- configure(Json) - Method in interface org.faceless.publisher.ext.ReportFactoryExtension
-
Configure the extension.
- configure(Json) - Method in class org.faceless.publisher.ext.XIncludeExtension
- configure(Json) - Method in class org.faceless.publisher.ext.XsltAttributeExtension
- configure(Json) - Method in class org.faceless.publisher.ext.ZTemplateExtension
-
Configure the ZTemplate Template compiler.
- configure(Json) - Method in class org.faceless.publisher.web.FileStore
- configure(Json) - Method in class org.faceless.publisher.web.ServiceEngine
-
Configure this ServiceEngine.
- configure(Json) - Method in interface org.faceless.publisher.web.Store
- connect() - Method in interface org.faceless.publisher.type.URL2Connection
-
Open the network connection
- connect() - Method in class org.faceless.publisher.type.URL2ConnectionBase
-
"Connect" to the URL.
- connect() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- ContentMathMLExtension - Class in org.faceless.publisher.ext
-
A ReportFactoryExtension which will convert any content MathML to presentation MathML, allowing it to be rendered.
- ContentMathMLExtension() - Constructor for class org.faceless.publisher.ext.ContentMathMLExtension
-
Create a new ContentMathMLContentHandler
- contextDestroyed(ServletContextEvent) - Method in class org.faceless.publisher.web.ServiceEngineServletContextListener
- contextInitialized(ServletContextEvent) - Method in class org.faceless.publisher.web.ServiceEngineServletContextListener
- CookieStoreURLConnectionProcessor - Class in org.faceless.publisher.type
-
A subclass of
URLConnectionProcessor
which can be used to serve, store and persist HTTP Cookies for any HTTP connections made to request resources. - CookieStoreURLConnectionProcessor() - Constructor for class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Create a new
CookieStoreURLConnectionProcessor
with the systemCookieManager
. - CookieStoreURLConnectionProcessor(CookieHandler) - Constructor for class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Create a new
CookieStoreURLConnectionProcessor
with the specifiedCookieManager
- CookieStoreURLConnectionProcessor(Path) - Constructor for class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Create a new
CookieStoreURLConnectionProcessor
with the systemCookieManager
. - copyStream(InputStream, OutputStream) - Static method in class org.faceless.publisher.type.Util
-
Convenient method to copy an InputStream to an OutputStream.
- copyStream(InputStream, OutputStream) - Method in interface org.faceless.publisher.web.Store
- create() - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Create the Json that should be passed in to
MailServerExtension.save()
- create(MediaType, InputStream, Origin) - Static method in class org.faceless.publisher.resource.DataURLConnectionFactory
-
Create a data URI
- create(MediaType, String, Origin) - Static method in class org.faceless.publisher.resource.DataURLConnectionFactory
-
Create a data URI
- createDataURL(Blob) - Static method in class org.faceless.publisher.type.Util
-
Create a "data:" URL from the specified
Blob
- createDataURL(MediaType, InputStream) - Static method in class org.faceless.publisher.type.Util
-
Create a "data:" URL which will be Base-64 encoded.
- createDataURL(MediaType, String) - Static method in class org.faceless.publisher.type.Util
-
Create a "data:" URL
- createEgressFilter(EgressFilter) - Method in class org.faceless.publisher.resource.MemoryURLConnectionFactory
-
Create an EgressFilter that wraps the supplied EgressFilter, but makes exceptions for the URLs retrieved from memory this URLConnectionFactory
- createReport() - Method in class org.faceless.publisher.ReportFactory
-
Create a new
Report
and intialize it to match the settings applied to this factory. - createReportOutput(MediaType) - Method in class org.faceless.publisher.ReportFactory
-
Create a new
ReportOutput
that matches the specifiedMediaType
, or null if that type cannot be generated. - createSelfSignedCertificate(KeyStore, String, String, Map<String, String>) - Static method in class org.faceless.publisher.resource.KeyStoreResourceLoader
-
Create a self-signed entry in the keystore based on the supplied parameters.
- createSelfSignedCertificate(KeyStore, URL2) - Static method in class org.faceless.publisher.resource.KeyStoreResourceLoader
-
Create a self-signed entry in the KeyStore based on the supplied "magic" URL.
- createStore(Json) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Given a Json configuration, connect to the IMAP server it defines and return a URL which can be used to access that Store.
D
- DataURLConnectionFactory - Class in org.faceless.publisher.resource
-
A subclass of URLConnection that can be used to read from "data" URLs.
- DataURLConnectionFactory() - Constructor for class org.faceless.publisher.resource.DataURLConnectionFactory
- DEBUG - Static variable in interface org.faceless.publisher.type.EgressFilter
- DEFAULT - Static variable in interface org.faceless.publisher.type.EgressFilter
-
The default EgressFilter used by BFO Publisher.
- DEFAULT - Static variable in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
A shared SSLURLConnectionProcessor which uses the default SSL context.
- DefaultSignatureExtension - Class in org.faceless.publisher.ext
-
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).
- DefaultSignatureExtension() - Constructor for class org.faceless.publisher.ext.DefaultSignatureExtension
- del(String, Authorization) - Method in class org.faceless.publisher.web.FileStore
- del(String, Authorization) - Method in interface org.faceless.publisher.web.Store
-
Delete from the store.
- DisplayInside - Enum Class in org.faceless.publisher.type
-
An inner display layout model.
- DisplayOutside - Enum Class in org.faceless.publisher.type
-
A value that specifies the element’s outer display type, which is essentially its principal box’s role in flow layout.
- Document.LookaheadState - Enum Class in org.faceless.publisher
- DocXResourceLoader - Class in org.faceless.publisher.ext
-
An experimental top-level ResourceLoader for loading DOCX documents by converting them to first to HTML, for processing with BFO Publisher
- DocXResourceLoader() - Constructor for class org.faceless.publisher.ext.DocXResourceLoader
- done() - Method in interface org.faceless.publisher.LayoutContext
E
- EgressFilter - Interface in org.faceless.publisher.type
-
An interface which can be used to limit access to a resource at a particular URL.
- EgressFilterSequence - Class in org.faceless.publisher.type
-
An implementation of
EgressFilter
which delegates to chain of other filters. - EgressFilterSequence(Collection<EgressFilter>) - Constructor for class org.faceless.publisher.type.EgressFilterSequence
-
Create a new EgressFilter from the supplied sequence
- EgressFilterSequence(EgressFilter...) - Constructor for class org.faceless.publisher.type.EgressFilterSequence
-
Create a new EgressFilter from the supplied sequence
- endDocument() - Method in class org.faceless.publisher.ext.IndexFilter
- endElement(String, String, String) - Method in class org.faceless.publisher.ext.IndexFilter
- EpubResourceLoader - Class in org.faceless.publisher.ext
-
A top-level ResourceLoader for loading EPUB documents by converting them to first to HTML, for processing with BFO Publisher.
- EpubResourceLoader() - Constructor for class org.faceless.publisher.ext.EpubResourceLoader
- equals(Object) - Method in class org.faceless.publisher.type.Language
- equals(Object) - Method in class org.faceless.publisher.type.MediaType
- equals(Object) - Method in class org.faceless.publisher.type.URL2
- equals(Object, Object) - Static method in class org.faceless.publisher.type.Util
F
- FileStore - Class in org.faceless.publisher.web
-
An implementation of
Store
that writes to the file system - FileStore() - Constructor for class org.faceless.publisher.web.FileStore
- FileURLConnectionFactory - Class in org.faceless.publisher.resource
-
A URLConnectionFactory that handles the "jar" and "file" URLs, ie. those handled by Java by default.
- FileURLConnectionFactory() - Constructor for class org.faceless.publisher.resource.FileURLConnectionFactory
- find(String, Authorization) - Method in class org.faceless.publisher.web.ServiceEngine
-
Return an active job, one which is currently queued or running.
- findConfiguration(String) - Static method in class org.faceless.publisher.ext.MailExtension
-
Find a configuration from the list of available configurations that matches the specified name.
- fireReportEvent(ReportEvent) - Method in class org.faceless.publisher.Report
-
Fire a ReportEvent.
- FLEX - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates a principal flex container box and establishes a flex formatting context.
- FLOW - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element lays out its contents using flow layout (block-and-inline layout).
- FLOW_ROOT - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates a block container box, and lays out its contents using flow layout.
- FontDirURLConnectionFactory - Class in org.faceless.publisher.resource
-
A subclass of URLConnection for the "fonts" scheme, which generates a dynamic stylesheet of all fonts matching the specified path.
- FontDirURLConnectionFactory() - Constructor for class org.faceless.publisher.resource.FontDirURLConnectionFactory
- FreeMarkerExtension - Class in org.faceless.publisher.ext
-
An extension to use the Apache FreeMarker template library as a pre-processor to generate the HTML/XML parsed by BFO Publisher.
- FreeMarkerExtension() - Constructor for class org.faceless.publisher.ext.FreeMarkerExtension
-
Create a new FreeMarkerExtension
- FreeMarkerExtension(Configuration) - Constructor for class org.faceless.publisher.ext.FreeMarkerExtension
-
Create a new FreeMarkerExtension
- fromString(String) - Static method in enum class org.faceless.publisher.type.Origin.CrossOrigin
- fromString(String) - Static method in enum class org.faceless.publisher.type.ReferrerPolicy
-
Return the ReferrerPolicy with the specified name, or null if none match
G
- GeneralFontResourceLoader - Class in org.faceless.publisher.output
-
A ResourceLoader for PDFFonts, matching all known "font/*" types.
- GeneralFontResourceLoader() - Constructor for class org.faceless.publisher.output.GeneralFontResourceLoader
- get(String) - Method in class org.faceless.publisher.type.ProcessingInstruction
-
Retrieve a parameter value from this processing-instruction
- get(String, Json, Authorization) - Method in class org.faceless.publisher.web.FileStore
- get(String, Json, Authorization) - Method in interface org.faceless.publisher.web.Store
-
Retrieve a file from the store.
- getAccept() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the "Accept" header that should be sent with this ResourceDescriptor.
- getAcceptLanguage() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the "Accept-Language" header that should be sent with this ResourceDescriptor.
- getAccessControlAllowOrigin() - Method in class org.faceless.publisher.resource.Resource
-
Return the "Access-Control-Allow-Origin" header, which will always be either "*" or a URL origin string (if not set by the server, it will be set to the origin of the requested URL)
- getAccessToken() - Method in class org.faceless.publisher.web.Authorization
-
Return the full access-token, which may be empty but will never be null
- getAccessToken(CallbackHandler) - Method in class org.faceless.publisher.type.OAuth2
-
Return the "access_token" from the
OAuth2.getAuthorization(javax.security.auth.callback.CallbackHandler)
method. - getAttachmentFileName() - Method in class org.faceless.publisher.type.Blob
-
Return the filename as set by setAttachmentFileName
- getAuthorities() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the list of Authority objects used by this ServiceEngine to allow tasks to be run.
- getAuthority() - Method in class org.faceless.publisher.type.URL2
-
Returns the decoded authority component of this URL.
- getAuthorization() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the Autorization derived from the request
- getAuthorization() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return the
Authorization
for this Web Socket connection. - getAuthorization(String, InetAddress) - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the list of authorizations for the specified token.
- getAuthorization(CallbackHandler) - Method in class org.faceless.publisher.type.OAuth2
-
Return the authorization response from the OAuth2 server.
- getAuthURI() - Method in class org.faceless.publisher.type.OAuth2Callback
-
Return the
auth_uri
which the CallbackHandler must load for authorization - getAvailableConfigurations() - Static method in class org.faceless.publisher.ext.MailExtension
-
Return a read-only list the of the available configurations.
- getBase() - Method in class org.faceless.publisher.type.MediaType
-
Return type/subtype
- getBasePattern() - Method in class org.faceless.publisher.type.RegexEgressFilter
-
Return the "base" pattern, which may be null to match everything
- getBaseURL() - Method in class org.faceless.publisher.ReportFactory
-
Return the Base URL as set by
ReportFactory.setBaseURL(org.faceless.publisher.type.URL2)
- getBoxGenerator() - Method in interface org.faceless.publisher.LayoutContext
- getBytes() - Method in class org.faceless.publisher.type.Blob
-
Return a copy of the byte data
- getCacheSize() - Method in class org.faceless.publisher.ReportFactory
-
Return the cache size as set by
ReportFactory.setCacheSize(int)
- getCallbackHandler() - Method in class org.faceless.publisher.Report
-
Return the CallbackHandler, as set by
Report.setCallbackHandler(javax.security.auth.callback.CallbackHandler)
- getCallbackHandler() - Method in class org.faceless.publisher.ReportFactory
-
Return the CallbackHandler, as set by
ReportFactory.setCallbackHandler(javax.security.auth.callback.CallbackHandler)
- getCallbackHandler() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the CallbackHandler set by
URL2Connection.setCallbackHandler(javax.security.auth.callback.CallbackHandler)
- getCallbackHandler() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getCallbackHandler() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getCode() - Method in class org.faceless.publisher.type.OAuth2Callback
-
Return the code set by the
CallbackHandler
- getCode() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the response code, the logic for this will depend on the scheme but which ideally should match HTTP Will trigger a connection
- getCode() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getCode() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getCompressingOutputStream(OutputStream, String) - Static method in class org.faceless.publisher.type.Util
-
Compress the supplied OutputStream
- getConfiguration() - Method in class org.faceless.publisher.ext.FreeMarkerExtension
-
Return the FreeMarker Configuration.
- getConfiguration(Report) - Method in class org.faceless.publisher.ext.MailExtension
-
Return the Configuration for the specified Report - this will check the
bfo-ext-mail
environment
property on the Report (if specified) or the ReportFactory (ifreport
isnull
). - getConnectTimeout() - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Return the connection timeout, as set by
Http1URLConnectionFactory.setConnectTimeout(int)
- getContentHandler() - Method in class org.faceless.publisher.Report
-
Return the ContentHandler which will be used to parse.
- getCookieHandler() - Method in class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Return the
CookieManager
used by this class - getCountry() - Method in class org.faceless.publisher.type.Language
-
Return the country, which may be an empty string but never null
- getCreationDate() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return the creation date of this Blob in milliseconds since the epoch, or 0 if not known.
- getCreationDate() - Method in class org.faceless.publisher.type.Blob
-
Return the creation time as milliseconds since the UNIX Epoch if specified, or 0 otherwise.
- getCrossOrigin() - Method in class org.faceless.publisher.type.Origin
-
Return the "CrossOrigin" field of the origin.
- getCSS() - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Return the URL of the CSS stylesheet applied to any EPUB documents processed with this ResourceLoader.
- getData() - Method in class org.faceless.publisher.type.ProcessingInstruction
-
Return a "data" string representing the encoded parameters returned by
ProcessingInstruction.getParameters()
- getData() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getDefaultCharset() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the default charset
- getDefaults() - Method in class org.faceless.publisher.web.Authority
- getDigest() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return a digest value for this Blob, or
null
if not known. - getEgressFilter() - Method in class org.faceless.publisher.Report
-
Return the egress filter set by
Report.setEgressFilter(org.faceless.publisher.type.EgressFilter)
- getEgressFilter() - Method in class org.faceless.publisher.ReportFactory
-
Return the
EgressFilter
, as set byReportFactory.setEgressFilter(org.faceless.publisher.type.EgressFilter)
- getEgressFilters() - Method in class org.faceless.publisher.type.EgressFilterSequence
-
Return the list of Filters supplied to the constructor
- getEmbeddedFile(String) - Method in class org.faceless.publisher.type.Blob
-
Return a new PDF EmbeddedFile based on the blob;
- getEnvironment() - Method in class org.faceless.publisher.Report
-
Get a map of environment properties that will be set on this Report.
- getEnvironment() - Method in class org.faceless.publisher.ReportFactory
-
Return the modifiable Map of environment properties which is used to initialise the same value on any
Report
objects created by this factory. - getErrorException() - Method in class org.faceless.publisher.resource.Resource
-
Return the Exception that goes with the Error Message, or null if there is no error or if the error does not have an associated Exception
- getErrorMessage() - Method in class org.faceless.publisher.resource.Resource
-
Return the ErrorMessage that was set during the last attempt to load, or null if there is no error.
- getExecutorService() - Method in class org.faceless.publisher.ReportFactory
-
Return the ExecutorService as set by
ReportFactory.setExecutorService(java.util.concurrent.ExecutorService)
- getExpiry(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.FileURLConnectionFactory
- getExpiry(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.FontDirURLConnectionFactory
- getExpiry(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- getExpiry(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.PKCS11ConnectionFactory
- getExpiry(URL2, URL2Connection) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Return the absolute expiry time of the resource reeturned by the specified URLConnection, or Long.MAX_VALUE for forever.
- getExtension(char) - Method in class org.faceless.publisher.type.Language
-
Return the extension matching the specified letter, or null if no such extension exists
- getFragment() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the URL fragment
- getFragment() - Method in class org.faceless.publisher.type.URL2
-
Returns the decoded fragment in this URL, or null if there is no fragment.
- getFragmentParameters() - Method in class org.faceless.publisher.type.URL2
-
Return a Map of the "fragment parameters" for this URL.
- getGlobalSignDSSManager(FormSignatureResource) - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
Get a new GlobalSignDSSManager based on the specified resource
- getGrants() - Method in class org.faceless.publisher.web.Authority
- getHost() - Method in class org.faceless.publisher.type.URL2
-
Returns the host in this URL, or null if there is no host.
- getHostnameVerifier() - Method in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Get the HostnameVerifier, as set by
SSLURLConnectionProcessor.setHostnameVerifier(javax.net.ssl.HostnameVerifier)
- getHttpController() - Method in class org.faceless.publisher.web.ServiceEngine
- getIfModifiedSince() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the "If-Modified-Since" header as a long describing milliseconds since the UNIX epoch, or 0 if not set
- getInputSource() - Method in class org.faceless.publisher.Report
-
Return the InputSource which was set by the
Report.load(java.lang.Object)
method - getInputSource() - Method in class org.faceless.publisher.type.Blob
-
Return a new InputSource based on the character data if the charset is known, or the byte data otherwise.
- getInputStream() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Retun a new
InputStream
to read from this Blob - getInputStream() - Method in class org.faceless.publisher.type.Blob
-
Return a new InputStream for the byte data
- getInputStream() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the InputStream for the response.
- getInputStream() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getInputStream() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getInputStream(BackedZipFile.Entry) - Method in class org.faceless.publisher.resource.ZipURLConnectionFactory
-
Return the InputStream for the specified entry.
- getInstance(String) - Static method in class org.faceless.publisher.type.Language
-
Get a Language that matches the specified text, creating one if necessary
- getInstance(Locale) - Static method in class org.faceless.publisher.type.Language
-
Return a Language that corresponds to the specified Locale
- getISO3Language() - Method in class org.faceless.publisher.type.Language
-
Return the three-letter language code, which may be an empty string but never null
- getItemXSLT() - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Return the URL of the XSLT stylesheet applied to each item in EPUB documents processed with this ResourceLoader.
- getKey() - Method in class org.faceless.publisher.web.Authority
- getKeyManagers() - Method in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Return the list of
KeyManager
s to be searched for identify information (typically an X.509 Client certificate) when opening an SSL connection. - getKeyStoreAuthorization(FormSignatureResource) - Method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
Given the "keystore", "alias", "password", "store-password", "serial", "cn" and "dn" parameters, return a .
- getLanguage() - Method in class org.faceless.publisher.type.Language
-
Return the two-letter (if available) or three-letter (if not) language code
- getLastModified() - Method in class org.faceless.publisher.resource.Resource
-
Return the last-modified time, in ms since the UNIX epoch, or 0 if not known
- getLastModified() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return the modification date of this Blob in milliseconds since the epoch, or 0 if not known.
- getLastModified() - Method in class org.faceless.publisher.type.Blob
-
Return the last-modified time as milliseconds since the UNIX Epoch if specified, or 0 otherwise
- getLastModified() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the "Last-Modified" header as a long describing milliseconds since the UNIX epoch, or 0 if not set
- getLegacyURLConnection() - Method in interface org.faceless.publisher.type.URL2Connection
-
If this instance wraps a
URLConnection
, return that, otherwise return null - getLegacyURLConnection() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getLegacyURLConnection() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getLengthEvaluationContext(float, CSSStyle) - Method in interface org.faceless.publisher.LayoutContext
- getLengthEvaluationContext(Length, CSSStyle) - Method in interface org.faceless.publisher.LayoutContext
- getLinkParameters() - Method in class org.faceless.publisher.resource.ResourceDescriptor
- getLinkParameters() - Method in class org.faceless.publisher.type.URL2
-
Get a value previously set by
#setParameter
- getLinkParametersAsStylesheet(Map<String, List<? extends Term>>) - Static method in class org.faceless.publisher.resource.ResourceDescriptor
- getLoadingThread() - Method in class org.faceless.publisher.resource.Resource
-
If the resource is currently being loaded, return the Thread loading that resource.
- getLocale() - Method in class org.faceless.publisher.type.Language
-
Return the Locale that corresponds to this Language tag
- getMap() - Method in class org.faceless.publisher.ext.HtmlNamespaceExtension
-
Return the map of localname to URI that is used to map namespaces manually.
- getMap() - Method in class org.faceless.publisher.resource.MemoryURLConnectionFactory
-
Return the Map of URLs to {link AbstractBlob} values.
- getMatches() - Method in class org.faceless.publisher.type.AbstractURLConnectionProcessor
-
Return the modifiable list of
Pattern
objects that will be matched against the URL to see if this processor should be applied. - getMatches() - Method in class org.faceless.publisher.web.Authority
- getMaxBufferSize() - Method in class org.faceless.publisher.web.Authority
- getMaxBufferSize() - Method in class org.faceless.publisher.web.Authorization
- getMaxBufferSize() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the maximum buffer size, as set by
ServiceEngine.setMaxBufferSize(long)
- getMaxQueueSize() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the maximum number of tasks that can be queued, as set by
ServiceEngine.setMaxQueueSize(int)
- getMaxThreads() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the maximum number of threads that can be used to execute tasks, as set by
ServiceEngine.setMaxThreads(int)
- getMediaType() - Method in class org.faceless.publisher.output.pdf.PDFReportOutput
- getMediaType() - Method in interface org.faceless.publisher.output.ReportOutput
-
Return the type of object that would be written by
ReportOutput.write(java.io.OutputStream)
, or if that method doesn't apply, the type of Media generated by this ReportOutput. - getMediaType() - Method in class org.faceless.publisher.output.svg.SVGReportOutput
- getMediaType() - Method in class org.faceless.publisher.Report
-
Return the Media-Type as set by
setMediaType()
, or as determined automatically by the parser. - getMediaType() - Method in class org.faceless.publisher.resource.Resource
-
Return the MediaType for the Resource, which will be null until we have attemped to load it for the first time.
- getMediaType() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the MediaType
- getMediaType() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return the
MediaType
of this Blob, or null if not known - getMediaType() - Method in class org.faceless.publisher.type.Blob
-
Return the MediaType, which will be set to WILDCARD if it was given as null;
- getMediaType(String) - Method in class org.faceless.publisher.resource.ZipURLConnectionFactory
-
Return the MediaType of the specified path if known, or null otherwise
- getMessageId() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return the
message_id
field from the last message received, or null if not set. - getMethod() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the method - defaults to "GET"
- getMinimumValidity() - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Return the minimum validity , as set by
Http1URLConnectionFactory.setMinimumValidity(int)
- getMode() - Method in class org.faceless.publisher.ext.HtmlNamespaceExtension
-
Return the mode, as set by
HtmlNamespaceExtension.setMode(org.faceless.publisher.ext.HtmlNamespaceExtension.Mode)
- getName() - Method in class org.faceless.publisher.ext.XsltAttributeExtension
-
Return the namespace of the attribute which specifies the XSLT stylesheet, as set by
XsltAttributeExtension.setAttribute(java.lang.String, java.lang.String)
- getName() - Method in class org.faceless.publisher.web.Authorization
- getNames() - Method in interface org.faceless.publisher.ext.MailExtension.Configuration
-
Return the list of names that this Configuration is known by
- getNamespace() - Method in class org.faceless.publisher.ext.XsltAttributeExtension
-
Return the namespace of the attribute which specifies the XSLT stylesheet, as set by
XsltAttributeExtension.setAttribute(java.lang.String, java.lang.String)
- getNonLegacyJustifyItems() - Method in interface org.faceless.publisher.type.AlignmentContext
- getOAuth2() - Method in class org.faceless.publisher.type.OAuth2Callback
-
Return the OAuth2 object that created this callback
- getObject(ResourceDescriptor, Resource, Report) - Method in interface org.faceless.publisher.resource.ResourceFlavor
-
Return the specified object.
- getOutputClass() - Method in class org.faceless.publisher.resource.ResourceDescriptor
- getOutputHandler() - Method in class org.faceless.publisher.output.svg.SVGReportOutput
-
Return the OutputHandler set by
SVGReportOutput.setOutputHandler(org.faceless.publisher.output.svg.SVGReportOutput.OutputHandler)
. - getOutputStream(int, String) - Method in interface org.faceless.publisher.output.svg.SVGReportOutput.OutputHandler
-
Return the OutputStream to write the SVG to
- getOverrides() - Method in class org.faceless.publisher.web.Authority
- getParameter(String) - Method in class org.faceless.publisher.type.MediaType
-
Return the named parameter, or null if it doesn't exist
- getParameter(FormSignatureResource, String) - Static method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
Return the specified parameter, which will be taken from the support
FormSignatureResource
if present, or the report environment for this type of signature if not. - getParameters() - Method in class org.faceless.publisher.type.MediaType
-
Return a read-only map of the parameters
- getParameters() - Method in class org.faceless.publisher.type.ProcessingInstruction
-
Return an unmodifiable map representing the key/value pairs on this processing-instruction
- getParent() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
-
Get the URL2Connection passed into the constructor
- getParentStyle() - Method in interface org.faceless.publisher.type.AlignmentContext
-
Returns the style of the parent box.
- getPath() - Method in class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Return the path most recently passed into
CookieStoreURLConnectionProcessor.load(java.nio.file.Path)
orCookieStoreURLConnectionProcessor.save(java.nio.file.Path)
- getPath() - Method in class org.faceless.publisher.type.URL2
-
Returns the decoded path of this URL, or null if there is no path.
- getPDF() - Method in class org.faceless.publisher.output.pdf.PDFReportOutput
-
Return the PDF generated by this PDFReportOutput.
- getPendingTasks() - Method in class org.faceless.publisher.web.ServiceEngine
-
Get a list of tasks that are pending, waiting for the ExecutorService
- getPort() - Method in class org.faceless.publisher.type.URL2
-
Returns the port in this URL, or -1 if there is no port.
- getProcessingInstructions() - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Return the list of processing instructions applied to the EPUB documents processed with this ResourceLaoder.
- getProcessingInstructions() - Method in class org.faceless.publisher.Report
-
Return the list of processing instructions to be inserted before the start element of the document.
- getProcessingInstructions() - Method in class org.faceless.publisher.ReportFactory
-
Return the modifiable List of processing-instructions which is used to initialise the same value on any
Report
objects created by this factory. - getProcessingInstructions() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the list of Class objects passed into the constructor
- getProperties() - Method in class org.faceless.publisher.ext.MailServerExtension
-
Return the properties used by this class, as set by
MailServerExtension.setProperties(java.util.Properties)
- getProperties() - Method in class org.faceless.publisher.type.OAuth2Callback
-
Return a map of properties which apply to the session.
- getProvider() - Method in class org.faceless.publisher.ReportFactory
-
Return the Provider set by
ReportFactory.setProvider(java.security.Provider)
- getProxyServers() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the list of IP addresses that will be accepted as valid proxies.
- getQuery() - Method in class org.faceless.publisher.type.URL2
-
Returns the decoded query in this URL, or null if there is no query.
- getQueryParameters() - Method in class org.faceless.publisher.type.URL2
-
Return a Map of the query parameters for this URL, or an empty Map if there are none
- getRandom() - Method in class org.faceless.publisher.ReportFactory
-
Return the
SecureRandom
object as set byReportFactory.setRandom(java.security.SecureRandom)
- getRawSchemeSpecificPart() - Method in class org.faceless.publisher.type.URL2
-
Returns the raw scheme-specific part of this URL, before it has been escape-decoded
- getReader() - Method in class org.faceless.publisher.type.Blob
-
Return a new Reader for the character data, which will be UTF-8 if the charset is not set in the MediaType
- getReadTimeout() - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Return the read timeout, as set by
Http1URLConnectionFactory.setReadTimeout(int)
- getRealmMatches() - Method in class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Return the list of patterns which will be matched to the
Realm
of the password before this password is applied. - getRedirectURI() - Method in class org.faceless.publisher.type.OAuth2Callback
-
Return the
redirect_uri
- getRedirectURL() - Method in class org.faceless.publisher.resource.Resource
-
Return the final URL that was actually used to load the resource, which often be the same as
Resource.getURL()
. - getReferrerPolicy() - Method in class org.faceless.publisher.ReportFactory
- getReferrerPolicy() - Method in class org.faceless.publisher.type.Origin
-
Set the "Referrer Policy" field of the origin.
- getRemoteAddress() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the remote address for the connection
- getRemoteAddress() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return the remote address for the connection if known, or null if it cannot be retrieved
- getReplacement() - Method in class org.faceless.publisher.type.RegexEgressFilter
-
Return the "replace" pattern, or null if the URL is disallowed on match.
- getReport() - Method in class org.faceless.publisher.resource.Resource
-
If this resource is specific to a Document, return the document, otherwise return null
- getReportFactory() - Method in class org.faceless.publisher.Report
-
Return the ReportFactory this Report was created from
- getReportFactory() - Method in class org.faceless.publisher.resource.Resource
-
Return the ReportFactory that owns this resource
- getReportFactory() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the ReportFactory
- getReportFactory() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the ReportFactory used by this ServiceEngine
- getReportFactoryExtension(Class<T>) - Method in class org.faceless.publisher.ReportFactory
-
Return the first
ReportFactoryExtension
in the list returned byReportFactory.getReportFactoryExtensions()
that is the specified class, or null if there is no match - getReportFactoryExtensions() - Method in class org.faceless.publisher.ReportFactory
-
Return the list of
ReportFactoryExtension
objects added to this Factory to extend functionality. - getReportOutput() - Method in interface org.faceless.publisher.LayoutContext
- getReportOutput() - Method in class org.faceless.publisher.Report
-
Return the ReportOutput, as set by
Report.setReportOutput(org.faceless.publisher.output.ReportOutput)
- getRequestDateHeader(String) - Method in interface org.faceless.publisher.type.URL2Connection
-
Return a request header as a Date (if set and a valid date), or null otherwise.
- getRequestDateHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getRequestDateHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getRequestHeader(String) - Method in interface org.faceless.publisher.type.URL2Connection
-
Return a previously-set Request header
- getRequestHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getRequestHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getRequestHeader(String) - Method in class org.faceless.publisher.web.AbstractHttpSession
- getRequestHeaders() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return a modifiable map of the Request headers It's usually preferable to call
URL2Connection.getRequestHeader(java.lang.String)
to retrieve a single header, as that handles case folding. - getRequestHeaders() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getRequestHeaders() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getRequestHeaders() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the full set of request headers
- getRequestInputStream() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return the InputStream for the request, which defaults to null.
- getRequestInputStream() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the InputStream supplied with the POST request, or null otherwise
- getRequestMethod() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the request method
- getRequestParameter(String) - Method in class org.faceless.publisher.web.AbstractHttpSession
- getRequestParameters() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the full set of request parameters.
- getRequestPath() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the full path for the request, relative to the web-application root and beginning with a "/"
- getResource(URL2) - Method in class org.faceless.publisher.Report
-
Retrieve a Resource as it would be seen by this Report.
- getResource(URL2, MediaType, Class<E>) - Method in class org.faceless.publisher.ReportFactory
-
Load a resource, exactly as it would be loaded by a Report create from this factory.
- getResourceCache() - Method in class org.faceless.publisher.ReportFactory
-
Return the cache used by this ReportFactory to cache objects like fonts, images etc. across multiple Reports.
- getResourceClasses() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the list of Class objects passed into the constructor
- getResourceLoaders() - Method in class org.faceless.publisher.ReportFactory
-
Return the modifiable list of
ResourceLoader
objects which will be used to load any resources loaded by Reports created by this factory. - getResponseDateHeader(String) - Method in interface org.faceless.publisher.type.URL2Connection
-
Return a response header as a Date if set and a valid date, or null otherwise.
- getResponseDateHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getResponseDateHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getResponseHeader(String) - Method in interface org.faceless.publisher.type.URL2Connection
-
Return a response header if set, or null otherwise.
- getResponseHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getResponseHeader(String) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getResponseHeaders() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return a modifiable map of the Response headers.
- getResponseHeaders() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getResponseHeaders() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getResponseOutputStream() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the OutputStream for the response
- getRunningTasks() - Method in class org.faceless.publisher.web.ServiceEngine
-
Get a list of tasks that are running currently, waiting for the ExecutorService
- getSAXParserFactory() - Method in class org.faceless.publisher.ReportFactory
-
Return the
SAXParserFactory
, as set byReportFactory.setSAXParserFactory(javax.xml.parsers.SAXParserFactory)
- getSAXTransformerFactory() - Method in class org.faceless.publisher.ReportFactory
- getScheme() - Method in class org.faceless.publisher.type.URL2
-
Returns the scheme of this URL.
- getSchemeSpecificPart() - Method in class org.faceless.publisher.type.URL2
-
Returns the scheme-specific part of this URL.
- getScript() - Method in class org.faceless.publisher.type.Language
-
Return the script, which may be an empty string but never null
- getSearchPattern() - Method in class org.faceless.publisher.type.RegexEgressFilter
-
Return the "uri" pattern
- getSendStream() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return an
OutputStream
to send binary content to the connection - getSendWriter() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return a
Writer
to send text content to the connection - getServiceEngine() - Method in class org.faceless.publisher.web.AbstractHttpSession
- getServiceEngine() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return the
ServiceEngine
referenced by this connection - getSharedGlobalSignDSSManager() - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
Get the factory-wide GlobalSignDSSManager, as set by
GlobalSignSignatureExtension.setSharedGlobalSignDSSManager(GlobalSignDSSManager)
- getSignatureFactory(FormSignatureResource, GlobalSignDSSManager) - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
Return a new SignatureFactory based on the identity specified in the resource.
- getSource() - Method in class org.faceless.publisher.type.Blob
-
Return a new Source based on the character data if a charset is known, or the byte data otherwise.
- getSSLContext(SSLContext) - Method in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Return the modified or replaced SSLContext to use for any SSL network connections.
- getStore() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the Store used by this ServiceEngine
- getStore(URL2) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Return a Store matching the specified URL.
- getString() - Method in class org.faceless.publisher.type.Blob
-
Return the content of this Blob as a String, based on the byte data and the
Blob.getEncoding()
- getStyle() - Method in interface org.faceless.publisher.type.AlignmentContext
-
Returns the style of this box.
- getSubType() - Method in class org.faceless.publisher.type.MediaType
-
Return the subtype, or null for wildcard
- getSystemKeyStore(String) - Static method in class org.faceless.publisher.resource.KeyStoreResourceLoader
-
Return the specified
KeyStore
from the Jar - getTimeout() - Method in class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
-
Get the timeout as set by
OAuth2StandaloneCallbackHandler.setTimeout(long)
- getTrustManagers() - Method in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Return the list of
TrustManager
s to be used to determine whether a SSL connection is trustworthy - getType() - Method in class org.faceless.publisher.type.MediaType
-
Return the type, or null for wildcard
- getType() - Method in class org.faceless.publisher.type.ProcessingInstruction
-
Return the type of this processing-instruction, as set by
ProcessingInstruction.setType(java.lang.String)
- getType() - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Return the type, eg "store", "convert"
- getURL() - Method in class org.faceless.publisher.Report
-
Return the URL as set by
Report.setURL(org.faceless.publisher.type.URL2)
- getURL() - Method in class org.faceless.publisher.resource.Resource
-
Return the URL for the Resource
- getURL() - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return the URL
- getURL() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return the URL2 associated with this Blob, or
null
if unspecified. - getURL() - Method in class org.faceless.publisher.type.Blob
-
Return the URL as set in the constructor, which may be null
- getURL() - Method in class org.faceless.publisher.type.Origin
-
Return the URL2 of the origin.
- getURL() - Method in interface org.faceless.publisher.type.URL2Connection
-
Get the URL.
- getURL() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- getURL() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.AboutURLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.ClasspathConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.DataURLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.FileURLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.FontDirURLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.LocalFontURLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.MemoryURLConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.PKCS11ConnectionFactory
- getURLConnection(URL2, ReportFactory) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Return a URLConnection for the specified URI, or null if not possible with this factory.
- getURLConnection(URL2, ReportFactory) - Method in class org.faceless.publisher.resource.ZipURLConnectionFactory
-
Return a URLConnection for the specified URI, or null if not possible with this factory.
- getURLConnectionFactories() - Method in class org.faceless.publisher.Report
-
Return the list of URLConnectionFactory object which will be used by this Report before the standard ones set on the
ReportFactory.getURLConnectionFactories()
are checked. - getURLConnectionFactories() - Method in class org.faceless.publisher.ReportFactory
-
Return the modifiable list of
URLConnectionFactory
objects which will be used to load any resources loaded by Reports created by this factory. - getURLConnectionProcessors() - Method in class org.faceless.publisher.ReportFactory
-
Return the modifiable list of
URLConnectionProcessor
objects which will be used to load any resources loaded by Reports created by this factory. - getURLConnectionProcessors() - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- getURLConnectionProcessors() - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Return the list of
URLConnectionProcessor
objects that will be run on any network connections that are made by thisURLConnectionFactory
. - getUserAgent() - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Return the "User-Agent" HTTP header, as set by
Http1URLConnectionFactory.setUserAgent(java.lang.String)
- getUserAgentStylesheets() - Method in class org.faceless.publisher.Report
-
Return the list of "user-agent" Stylesheets to add to this Report.
- getUserAgentStylesheets() - Method in class org.faceless.publisher.ReportFactory
-
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. - getUserInfo() - Method in class org.faceless.publisher.type.URL2
-
Returns the decoded userinfo in this URL, or null if there is no userinfo.
- getUserProperty(String) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Retrieve a user-defined property previously set with
putUserProperty()
Multiple threads may be processing multiple messages from a single logical session at once, so implementations must be synchronized and callers must be prepared for this. - getUserStylesheets() - Method in class org.faceless.publisher.Report
-
Return the list of "user" Stylesheets to add to this Report.
- getUserStylesheets() - Method in class org.faceless.publisher.ReportFactory
-
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. - getVariant() - Method in class org.faceless.publisher.type.Language
-
Return the first language variants, which may be an empty string but never null
- getVariants() - Method in class org.faceless.publisher.type.Language
-
Return the unmodifiable list of language variants, which may be an empty list
- getVersion() - Static method in class org.faceless.publisher.ReportFactory
-
Return the BFO Publisher version number, which is set within the Jar
- getVH() - Method in interface org.faceless.publisher.LayoutContext
- getVW() - Method in interface org.faceless.publisher.LayoutContext
- getWebsocketController() - Method in class org.faceless.publisher.web.ServiceEngine
- getXMLReader() - Method in class org.faceless.publisher.Report
-
Return the XMLReader that will be used by the
Report.parse()
method. - getXPathFactory() - Method in class org.faceless.publisher.ReportFactory
-
Return the XPathFactory, as set by
ReportFactory.setXPathFactory(javax.xml.xpath.XPathFactory)
- getXSLT() - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Return the URL of the XSLT stylesheet applied to any EPUB documents processed with this ResourceLoader.
- GlobalSignSignatureExtension - Class in org.faceless.publisher.ext
-
Supports GlobalSign DSS signatures with the "globalsign.dss" or "globalsign.qss" engine.
- GlobalSignSignatureExtension() - Constructor for class org.faceless.publisher.ext.GlobalSignSignatureExtension
- GMailHelper() - Constructor for class org.faceless.publisher.ext.MailServerExtension.GMailHelper
- GRID - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates a principal grid container box, and establishes a grid formatting context.
H
- handle(Callback[]) - Method in class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
- handle(OAuth2Callback) - Method in class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
- hashCode() - Method in class org.faceless.publisher.type.Language
- hashCode() - Method in class org.faceless.publisher.type.MediaType
- hashCode() - Method in class org.faceless.publisher.type.URL2
- hasIntrinsicAspectRatio() - Method in interface org.faceless.publisher.type.AlignmentContext
-
Indicates whether this box has an intrinsic aspect ratio.
- hasParent() - Method in interface org.faceless.publisher.type.AlignmentContext
-
Indicates whether this box has a parent.
- hasPrivateExtension(String) - Method in class org.faceless.publisher.type.Language
-
Return true if this language has the specified private extension
- hasWildcard() - Method in class org.faceless.publisher.type.MediaType
-
Return true if either the type or subtype are undefined
- hex(byte[]) - Static method in class org.faceless.publisher.type.Util
-
Return the byte array as a lowercase hex string
- hex(String) - Static method in class org.faceless.publisher.type.Util
-
Return a byte array from the hex-encoded input
- HtmlAutoDirExtension - Class in org.faceless.publisher.ext
-
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. - HtmlAutoDirExtension() - Constructor for class org.faceless.publisher.ext.HtmlAutoDirExtension
- HtmlNamespaceExtension - Class in org.faceless.publisher.ext
-
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.
- HtmlNamespaceExtension() - Constructor for class org.faceless.publisher.ext.HtmlNamespaceExtension
- HtmlNamespaceExtension.Mode - Enum Class in org.faceless.publisher.ext
-
Determines how namespaces are inferred in HTML.
- Http1URLConnectionFactory - Class in org.faceless.publisher.resource
-
A URLConnectionFactory that handles the "http", "https", "ftp" URLs, ie. those handled by Java by default
- Http1URLConnectionFactory() - Constructor for class org.faceless.publisher.resource.Http1URLConnectionFactory
- HttpController - Class in org.faceless.publisher.web
-
An abstraction of an HTTP interface onto the ServiceEngine.
- HttpController() - Constructor for class org.faceless.publisher.web.HttpController
I
- ImageResourceLoader - Class in org.faceless.publisher.ext
-
A top-level ResourceLoader for loading bitmap images, converting them to HTML for processing with BFO Publisher
- ImageResourceLoader() - Constructor for class org.faceless.publisher.ext.ImageResourceLoader
- Include - Enum constant in enum class org.faceless.publisher.type.Origin.CrossOrigin
- IndexFilter - Class in org.faceless.publisher.ext
-
An XMLFilter which can be specified with "bfo:xslt" on the
about:index
resource to style the generated index as a book index. - IndexFilter() - Constructor for class org.faceless.publisher.ext.IndexFilter
- initialize() - Method in class org.faceless.publisher.web.AbstractHttpSession
- initializeConvert(Json, Authorization) - Method in class org.faceless.publisher.web.ServiceEngine
-
See docs
- INLINE - Enum constant in enum class org.faceless.publisher.type.DisplayOutside
-
The element generates a box that is inline-level when placed in flow layout.
- INSECURE - Static variable in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
A shared SSLURLConnectionProcessor which trusts all certificates presented to it.
- isAbsolute() - Method in class org.faceless.publisher.type.URL2
-
Tells whether or not this URL is absolute.
- isAllowFragments() - Method in class org.faceless.publisher.ext.XIncludeExtension
-
Return the value set in
XIncludeExtension.setAllowFragments(boolean)
- isAuthorized(String...) - Method in class org.faceless.publisher.web.Authorization
-
Check if this Authorization allows all the specified requirements Requirements can be of the form "ws", "admin/pause" - no wildcards.
- isBinary() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return true if the last message received was in CBOR rather than JSON
- isCharsetSpecified() - Method in class org.faceless.publisher.type.Blob
-
Return true if a charset was specified.
- isConnected() - Method in interface org.faceless.publisher.type.URL2Connection
-
Return true if the connection has been made
- isConnected() - Method in class org.faceless.publisher.type.URL2ConnectionBase
- isConnected() - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- isExceptionsAreFatal() - Method in class org.faceless.publisher.ext.XIncludeExtension
-
Return the value set in
XIncludeExtension.setExceptionsAreFatal(boolean)
- isExceptionsAreFatal() - Method in class org.faceless.publisher.ext.XsltAttributeExtension
-
Return the value of the flag set by
XsltAttributeExtension.setExceptionsAreFatal(boolean)
method - isFragmentOnly() - Method in class org.faceless.publisher.type.URL2
-
Return true if this URL is a fragment only
- isLicensed() - Static method in class org.faceless.publisher.ReportFactory
-
Return true if BFO Publisher is currently licensed, false if it's running the trial version
- isLingering() - Method in interface org.faceless.publisher.resource.ResourceFlavor
-
Return true if the connection supplied to the loader to load this flavor should be left to linger.
- isLocal(URL2, URL2) - Method in class org.faceless.publisher.ext.SpiderExtension
-
Return true if a target URL is considered "local" for the base URL, and therefore attachable.
- isOpaque() - Method in class org.faceless.publisher.type.URL2
-
Tells whether or not this URL is opaque.
- isOpen() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Return true if the connection is currently open
- isPageBlank() - Method in class org.faceless.publisher.output.pdf.PDFReportOutput
- isPageBlank() - Method in interface org.faceless.publisher.output.ReportOutput
-
Return true if the current page is blank
- isPageLeft() - Method in interface org.faceless.publisher.LayoutContext
-
Used by PageDependentLogicalParser and FloatProp
- isPaused() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return true if this ServiceEngine is paused.
- isReplaced() - Method in interface org.faceless.publisher.type.AlignmentContext
-
Indicates whether this is a replaced box (a box generated by a replaced element).
- isSameDocument(URL2) - Method in class org.faceless.publisher.type.URL2
-
Return true if this URL is, or is a fragment of the base URL.
- isSchemeFileBased() - Method in class org.faceless.publisher.type.URL2
-
Return whether the URL scheme is a file scheme - not local and not network.
- isSchemeLocal() - Method in class org.faceless.publisher.type.URL2
-
Return whether the URL scheme is "local", which is defined in https://fetch.spec.whatwg.org/#local-schem as "about", "blob" or "data".
- isSchemeNetwork() - Method in class org.faceless.publisher.type.URL2
-
Return whether the URL scheme is a network scheme (currently http, https, ftp) and therefore subject to CORS
- isSchemeSecure() - Method in class org.faceless.publisher.type.URL2
-
Return whether the URL scheme is secured by TLS.
- isSecure() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return the value of the "secure" flag, as set by
ServiceEngine.setSecure(boolean)
- isSingleUse() - Method in interface org.faceless.publisher.resource.ResourceFlavor
-
Return true if this object can only be used once - i.e. it's a stream.
- isThreads() - Method in class org.faceless.publisher.ext.FreeMarkerExtension
-
Return the value set by
AbstractTemplateExtension.setThreads(boolean)
- isThreads() - Method in class org.faceless.publisher.ext.ZTemplateExtension
- isTrusted() - Method in interface org.faceless.publisher.type.AbstractBlob
-
Return true if the data in this blobs should be considered trusted.
- isTrusted(URL2) - Method in class org.faceless.publisher.resource.ClasspathConnectionFactory
- isTrusted(URL2) - Method in class org.faceless.publisher.resource.FileURLConnectionFactory
- isTrusted(URL2) - Method in class org.faceless.publisher.resource.MemoryURLConnectionFactory
- isTrusted(URL2) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Return true if the supplied URL (which will be loadable by this Factory) should be considered trusted.
- isTrustRequired(ResourceDescriptor) - Method in interface org.faceless.publisher.resource.ResourceLoader
-
Return true if this ResourceLoader requires the source URL to be trusted in order to load the specified
ResourceDescriptor
. - isUnchanged(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.FileURLConnectionFactory
- isUnchanged(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.FontDirURLConnectionFactory
- isUnchanged(URL2, URL2Connection) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- isUnchanged(URL2, URL2Connection) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
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.
- isUpdated() - Method in class org.faceless.publisher.type.OAuth2
-
If the OAuth2 configuration supplied in
OAuth2.load(Json)
has been updated with new tokens, since the last time this method was called, return true. - isWarning(int) - Method in class org.faceless.publisher.resource.ResourceDescriptor
- isWildcard() - Method in class org.faceless.publisher.type.MediaType
-
Return true if neither the type nor subtype are defined
- isXMLBased() - Method in class org.faceless.publisher.type.MediaType
-
Return true if the subtype is "xml", or ends in "+xml"
J
- JSON - Static variable in class org.faceless.publisher.web.AbstractWebsocketSession
-
The Media Type for JSON
K
- KeyStoreResourceLoader - Class in org.faceless.publisher.resource
-
A ResourceLoader returning a KeyStore or Certificate.
- KeyStoreResourceLoader() - Constructor for class org.faceless.publisher.resource.KeyStoreResourceLoader
L
- Language - Class in org.faceless.publisher.type
-
Like Locale.Language but useful and fast.
- LayoutContext - Interface in org.faceless.publisher
-
Abstract interface encapsulating the sum total of information needed from the layout module.
- LessStylesheetExtension - Class in org.faceless.publisher.ext
-
The LessStylesheetExtension adds the ability to natively use the "Less" stylesheet format defined at https://lesscss.org.
- LessStylesheetExtension() - Constructor for class org.faceless.publisher.ext.LessStylesheetExtension
- LinkProcessingInstructionExtension - Class in org.faceless.publisher.ext
-
A ReportFactoryExtension that will process any <?
- LinkProcessingInstructionExtension() - Constructor for class org.faceless.publisher.ext.LinkProcessingInstructionExtension
- load() - Method in class org.faceless.publisher.web.AbstractHttpSession
- load(Object) - Method in class org.faceless.publisher.Report
-
Load the input from the specified object.
- load(Object, Report) - Method in class org.faceless.publisher.ext.ZTemplateExtension
-
Attempt to load the specified object into the specified Report.
- load(Object, Report) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
-
Attempt to load the specified object into the specified Report.
- load(Object, Report) - Method in class org.faceless.publisher.ext.MailExtension
- load(Object, Report) - Method in interface org.faceless.publisher.ext.ReportFactoryExtension
-
Attempt to load the specified object into the specified Report.
- load(String, char[]) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Load a configuration from the KeyStore set with
MailServerExtension.setKeyStore(java.nio.file.Path, char[], java.lang.String, java.security.Provider)
and saved withMailServerExtension.save(java.lang.String, char[], Json)
- load(Path) - Method in class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Load the cookies from the netscape/curl format \"cookiejar\" file at the specified path, if it exists
- load(Json) - Method in class org.faceless.publisher.type.OAuth2
-
Load the OAuth2 configuration.
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.DocXResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.EpubResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.ImageResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.LessStylesheetExtension
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.MailExtension
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.ODFResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.ScssStylesheetExtension
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.TextResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.ext.XMLResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.output.GeneralFontResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.output.pdf.PDFAudioResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.output.pdf.PDFImageResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.output.pdf.PDFVideoResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.output.svg.SVGImageResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.resource.KeyStoreResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.resource.PKCS11KeyStoreResourceLoader
- load(ResourceDescriptor, Resource, URL2Connection) - Method in interface org.faceless.publisher.resource.ResourceLoader
-
Attempt to load a Resource from the specified URL2Connection.
- load(ResourceDescriptor, Resource, URL2Connection) - Method in class org.faceless.publisher.resource.UtilityResourceLoader
- loadPEM(KeyStore, Reader, String, Provider) - Static method in class org.faceless.publisher.resource.KeyStoreResourceLoader
-
Given a Reader containing one or more PEM-encoded certificates, private keys etc, load them into the supplied KeyStore
- LocalFontURLConnectionFactory - Class in org.faceless.publisher.resource
-
A subclass of URLConnection for the "font-local" scheme
- LocalFontURLConnectionFactory() - Constructor for class org.faceless.publisher.resource.LocalFontURLConnectionFactory
- log(String, Throwable) - Method in class org.faceless.publisher.web.AbstractHttpSession
- log(String, Throwable) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Log a message
- LOOKAHEAD_DONE - Enum constant in enum class org.faceless.publisher.Document.LookaheadState
- LOOKAHEAD_OFF - Enum constant in enum class org.faceless.publisher.Document.LookaheadState
- LOOKAHEAD_PENDING - Enum constant in enum class org.faceless.publisher.Document.LookaheadState
- LOOKAHEAD_RUNNING - Enum constant in enum class org.faceless.publisher.Document.LookaheadState
M
- MailExtension - Class in org.faceless.publisher.ext
-
Allow the loading of
javax.mail.internet.MimeMessage
Mail messages into the Report. - MailExtension() - Constructor for class org.faceless.publisher.ext.MailExtension
- MailExtension.Configuration - Interface in org.faceless.publisher.ext
-
A Configuration controls how an arbitrary mail message is converted to input that can be used by BFO Publisher.
- MailServerExtension - Class in org.faceless.publisher.ext
-
The MailServerExtension offers a standard way to access email messages, using the "imap" URL schema described in RFC5092.
- MailServerExtension() - Constructor for class org.faceless.publisher.ext.MailServerExtension
- MailServerExtension(ReportFactory) - Constructor for class org.faceless.publisher.ext.MailServerExtension
- MailServerExtension.GMailHelper - Class in org.faceless.publisher.ext
-
A static helper class that allows easy creation of configuration for loading messages from Google Mail
- main(String[]) - Static method in class org.faceless.publisher.ext.IndexFilter
- Manual - Enum constant in enum class org.faceless.publisher.ext.HtmlNamespaceExtension.Mode
-
Additional namespaces are added to HTML by mapping known elements to a particular namespace
- markPage() - Method in class org.faceless.publisher.output.pdf.PDFReportOutput
- markPage() - Method in interface org.faceless.publisher.output.ReportOutput
-
Record that this page is not blank
- matches(String) - Method in class org.faceless.publisher.type.MediaType
-
Return true if this MediaType matches the specified type.
- matches(String, String) - Method in class org.faceless.publisher.type.MediaType
-
Return true if this MediaType matches the specified type/subtype.
- matches(InetAddress) - Method in class org.faceless.publisher.web.Authority
- matches(MediaType) - Method in class org.faceless.publisher.type.MediaType
-
Return true if this MediaType matches the specified type.
- matches(URL2Connection) - Method in class org.faceless.publisher.type.AbstractURLConnectionProcessor
- matches(URL2Connection) - Method in interface org.faceless.publisher.type.URLConnectionProcessor
-
Return true if this URLConnectionProcessor should be called for the specified connection
- MATH - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates a MathML container box and establishes a math formatting context.
- MediaType - Class in org.faceless.publisher.type
-
A simple class representing a Media-Type (aka Content-Type or MIME-Type).
- MediaType(String, String) - Constructor for class org.faceless.publisher.type.MediaType
-
Create a MediaType from the specified parameters
- MEDIATYPE - Static variable in class org.faceless.publisher.ext.LessStylesheetExtension
-
The synthetic MediaType "text/x-stylesheet-less" which is used to identify resources loaded by this ResourceLoader
- MEDIATYPE - Static variable in class org.faceless.publisher.ext.ScssStylesheetExtension
-
The synthetic MediaType "text/x-stylesheet-less" which is used to identify resources loaded by this ResourceLoader
- MemoryURLConnectionFactory - Class in org.faceless.publisher.resource
-
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).
- MemoryURLConnectionFactory() - Constructor for class org.faceless.publisher.resource.MemoryURLConnectionFactory
-
Create a new MemoryURLConnectionFactory
- MemoryURLConnectionFactory(Map<? extends URL2, ? extends AbstractBlob>) - Constructor for class org.faceless.publisher.resource.MemoryURLConnectionFactory
-
Create a new MemoryURLConnectionFactory.
- Microsoft - Enum constant in enum class org.faceless.publisher.resource.ZipURLConnectionFactory.Flavor
-
A Microsoft Office flavoured zip-file using "Open Packaging Conventions" (OPC).
- MOZILLACA - Static variable in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
A shared SSLURLConnectionProcessor which uses the "Mozilla CA Certificates" as its list of trusted certs.
N
- NEVER - Static variable in interface org.faceless.publisher.type.EgressFilter
-
An EgressFilter that allows only potentially trustworthy URLs -
data
,about
and some other schemes used internally by BFO Publisher that are required for normal function. - newFolderName() - Method in interface org.faceless.publisher.web.Store
-
Return a random folder name that doesn't exist
- newParameter(String, String) - Method in class org.faceless.publisher.type.MediaType
-
Set the named parameter in a new copy of this object and return it.
- newTemplateConfiguration(String, String, boolean, URL2) - Static method in class org.faceless.publisher.ext.MailExtension
-
Create a new Configuration that will apply a template (eg ZTemplate or FreeMarker) to the JSON representation of the message
- newType(String, String) - Method in class org.faceless.publisher.type.MediaType
-
Return a new MediaType that is a clone of the current one with a new type/subtype
- newXMLReader(MediaType, Map<String, Object>) - Method in class org.faceless.publisher.ReportFactory
-
Return a new
XMLReader
object for the specified content type. - NOFILES - Static variable in interface org.faceless.publisher.type.EgressFilter
-
An EgressFilter that disallows access to any
file
URL, but is otherwise likeEgressFilter.DEFAULT
- NOLOCAL - Static variable in interface org.faceless.publisher.type.EgressFilter
-
An EgressFilter that disallows access to any local network URL, such as
http://127.0.0.1
,http://192.168.0.1
,http://server.local
,http://server
,http://[::1]
,http://[fd02::1]
orhttp://169.254.0.1
. - None - Enum constant in enum class org.faceless.publisher.ext.HtmlNamespaceExtension.Mode
-
No additional namespaces are added to HTML; it functions as specified
- None - Enum constant in enum class org.faceless.publisher.resource.ZipURLConnectionFactory.Flavor
-
A plain Zip file with no special magic
- None - Enum constant in enum class org.faceless.publisher.type.Origin.CrossOrigin
- NoReferrer - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- NoReferrerWhenDowngrade - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- normalize() - Method in class org.faceless.publisher.type.URL2
-
Return a new URL which is the normalized equivalent of this URL
- NS_BFO - Static variable in class org.faceless.publisher.type.Util
-
The namespace for BFO Publisher: http://bfo.com/ns/publisher
- NS_DC - Static variable in class org.faceless.publisher.type.Util
-
The "dc" namespace for Dublin Core elements: http://purl.org/dc/elements/1.1/
- NS_HTML - Static variable in class org.faceless.publisher.type.Util
-
The namespace for HTML: http://www.w3.org/1999/xhtml
- NS_MATHML - Static variable in class org.faceless.publisher.type.Util
-
The namespace for MathML: http://www.w3.org/1998/Math/MathML
- NS_PDF1 - Static variable in class org.faceless.publisher.type.Util
-
The namespace for all tags used with PDF 1.x: http://iso.org/pdf/ssn
- NS_PDF2 - Static variable in class org.faceless.publisher.type.Util
-
The namespace for all tags used with PDF 2.x: http://iso.org/pdf2/ssn
- NS_RDF - Static variable in class org.faceless.publisher.type.Util
-
The "rdf" namespace for RDF: http://www.w3.org/1999/02/22-rdf-syntax-ns#
- NS_SVG - Static variable in class org.faceless.publisher.type.Util
-
The namespace for SVG: http://www.w3.org/2000/svg
- NS_XI - Static variable in class org.faceless.publisher.type.Util
-
The "xi" namespace for XInclude: http://www.w3.org/2001/XInclude
- NS_XILA - Static variable in class org.faceless.publisher.type.Util
-
The namespace for XInclude 1.1 local attributes: http://www.w3.org/2001/XInclude/local-attributes
- NS_XLINK - Static variable in class org.faceless.publisher.type.Util
-
The "xlink" namespace: http://www.w3.org/1999/xlink
- NS_XML - Static variable in class org.faceless.publisher.type.Util
-
The "xml" namespace (see
XMLConstants.XML_NS_URI
- NS_XMLNS - Static variable in class org.faceless.publisher.type.Util
-
The "xmlns" namespace (see
XMLConstants.XMLNS_ATTRIBUTE_NS_URI
) - NS_XSL - Static variable in class org.faceless.publisher.type.Util
-
The "xsl" namespace for XSLT: http://www.w3.org/1999/XSL/Transform
O
- OAuth2 - Class in org.faceless.publisher.type
-
Represents a single OAuth2 authorization.
- OAuth2() - Constructor for class org.faceless.publisher.type.OAuth2
-
Create a new OAuth2
- OAuth2(Random, CallbackHandler) - Constructor for class org.faceless.publisher.type.OAuth2
-
Create a new OAuth2
- OAuth2AuthenticationURLConnectionProcessor - Class in org.faceless.publisher.type
-
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 resource - OAuth2AuthenticationURLConnectionProcessor(OAuth2) - Constructor for class org.faceless.publisher.type.OAuth2AuthenticationURLConnectionProcessor
-
Create an OAuth2AuthenticationURLConnectionProcessor
- OAuth2Callback - Class in org.faceless.publisher.type
-
The callback which must be populated to complete an OAuth2 transaction.
- OAuth2Callback(OAuth2, String, String, Map<String, String>) - Constructor for class org.faceless.publisher.type.OAuth2Callback
-
Create a new OAuth2Callback
- OAuth2StandaloneCallbackHandler - Class in org.faceless.publisher.type
-
An implementation of
CallbackHandler
that can supportOAuth2Callback
It uses thecom.sun.net.httpserver
package to create a local webserver and then directs the user to that URL to begin the authentication process. - OAuth2StandaloneCallbackHandler() - Constructor for class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
-
Create an OAuth2StandaloneCallbackHandler on the default port
- OAuth2StandaloneCallbackHandler(int) - Constructor for class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
-
Create an OAuth2StandaloneCallbackHandler on the specified port
- OAuth2StandaloneCallbackHandler(String, String, int, String) - Constructor for class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
-
Create an OAuth2StandaloneCallbackHandler on the specified port
- ODFResourceLoader - Class in org.faceless.publisher.ext
-
An experimental top-level ResourceLoader for loading ODF documents, converting them to HTML for processing with BFO Publisher
- ODFResourceLoader() - Constructor for class org.faceless.publisher.ext.ODFResourceLoader
- open() - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Called when the Web Socket connection is opened
- OpenDocument - Enum constant in enum class org.faceless.publisher.resource.ZipURLConnectionFactory.Flavor
-
An OpenDocument flavoured zip-file for all OpenOffice-type documnets, and ePub.
- org.faceless.publisher - package org.faceless.publisher
-
Provides the main classes for BFO Publisher
- org.faceless.publisher.ext - package org.faceless.publisher.ext
-
Contains extensions to BFO Publisher which are used to add functionality
- org.faceless.publisher.output - package org.faceless.publisher.output
-
Provides the base classes for output from BFO Publisher, extended by type-specific subpackages
- org.faceless.publisher.output.pdf - package org.faceless.publisher.output.pdf
-
Provides the classes used to write output to PDF
- org.faceless.publisher.output.svg - package org.faceless.publisher.output.svg
-
Provides the classes used to write output to SVG
- org.faceless.publisher.resource - package org.faceless.publisher.resource
-
Provides the classes and interfaces used for loading external resources
- org.faceless.publisher.type - package org.faceless.publisher.type
-
Contains utility classes and interfaces which are used across BFO Publisher
- org.faceless.publisher.web - package org.faceless.publisher.web
-
Provides the BFO Publisher web service
- Origin - Class in org.faceless.publisher.type
-
Any URL2 has an Origin associated with it, for security filtering.
- Origin - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- Origin(URL2) - Constructor for class org.faceless.publisher.type.Origin
- Origin(URL2, String) - Constructor for class org.faceless.publisher.type.Origin
- Origin(URL2, String, Origin.CrossOrigin, ReferrerPolicy) - Constructor for class org.faceless.publisher.type.Origin
- Origin.CrossOrigin - Enum Class in org.faceless.publisher.type
- OriginWhenCrossOrigin - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
P
- parse() - Method in class org.faceless.publisher.Report
-
Parse the content loaded with
Report.load(java.lang.Object)
. - parse(String) - Static method in class org.faceless.publisher.type.MediaType
-
Returns a Media-Type for this String, or null if it is not well-formed.
- parse(String) - Static method in class org.faceless.publisher.type.URL2
-
Create a URL from the specified String, or return null if it is so invalid it's beyond salvage
- parse(String, boolean) - Static method in class org.faceless.publisher.type.MediaType
-
Returns a Media-Type for this String, or null if it is not well-formed.
- PasswordAuthenticationURLConnectionProcessor - Class in org.faceless.publisher.type
-
A
URLConnectionProcessor
that handles password authentication. - PasswordAuthenticationURLConnectionProcessor() - Constructor for class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Create a new PasswordAuthenticationURLConnectionProcessor that will call the CallbackHandler from
Report.getCallbackHandler()
- PasswordAuthenticationURLConnectionProcessor(String, char[]) - Constructor for class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Create a new PasswordAuthenticationURLConnectionProcessor.
- PasswordAuthenticationURLConnectionProcessor(CallbackHandler) - Constructor for class org.faceless.publisher.type.PasswordAuthenticationURLConnectionProcessor
-
Create a new PasswordAuthenticationURLConnectionProcessor that will call the specified CallbackHandler to retrieve the password.
- pause(Runnable, long) - Method in class org.faceless.publisher.web.ServiceEngine
-
Pause the ServiceEngine.
- PDFAudioResourceLoader - Class in org.faceless.publisher.output.pdf
-
A ResourceLoader for PDFSound, matching the "audio/*" type for a PDFReportOutput.
- PDFAudioResourceLoader() - Constructor for class org.faceless.publisher.output.pdf.PDFAudioResourceLoader
- PDFImageResourceLoader - Class in org.faceless.publisher.output.pdf
-
A ResourceLoader for PDFImages, matching the "image" type for a PDFReportOutput.
- PDFImageResourceLoader() - Constructor for class org.faceless.publisher.output.pdf.PDFImageResourceLoader
- PDFReportOutput - Class in org.faceless.publisher.output.pdf
-
A PDFReportOutput is an implementation of
ReportOutput
that creates a PDF file. - PDFReportOutput() - Constructor for class org.faceless.publisher.output.pdf.PDFReportOutput
- PDFVideoResourceLoader - Class in org.faceless.publisher.output.pdf
-
A ResourceLoader for PDF, matching the "video/*" and "model/u3d" "model/prc" type for a PDFReportOutput.
- PDFVideoResourceLoader() - Constructor for class org.faceless.publisher.output.pdf.PDFVideoResourceLoader
- PENDING - Static variable in interface org.faceless.publisher.web.Store
- PKCS11ConnectionFactory - Class in org.faceless.publisher.resource
-
A URLConnectionFactory that handles the "pkcs11" scheme from
- PKCS11ConnectionFactory() - Constructor for class org.faceless.publisher.resource.PKCS11ConnectionFactory
- PKCS11KeyStoreResourceLoader - Class in org.faceless.publisher.resource
-
A ResourceLoader returning a KeyStore or Certificate.
- PKCS11KeyStoreResourceLoader() - Constructor for class org.faceless.publisher.resource.PKCS11KeyStoreResourceLoader
- prepare(FormSignatureResource) - Method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
If this object returned true from
DefaultSignatureExtension.supports(org.faceless.publisher.type.FormSignatureResource)
, this method is called to prepare the signature. - prepare(FormSignatureResource) - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
If this object returned true from
GlobalSignSignatureExtension.supports(org.faceless.publisher.type.FormSignatureResource)
, this method is called to prepare the signature. - prepare(FormSignatureResource) - Method in interface org.faceless.publisher.ext.SignatureExtension
-
If this object returned true from
SignatureExtension.supports(org.faceless.publisher.type.FormSignatureResource)
, this method is called to prepare the signature. - process(SpiderExtension.State) - Method in class org.faceless.publisher.ext.SpiderExtension
-
Called whenever a hyperlink to an external resource is added to a Report.
- process(AbstractHttpSession) - Method in class org.faceless.publisher.web.HttpController
- ProcessingInstruction - Class in org.faceless.publisher.type
-
Represents a single XML processing-instruction, with a "type" and "data".
- ProcessingInstruction() - Constructor for class org.faceless.publisher.type.ProcessingInstruction
-
Create a new empty processing-instruction
- ProcessingInstruction(String, String) - Constructor for class org.faceless.publisher.type.ProcessingInstruction
-
Create a new processing-instruction
- ProcessingInstruction(ProcessingInstruction) - Constructor for class org.faceless.publisher.type.ProcessingInstruction
-
Create a new empty processing-instruction that is a clone of that supplied
- put(String, String) - Method in class org.faceless.publisher.type.ProcessingInstruction
-
Put a new parameter key/value pair into this processing-instruction
- put(String, Json, Authorization) - Method in class org.faceless.publisher.web.FileStore
- put(String, Json, Authorization) - Method in interface org.faceless.publisher.web.Store
-
Save a file to the store.
- putMediaType(String, MediaType) - Method in class org.faceless.publisher.resource.ZipURLConnectionFactory
-
Add a MediaType mapping for a file that (may be) within this Zip file
- putUserProperty(String, Object) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Store a user-defined property against this Web Socket connection.
R
- readFully(InputStream) - Static method in class org.faceless.publisher.type.Util
-
Convenient method to read an InputStream fully into a byte array.
- receive(InputStream) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Receive a binary message from the
InputStream
, parse it as CBOR and call theWebsocketController.receive()
method with the result. - receive(Reader) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Receive a text message from the
Reader
, parse it as JSON and call theWebsocketController.receive()
method with the result. - receive(AbstractWebsocketSession, Json) - Method in class org.faceless.publisher.web.WebsocketController
- ReferrerPolicy - Enum Class in org.faceless.publisher.type
-
This enum represents the Referrer Policy used by the Document or one of its resources.
- RegexEgressFilter - Class in org.faceless.publisher.type
-
An implementation of
EgressFilter
which works on regluar expressions. - RegexEgressFilter(Pattern, Pattern, String) - Constructor for class org.faceless.publisher.type.RegexEgressFilter
-
Create a new RegexEgressFilter to match against the URL, and the replacement value to use
- register(Report) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
- register(Report) - Method in class org.faceless.publisher.ext.IndexFilter
- register(Report) - Method in interface org.faceless.publisher.ext.ReportFactoryExtension
-
Notify this object it has beem added to a Report.
- register(ReportFactory) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
- register(ReportFactory) - Method in class org.faceless.publisher.ext.LessStylesheetExtension
- register(ReportFactory) - Method in class org.faceless.publisher.ext.MailExtension
- register(ReportFactory) - Method in class org.faceless.publisher.ext.MailServerExtension
- register(ReportFactory) - Method in interface org.faceless.publisher.ext.ReportFactoryExtension
-
Notify this object it has beem added to a ReportFactory.
- register(ReportFactory) - Method in class org.faceless.publisher.ext.ScssStylesheetExtension
- register(ReportFactory) - Method in class org.faceless.publisher.ext.XmlStylesheetExtension
- relativize(URL2, boolean) - Method in class org.faceless.publisher.type.URL2
-
Relativize the supplied URL aginst the current one.
- removeListener(EventListener) - Method in class org.faceless.publisher.web.ServiceEngine
- removeReportEventListener(ReportEventListener) - Method in class org.faceless.publisher.Report
-
Remove a previously added listener
- removeStore(URL2) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Remove a Store matching the specified URL.
- rename(String, String, Authorization) - Method in class org.faceless.publisher.web.FileStore
- rename(String, String, Authorization) - Method in interface org.faceless.publisher.web.Store
-
Rename a file in the store.
- reply(String, boolean, String) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
A convenience method to create a "message" type reply.
- reply(String, boolean, String, Throwable) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
A convenience method to create a "message" type reply
- Report - Class in org.faceless.publisher
-
Represents a single Report, as created by
ReportFactory.createReport()
. - ReportConfiguration - Interface in org.faceless.publisher.ext
-
A ReportConfiguration is a means of configuring a Report object to a predetermined state.
- ReportFactory - Class in org.faceless.publisher
-
A ReportFactory is used to create Report objects.
- ReportFactory() - Constructor for class org.faceless.publisher.ReportFactory
-
Create a new ReportFactory
- ReportFactoryExtension - Interface in org.faceless.publisher.ext
-
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.
- ReportOutput - Interface in org.faceless.publisher.output
-
A ReportOutput is used to render a Report to some sort of Output.
- resolve(String) - Method in class org.faceless.publisher.type.URL2
-
Constructs a new URL by parsing the given string and then resolving it against this URL.
- Resource - Class in org.faceless.publisher.resource
-
A Resource represents an resource such as an HTML page, a stylesheet, an image, a font etc.
- Resource(URL2, ReportFactory) - Constructor for class org.faceless.publisher.resource.Resource
-
Create a new Resource associated with the specified URL
- ResourceDescriptor - Class in org.faceless.publisher.resource
-
Describes a Resource.
- ResourceDescriptor(Class<?>...) - Constructor for class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor
- ResourceDescriptor(ReportFactory, Class<?>...) - Constructor for class org.faceless.publisher.resource.ResourceDescriptor
- ResourceDescriptor(ResourceDescriptor, Class<?>...) - Constructor for class org.faceless.publisher.resource.ResourceDescriptor
- ResourceFlavor - Interface in org.faceless.publisher.resource
-
A
Resource
may have one or more ResourceFlavors - ResourceLoader - Interface in org.faceless.publisher.resource
-
A ResourceLoader loads an Object from a URI
- resume() - Method in class org.faceless.publisher.web.ServiceEngine
-
Resume the ServiceEngine after previously being paused
- rewrite(URL2, URL2) - Method in interface org.faceless.publisher.type.EgressFilter
-
This method will be supplied with the URL about to be loaded, and the base URL of the Document loading it.
- rewrite(URL2, URL2) - Method in class org.faceless.publisher.type.EgressFilterSequence
- rewrite(URL2, URL2) - Method in class org.faceless.publisher.type.RegexEgressFilter
- ROOT - Static variable in class org.faceless.publisher.type.Language
-
The "root" language - all components are empty
- ROOT - Static variable in class org.faceless.publisher.type.Origin
- RUBY - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates a ruby container box and establishes a ruby formatting context in addition to integrating its base-level contents into its parent formatting context (if it is inline) or generating a wrapper box of the appropriate outer display type (if it is not).
- RUN_IN - Enum constant in enum class org.faceless.publisher.type.DisplayOutside
-
The element generates an run-in box, which is a type of inline-level box with special behavior that attempts to merge it into a subsequent block container.
S
- SameOrigin - Enum constant in enum class org.faceless.publisher.type.Origin.CrossOrigin
- SameOrigin - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- save(String, char[], Json) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Save a configuration to the KeyStore set with
MailServerExtension.setKeyStore(java.nio.file.Path, char[], java.lang.String, java.security.Provider)
. - save(Path) - Method in class org.faceless.publisher.type.CookieStoreURLConnectionProcessor
-
Save the cookies from the netscape/curl format \"cookiejar\" file to the specified path, or if path is null, to the path last passed into
CookieStoreURLConnectionProcessor.load(java.nio.file.Path)
orCookieStoreURLConnectionProcessor.save(java.nio.file.Path)
. - schedule(Runnable, long) - Method in class org.faceless.publisher.web.ServiceEngine
-
Schedule a background task to run
- SCHEME - Static variable in class org.faceless.publisher.resource.LocalFontURLConnectionFactory
- scoreAgainstPattern(Language) - Method in class org.faceless.publisher.type.Language
-
Return a score for how well this Language matches the specified Locale, which can be used to determine the best match (higher is better, 0 is no match) This has a strong but not exact relation to BCP47 - once we get to extensions, it differs.
- ScssStylesheetExtension - Class in org.faceless.publisher.ext
-
The ScssStylesheetExtension adds the ability to natively use the "Scss" stylesheet format defined at https://sass-lang.com.
- ScssStylesheetExtension() - Constructor for class org.faceless.publisher.ext.ScssStylesheetExtension
- send(Json) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Send a message as text or binary (depending in the value if
AbstractWebsocketSession.isBinary()
) to the object return fromAbstractWebsocketSession.getSendStream()
orAbstractWebsocketSession.getSendWriter()
as appropriate. - ServiceEngine - Class in org.faceless.publisher.web
-
The core "engine" that drives the Web Service, which has
HttpController
andWebsocketController
interfaces onto it - ServiceEngine() - Constructor for class org.faceless.publisher.web.ServiceEngine
- ServiceEngineServletContextListener - Class in org.faceless.publisher.web
-
When running BFO Publisher under a Java EE Servlet Engine, this is the entry-point that manages the setup for that configuration.
- ServiceEngineServletContextListener() - Constructor for class org.faceless.publisher.web.ServiceEngineServletContextListener
-
Constructor called from larger webserver - we create an engine for the context, and destroy it later
- ServiceEngineServletContextListener(ServiceEngine) - Constructor for class org.faceless.publisher.web.ServiceEngineServletContextListener
-
Constructor called from embedded webserver - we have one engine, once.
- setAllowFragments(boolean) - Method in class org.faceless.publisher.ext.XIncludeExtension
-
As specified the href passed into xi:include does not allow fragments to be specified.
- setAttachmentFileName(String) - Method in class org.faceless.publisher.type.Blob
-
Set the (optional) filename set from the Content-Disposition header
- setAttribute(String, String) - Method in class org.faceless.publisher.ext.XsltAttributeExtension
-
Set the attribute which specifies the XSLT stylesheet to specify.
- setAuthorization(Authorization) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Set the
Authorization
for this Web Socket connection. - setAuthURI(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the "auth_uri" property to a URL
- setBaseURL(URL2) - Method in class org.faceless.publisher.ReportFactory
-
Set the Base URL to resolve any relative URLs passed directly into the
Report
class - specifically this is theReport.load(java.lang.Object)
method anduser
anduser-agent
stylesheet methods. - setCacheSize(int) - Method in class org.faceless.publisher.ReportFactory
-
Set the number of Resources that can be help in the
resource cache
. - setCallbackHandler(CallbackHandler) - Method in class org.faceless.publisher.Report
-
Set the
CallbackHandler
which will be used for authentication by this Reports. - setCallbackHandler(CallbackHandler) - Method in class org.faceless.publisher.ReportFactory
-
Set the
CallbackHandler
which will be used as the default by any Reports created by this ReportFactory. - setCallbackHandler(CallbackHandler) - Method in interface org.faceless.publisher.type.URL2Connection
-
Set the CallbackHandler that should be used for any authorization callbacks required on this connection
- setCallbackHandler(CallbackHandler) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- setCallbackHandler(CallbackHandler) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- setClientId(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the client id, normally of the form "NNNNN.apps.googleusercontent.com"
- setClientSecret(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the client secret
- setCode(String) - Method in class org.faceless.publisher.type.OAuth2Callback
-
Set the code that was given by the authorization process.
- setConfiguration(Configuration) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
-
Set the FreeMarker Configuration.
- setConfiguration(Configuration) - Method in class org.faceless.publisher.ext.ZTemplateExtension
-
Set the Compiler to use for ZTemplate Templates, to override the default (which is
ZTemplate.compiler()
). - setConfiguration(MailExtension.Configuration) - Method in class org.faceless.publisher.ext.MailExtension
-
Set the configuration option for email conversion.
- setConnectTimeout(int) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Set the period in milliseconds after which an attempt to connect to a URL is considered to have failed.
- setContentHandler(ContentHandler) - Method in class org.faceless.publisher.Report
-
Override the ContentHandler that will be used to parse.
- setCreationDate(long) - Method in class org.faceless.publisher.type.Blob
-
Set the (optional) creation date.
- setCSS(URL2) - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Set the URL of the CSS stylesheet applied to any EPUB documents processed with this ResourceLoader
- setEgressFilter(EgressFilter) - Method in class org.faceless.publisher.Report
-
Set the EgressFilter to use for resources loaded by this Document.
- setEgressFilter(EgressFilter) - Method in class org.faceless.publisher.ReportFactory
-
Set the
EgressFilter
which is used to initialise the same value on anyReport
objects created by this factory. - setEmail(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the email account
- setExceptionsAreFatal(boolean) - Method in class org.faceless.publisher.ext.XIncludeExtension
-
Set whether exceptions encountered during XInclude processing are fatal, or just lead to the document being processed without the included file The default is true
- setExceptionsAreFatal(boolean) - Method in class org.faceless.publisher.ext.XsltAttributeExtension
-
Determine whether any XSLT exceptions are considered fatal - for example, missing or invalid XSL stylesheets.
- setExecutorService(ExecutorService) - Method in class org.faceless.publisher.ReportFactory
-
Set the
ExecutorService
to be used for any tasks run in separate threads during the parsing process, such as retrieval of network resources. - setFragment(String) - Method in class org.faceless.publisher.type.URL2
-
Set the fragment on this URL
- setFragmentParameters(Map<String, List<String>>) - Method in class org.faceless.publisher.type.URL2
-
Set the Fragment to be the supplied set of fragment parameters
- setGrants(Collection<String>) - Method in class org.faceless.publisher.web.Authority
- setHostnameVerifier(HostnameVerifier) - Method in class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Set the HostnameVerifier.
- setInputStream(InputStream) - Method in class org.faceless.publisher.type.URL2ConnectionBase
-
Set the InputStream to return from
URL2ConnectionBase.getInputStream()
, overriding the parameter passed into the constructor - setItemXSLT(URL2) - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Set the URL of the XSLT stylesheet applied to each item included in any EPUB documents processed with this ResourceLoader.
- setKey(Key) - Method in class org.faceless.publisher.web.Authority
- setKeyStore(Path, char[], String, Provider) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Set the KeyStore to be used with the
MailServerExtension.load(java.lang.String, char[])
andMailServerExtension.save(java.lang.String, char[], Json)
methods - setKeyStore(KeyStore) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Set the KeyStore to be used with the
MailServerExtension.load(java.lang.String, char[])
andMailServerExtension.save(java.lang.String, char[], Json)
methods - setLicenseKey(String) - Static method in class org.faceless.publisher.ReportFactory
-
Set the license key for use with BFO Publisher
- setMaxBufferSize(long) - Method in class org.faceless.publisher.web.Authority
- setMaxBufferSize(long) - Method in class org.faceless.publisher.web.ServiceEngine
-
Set the maximum amount of data that can be uploaded.
- setMaxQueueSize(int) - Method in class org.faceless.publisher.web.ServiceEngine
-
Set the maximum number of tasks that can be queued waiting for an executor.
- setMaxThreads(int) - Method in class org.faceless.publisher.web.ServiceEngine
-
Set the maximum number of threads that can be used to execute tasks
- setMediaType(MediaType) - Method in class org.faceless.publisher.Report
-
Set the Media-Type of the content.
- setMinimumValidity(int) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Set the minimum period for which an HTTP/HTTPS resource is considered valid.
- setMode(HtmlNamespaceExtension.Mode) - Method in class org.faceless.publisher.ext.HtmlNamespaceExtension
-
Set the
HtmlNamespaceExtension.Mode
in which namespaces on Html elements are determined - setOutputHandler(SVGReportOutput.OutputHandler) - Method in class org.faceless.publisher.output.svg.SVGReportOutput
-
Set an
SVGReportOutput.OutputHandler
for this SVGOutputStream. - setProperties(Properties) - Method in class org.faceless.publisher.ext.MailServerExtension
-
Set the set of properties to be used with this class.
- setProvider(Provider) - Method in class org.faceless.publisher.ReportFactory
-
Set the
Provider
to be used for any signature or encryption operations created by this factory. - setQuery(String) - Method in class org.faceless.publisher.type.URL2
-
Set the query on this URL
- setRandom(SecureRandom) - Method in class org.faceless.publisher.ReportFactory
-
Set the
SecureRandom
object to be used for any random numbers required during parsing - this is used mainly for network requests for resources. - setReadTimeout(int) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Set the period in milliseconds after which an attempt to read from a URL is considered to have failed.
- setRedirectURI(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the "redirect_uri" property to a URL
- setReferrerPolicy(ReferrerPolicy) - Method in class org.faceless.publisher.Report
-
Set the "Referrer Policy" for the document.
- setReferrerPolicy(ReferrerPolicy) - Method in class org.faceless.publisher.ReportFactory
-
Set the
ReferrerPolicy
which is used to initialise the same value on anyReport
objects created by this factory. - setReportOutput(ReportOutput) - Method in interface org.faceless.publisher.LayoutContext
- setReportOutput(ReportOutput) - Method in class org.faceless.publisher.Report
-
Set the ReportOutput to render the Report to
- setRequestDateHeader(String, Date) - Method in interface org.faceless.publisher.type.URL2Connection
-
Set a request header as a Date.
- setRequestDateHeader(String, Date) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- setRequestDateHeader(String, Date) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- setRequestHeader(String, String) - Method in interface org.faceless.publisher.type.URL2Connection
-
Set a request header.
- setRequestHeader(String, String) - Method in class org.faceless.publisher.type.URL2ConnectionBase
- setRequestHeader(String, String) - Method in class org.faceless.publisher.type.URL2ConnectionWrapper
- setResponseCode(int) - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Set the code for the response
- setResponseDateHeader(String, long) - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Set a header for the response
- setResponseDateHeader(String, Date) - Method in class org.faceless.publisher.type.URL2ConnectionBase
-
Set a response header as a Date.
- setResponseHeader(String, String) - Method in class org.faceless.publisher.type.URL2ConnectionBase
-
Set a response header.
- setResponseHeader(String, String) - Method in class org.faceless.publisher.web.AbstractHttpSession
-
Set a header for the response
- setSAXParserFactory(SAXParserFactory) - Method in class org.faceless.publisher.ReportFactory
-
Set the
SAXParserFactory
to be used by all Reports generated by this ReportFactory - setSAXTransformerFactory(SAXTransformerFactory) - Method in class org.faceless.publisher.ReportFactory
-
Set the
SAXTransformerFactory
to be used by all Reports generated by this ReportFactory - setScope(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the Scope
- setSecure(boolean) - Method in class org.faceless.publisher.web.ServiceEngine
-
This method should be called to enable options which would allow various actions (such as allowing access to the filesystem) which would be insecure if they were left unrestricted.
- setSend404(boolean) - Method in class org.faceless.publisher.web.HttpController
- setServiceEngine(ServiceEngine) - Method in class org.faceless.publisher.web.FileStore
- setServiceEngine(ServiceEngine) - Method in interface org.faceless.publisher.web.Store
-
Set the ServiceEngine on this store.
- setSharedGlobalSignDSSManager(GlobalSignDSSManager) - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
Set the factory-wide GlobalSignDSSManager.
- setStandaloneWebServer(StandaloneWebServer) - Method in class org.faceless.publisher.web.ServiceEngine
-
Set the StandaloneWebServer that will be running this ServiceEngine.
- setStore(Store) - Method in class org.faceless.publisher.web.ServiceEngine
-
Set the Store on this object and call
Store.setServiceEngine(org.faceless.publisher.web.ServiceEngine)
on the new object. - setThreads(boolean) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
-
Set whether to use two threads when converting the Template.
- setTimeout(long) - Method in class org.faceless.publisher.type.OAuth2StandaloneCallbackHandler
-
Set the timeout to wait for a response
- setTokenURI(String) - Method in class org.faceless.publisher.ext.MailServerExtension.GMailHelper
-
Set the "token_uri" property to a URL
- setType(String) - Method in class org.faceless.publisher.type.ProcessingInstruction
-
Set the type of this processing-instruction
- setURL(URL2) - Method in class org.faceless.publisher.Report
-
Set the URL which this Report will be loaded from in
Report.load(java.lang.Object)
. - setURL(URL2) - Method in class org.faceless.publisher.type.URL2ConnectionBase
-
Set the URL, overriding the parameter passed into the constructor
- setURLConnectionProcessors(List<URLConnectionProcessor>) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- setURLConnectionProcessors(List<URLConnectionProcessor>) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Set the list of
URLConnectionProcessor
objects that will be run on any network connections that are made by thisURLConnectionFactory
- setUserAgent(String) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
-
Set the "User-Agent" HTTP header, or null to use the system default.
- setUserInfo(String) - Method in class org.faceless.publisher.type.URL2
-
Set the userInfo on this URL
- setXMLReader(SAXParser) - Method in class org.faceless.publisher.Report
-
Set the XMLReader to use when parsing the input set by
Report.load(java.lang.Object)
. - setXMLReader(XMLReader) - Method in class org.faceless.publisher.Report
-
Set the XMLReader to use when parsing the input set by
Report.load(java.lang.Object)
. - setXPathFactory(XPathFactory) - Method in class org.faceless.publisher.ReportFactory
-
Set the
XPathFactory
to be used by all Reports generated by this ReportFactory. - setXSLT(URL2) - Method in class org.faceless.publisher.ext.EpubResourceLoader
-
Set the URL of the XSLT stylesheet applied to any EPUB documents processed with this ResourceLoader
- shutdown() - Method in class org.faceless.publisher.web.FileStore
- shutdown() - Method in class org.faceless.publisher.web.ServiceEngine
-
Shutdown the ServiceEngine
- shutdown() - Method in interface org.faceless.publisher.web.Store
-
Prepare the Store for the ServiceEngine being shutdown
- SignatureExtension - Interface in org.faceless.publisher.ext
-
A subtype of ReportFactoryExtension that should be implemented to add support for particular types of digital signature
- sniff(InputStream, URL2) - Static method in class org.faceless.publisher.type.Sniffer
-
Given a mark-capable InputStream, attempt to guess the MediaType.
- sniff(Path) - Static method in class org.faceless.publisher.type.Sniffer
-
Given a file at the specified path, sniff the file-type
- Sniffer - Class in org.faceless.publisher.type
-
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
- SpiderExtension - Class in org.faceless.publisher.ext
-
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.
- SpiderExtension() - Constructor for class org.faceless.publisher.ext.SpiderExtension
- SSLURLConnectionProcessor - Class in org.faceless.publisher.type
-
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.
- SSLURLConnectionProcessor() - Constructor for class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Create a new SSLURLConnectionProcessor which does nothing.
- SSLURLConnectionProcessor(KeyStore, KeyStore, char[], Provider) - Constructor for class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Create a new SSLURLConnectionProcessor
- SSLURLConnectionProcessor(URL2, URL2, char[], ReportFactory) - Constructor for class org.faceless.publisher.type.SSLURLConnectionProcessor
-
Create a new SSLURLConnectionProcessor
- SSMLExtension - Class in org.faceless.publisher.ext
-
An XML filter that will expand the "single attribute" values used with SSML to their expanded versions, which are used by the PDF output
- SSMLExtension() - Constructor for class org.faceless.publisher.ext.SSMLExtension
- startElement(String, String, String, Attributes) - Method in class org.faceless.publisher.ext.IndexFilter
- Store - Interface in org.faceless.publisher.web
-
An interface representing an abstract store, eg a FileSystem, which is used to store and retrieve files
- StrictOrigin - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- StrictOriginWhenCrossOrigin - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.DocXResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.EpubResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.ImageResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.LessStylesheetExtension
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.MailExtension
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.ODFResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.ScssStylesheetExtension
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.TextResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.ext.XMLResourceLoader
-
This class can create ReportConfiguration objects from xml, html and svg input.
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.output.GeneralFontResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.output.pdf.PDFAudioResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.output.pdf.PDFImageResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.output.pdf.PDFVideoResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.output.svg.SVGImageResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.resource.KeyStoreResourceLoader
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.resource.PKCS11KeyStoreResourceLoader
- supports(ResourceDescriptor) - Method in interface org.faceless.publisher.resource.ResourceFlavor
-
Return true if this ResourceDescriptor can return an object of the specified type.
- supports(ResourceDescriptor) - Method in interface org.faceless.publisher.resource.ResourceLoader
-
Return true if this ResourceLoader could load a descriptor of the specified type.
- supports(ResourceDescriptor) - Method in class org.faceless.publisher.resource.UtilityResourceLoader
- supports(FormSignatureResource) - Method in class org.faceless.publisher.ext.DefaultSignatureExtension
-
Return true if this SignatureExtension supports the specified Signature type.
- supports(FormSignatureResource) - Method in class org.faceless.publisher.ext.GlobalSignSignatureExtension
-
Return true if this SignatureExtension supports the specified Signature type.
- supports(FormSignatureResource) - Method in interface org.faceless.publisher.ext.SignatureExtension
-
Return true if this SignatureExtension supports the specified Signature type.
- supports(URL2) - Method in class org.faceless.publisher.resource.AboutURLConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.ClasspathConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.DataURLConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.FileURLConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.FontDirURLConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.LocalFontURLConnectionFactory
- supports(URL2) - Method in class org.faceless.publisher.resource.MemoryURLConnectionFactory
-
Return true if this URLConnectionFactory supports the specified URL.
- supports(URL2) - Method in class org.faceless.publisher.resource.PKCS11ConnectionFactory
- supports(URL2) - Method in interface org.faceless.publisher.resource.URLConnectionFactory
-
Return true if this factory can load the specified URI schema (eg http, ftp, jar, jdbc)
- supports(URL2) - Method in class org.faceless.publisher.resource.ZipURLConnectionFactory
-
Return true if this factory can load the specified URI schema (eg http, ftp, jar, jdbc)
- SVG - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates an SVG container box and establishes an SVG formatting context.
- SVGImageResourceLoader - Class in org.faceless.publisher.output.svg
-
A
ResourceLoader
to load SVG images - SVGImageResourceLoader() - Constructor for class org.faceless.publisher.output.svg.SVGImageResourceLoader
- SVGReportOutput - Class in org.faceless.publisher.output.svg
-
A ReportOutput that writes the output to one or more SVG files.
- SVGReportOutput() - Constructor for class org.faceless.publisher.output.svg.SVGReportOutput
- SVGReportOutput.OutputHandler - Interface in org.faceless.publisher.output.svg
-
An interface which can be set on an
SVGReportOutput
to control where the individual pages are written. - systemError(Throwable) - Method in class org.faceless.publisher.web.AbstractWebsocketSession
-
Called to log a "system-error"
T
- TABLE - Enum constant in enum class org.faceless.publisher.type.DisplayInside
-
The element generates a principal table wrapper box that establishes a block formatting context, and which contains an additionally-generated table grid box that establishes a table formatting context.
- TextResourceLoader - Class in org.faceless.publisher.ext
-
A top-level ResourceLoader for loading text/plain documents, converting them to HTML for processing with BFO Publisher
- TextResourceLoader() - Constructor for class org.faceless.publisher.ext.TextResourceLoader
- toOriginString() - Method in class org.faceless.publisher.type.URL2
-
Return the "origin" version of this URL; just the scheme, host and port.
- toPublicString() - Method in class org.faceless.publisher.type.URL2
-
Return the same value as
URL2.toString()
, but with any password value in the userinfo string replaced with asterisks - toString() - Method in class org.faceless.publisher.output.GeneralFontResourceLoader
- toString() - Method in class org.faceless.publisher.output.pdf.PDFAudioResourceLoader
- toString() - Method in class org.faceless.publisher.output.pdf.PDFImageResourceLoader
- toString() - Method in class org.faceless.publisher.output.pdf.PDFVideoResourceLoader
- toString() - Method in class org.faceless.publisher.resource.AboutURLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.ClasspathConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.DataURLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.FileURLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.FontDirURLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.Http1URLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.KeyStoreResourceLoader
- toString() - Method in class org.faceless.publisher.resource.LocalFontURLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.MemoryURLConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.PKCS11ConnectionFactory
- toString() - Method in class org.faceless.publisher.resource.PKCS11KeyStoreResourceLoader
- toString() - Method in class org.faceless.publisher.resource.ResourceDescriptor
- toString() - Method in class org.faceless.publisher.resource.UtilityResourceLoader
- toString() - Method in class org.faceless.publisher.type.Blob
- toString() - Method in class org.faceless.publisher.type.EgressFilterSequence
- toString() - Method in class org.faceless.publisher.type.Language
- toString() - Method in class org.faceless.publisher.type.MediaType
- toString() - Method in class org.faceless.publisher.type.Origin
- toString() - Method in class org.faceless.publisher.type.ProcessingInstruction
- toString() - Method in enum class org.faceless.publisher.type.ReferrerPolicy
- toString() - Method in class org.faceless.publisher.type.RegexEgressFilter
- toString() - Method in class org.faceless.publisher.type.URL2
- toString() - Method in class org.faceless.publisher.web.Authority
- toString() - Method in class org.faceless.publisher.web.Authorization
- toString() - Method in class org.faceless.publisher.web.FileStore
- toString() - Method in class org.faceless.publisher.web.ServiceEngine
-
Return a String value representing this ServiceEngine.
- toString(boolean) - Method in class org.faceless.publisher.web.ServiceEngine
-
Return a String value representing this ServiceEngine
- toString(Object) - Static method in class org.faceless.publisher.type.Util
-
A toString() method that improves on the original where possible
- toURI() - Method in class org.faceless.publisher.type.URL2
-
Convert this URL2 to a
URI
, or return null if it is not possible. - toURL() - Method in class org.faceless.publisher.type.URL2
-
Convert this URL2 to a
URL
. - transform(InputStream, Appendable) - Static method in class org.faceless.publisher.ext.IndexFilter
-
A convenience method to convert the supplied input XML into the generated output XML via an IndexFilter.
- TYPE - Static variable in class org.faceless.publisher.output.GeneralFontResourceLoader
U
- UNAUTHORIZED - Static variable in class org.faceless.publisher.web.Authorization
-
An Authorization that disallows everything
- unregister(Report) - Method in class org.faceless.publisher.ext.IndexFilter
- unregister(Report) - Method in interface org.faceless.publisher.ext.ReportFactoryExtension
-
Notify this object when the Report it was registered on has completed parsing.
- unregister(Report) - Method in class org.faceless.publisher.ext.SpiderExtension
- unregister(ReportFactory) - Method in class org.faceless.publisher.ext.FreeMarkerExtension
- unregister(ReportFactory) - Method in class org.faceless.publisher.ext.LessStylesheetExtension
- unregister(ReportFactory) - Method in class org.faceless.publisher.ext.MailExtension
- unregister(ReportFactory) - Method in class org.faceless.publisher.ext.MailServerExtension
- unregister(ReportFactory) - Method in interface org.faceless.publisher.ext.ReportFactoryExtension
-
Notify this object it has been removed from a ReportFactory.
- unregister(ReportFactory) - Method in class org.faceless.publisher.ext.ScssStylesheetExtension
- unregister(ReportFactory) - Method in class org.faceless.publisher.ext.XmlStylesheetExtension
- UnsafeURL - Enum constant in enum class org.faceless.publisher.type.ReferrerPolicy
- URL2 - Class in org.faceless.publisher.type
-
A replacement for the
URI
class that always try to parse the URI and not throw a URISyntaxException, ever. - URL2(String, String, String, int, String, String, String) - Constructor for class org.faceless.publisher.type.URL2
-
Create a URL from the specified parameters All parameters are supplied unescaped.
- URL2(String, String, String, String) - Constructor for class org.faceless.publisher.type.URL2
-
Create an opaque URL from the specified parameters All parameters are supplied unescaped.
- URL2(URI) - Constructor for class org.faceless.publisher.type.URL2
-
Create a new URL2 that is a clone of the supplied URI
- URL2(URL) - Constructor for class org.faceless.publisher.type.URL2
-
Create a new URL2 that is a clone of the supplied URL
- URL2(URL2) - Constructor for class org.faceless.publisher.type.URL2
-
Create a new URL2 that is a clone of the supplied value
- URL2Connection - Interface in org.faceless.publisher.type
-
An interface which is analogous to the awful
URLConnection
but designed for implementation and extension - URL2ConnectionBase - Class in org.faceless.publisher.type
-
A base class implementing an instance of
URL2Connection
- URL2ConnectionBase(int, URL2, InputStream) - Constructor for class org.faceless.publisher.type.URL2ConnectionBase
-
Create a URL2Connection with no headers and which will return the specified InputStream when
URL2ConnectionBase.getInputStream()
is called - URL2ConnectionBase(URL2, URLConnection) - Constructor for class org.faceless.publisher.type.URL2ConnectionBase
-
Create a URL2Connection which will wrap the specified
URLConnection
- URL2ConnectionWrapper - Class in org.faceless.publisher.type
-
A URL2Connection that wraps another URL2Connection, for filtering
- URL2ConnectionWrapper(URL2Connection) - Constructor for class org.faceless.publisher.type.URL2ConnectionWrapper
-
Create a URL2ConnectionWrapper
- URLConnectionFactory - Interface in org.faceless.publisher.resource
-
The URLConnectionFactory interface defines a method of requesting and loading content from a particular type of URL.
- URLConnectionProcessor - Interface in org.faceless.publisher.type
-
A URLConnectionProcessor can be applied to any
URL2Connection
to modify it either before or after connection is made. - Util - Class in org.faceless.publisher.type
-
A collection of static Utility methods
- UtilityResourceLoader - Class in org.faceless.publisher.resource
-
A ResourceLoader that handles many basic types.
- UtilityResourceLoader() - Constructor for class org.faceless.publisher.resource.UtilityResourceLoader
V
- valueOf(String) - Static method in enum class org.faceless.publisher.Document.LookaheadState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.faceless.publisher.ext.HtmlNamespaceExtension.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.faceless.publisher.resource.ZipURLConnectionFactory.Flavor
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.faceless.publisher.type.DisplayInside
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.faceless.publisher.type.DisplayOutside
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.faceless.publisher.type.Origin.CrossOrigin
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.faceless.publisher.type.ReferrerPolicy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.faceless.publisher.Document.LookaheadState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.faceless.publisher.ext.HtmlNamespaceExtension.Mode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.faceless.publisher.resource.ZipURLConnectionFactory.Flavor
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.faceless.publisher.type.DisplayInside
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.faceless.publisher.type.DisplayOutside
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.faceless.publisher.type.Origin.CrossOrigin
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.faceless.publisher.type.ReferrerPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WebsocketController - Class in org.faceless.publisher.web
-
A Websocket-based means of controlling the Webserver.
- WebsocketController() - Constructor for class org.faceless.publisher.web.WebsocketController
- WILDCARD - Static variable in class org.faceless.publisher.type.MediaType
-
The wildcard MediaType */*
- withAccept(String) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor that is this one with the specified "accept" header
- withAcceptLanguage(String) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor that is this one with the specified "accept-language" header
- withDefaultCharset(String) - Method in class org.faceless.publisher.resource.ResourceDescriptor
- withDocument(Document) - Method in class org.faceless.publisher.resource.ResourceDescriptor
- withLinkParameters(Map<String, List<? extends Term>>) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor that is this one with the specified linked params
- withMediaType(MediaType) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor that is this one with the specified MediaType
- withOutputClass(Class<? extends ReportOutput>) - Method in class org.faceless.publisher.resource.ResourceDescriptor
- withoutWarning(int) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor that is this one with the specified warning disabled
- withProcessingInstructions(List<ProcessingInstruction>) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Create a new ResourceDescriptor that is this one with the specified list of document Processing Instructions
- withURL(URL2) - Method in class org.faceless.publisher.resource.ResourceDescriptor
- wouldAccept(Class<?>...) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return true if this ResourceDescriptor would accept a resource of the specified class
- wouldAcceptObject(Object) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return true if this ResourceDescriptor would accept the specified Object
- wouldBeAcceptedBy(Class<?>...) - Method in class org.faceless.publisher.resource.ResourceDescriptor
-
Return true if the output accepted by this ResourceDescriptor would be accepted by the supplied Class (opposite of wouldAccept)
- write(OutputStream) - Method in class org.faceless.publisher.output.pdf.PDFReportOutput
- write(OutputStream) - Method in interface org.faceless.publisher.output.ReportOutput
-
Write the object generated by this ReportOutput to the specified OutpuStream.
- write(OutputStream) - Method in class org.faceless.publisher.output.svg.SVGReportOutput
-
Write the SVG output to the specified stream.
X
- XIncludeExtension - Class in org.faceless.publisher.ext
-
A ReportFactoryExtension that adds support for XML Inclusions (XInclude).
- XIncludeExtension() - Constructor for class org.faceless.publisher.ext.XIncludeExtension
- XMLNS - Enum constant in enum class org.faceless.publisher.ext.HtmlNamespaceExtension.Mode
-
Additional namespaces are added to HTML by the use of the "xmlns" prefix, exactly as with XML
- XMLResourceLoader - Class in org.faceless.publisher.ext
-
A top-level ResourceLoader for loading HTML, XML and SVG documents for processing with BFO Publisher.
- XMLResourceLoader() - Constructor for class org.faceless.publisher.ext.XMLResourceLoader
- XmlStylesheetExtension - Class in org.faceless.publisher.ext
-
A ReportFactoryExtension that will process any <?
- XmlStylesheetExtension() - Constructor for class org.faceless.publisher.ext.XmlStylesheetExtension
- XsltAttributeExtension - Class in org.faceless.publisher.ext
-
A ReportFactoryExtension that will apply the XSLT stylesheet referenced by the "bfo:xslt" attribute on any element, to that element.
- XsltAttributeExtension() - Constructor for class org.faceless.publisher.ext.XsltAttributeExtension
Z
- ZipURLConnectionFactory - Class in org.faceless.publisher.resource
-
A URLConnectionFactory that can be used to load resources from a Zip file.
- ZipURLConnectionFactory(BackedZipFile, URL2, ZipURLConnectionFactory.Flavor) - Constructor for class org.faceless.publisher.resource.ZipURLConnectionFactory
-
Create a URLConnectionFactory that will read entries from a ZIP file.
- ZipURLConnectionFactory.Flavor - Enum Class in org.faceless.publisher.resource
-
Which variation of Zip file we're loading
- ZTemplateExtension - Class in org.faceless.publisher.ext
-
An extension to use the ZTemplate template language as a pre-processor to generate the HTML/XML parsed by BFO Publisher.
- ZTemplateExtension() - Constructor for class org.faceless.publisher.ext.ZTemplateExtension
-
Create a new ZTemplateExtension
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form