GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing xmlgraphics.apache.org — Apache FOP™: Events/Processing Feedback Apache FOP™¶
Apache® XML Graphics¶Sub Projects¶Search Apache XML Graphics¶ApacheCon N. America¶Hope to see you there! ApacheCon Europe¶Hope to see you there!
This document is for an old version of FOP that is no longer supported. Latest version of this page
Apache FOP™: Events/Processing FeedbackIntroductionIn versions until 0.20.5, Apache FOP™ used Avalon-style Logging where it was possible to supply a logger per processing run. During the redesign the logging infrastructure was switched over to Commons Logging which is (like Log4J or java.util.logging) a "static" logging framework (the logger is accessed through static variables). This made it very difficult in a multi-threaded system to retrieve information for a single processing run. With FOP's event subsystem, we'd like to close this gap again and even go further. The first point is to realize that we have two kinds of "logging". Firstly, we have the logging infrastructure for the (FOP) developer who needs to be able to enable finer log messages for certain parts of FOP to track down a certain problem. Secondly, we have the user who would like to be informed about missing images, overflowing lines or substituted fonts. These messages (or events) are targeted at less technical people and may ideally be localized (translated). Furthermore, tool and solution builders would like to integrate FOP into their own solutions. For example, an FO editor should be able to point the user to the right place where a particular problem occurred while developing a document template. Finally, some integrators would like to abort processing if a resource (an image or a font) has not been found, while others would simply continue. The event system allows to react on these events. On this page, we won't discuss logging as such. We will show how the event subsystem can be used for various tasks. We'll first look at the event subsystem from the consumer side. Finally, the production of events inside FOP will be discussed (this is mostly interesting for FOP developers only). The consumer sideThe event subsystem is located in the
The A full example of what is shown here can be found in the Writing an EventListenerThe following code sample shows a very simple EventListener. It basically just sends all events to System.out (stdout) or System.err (stderr) depending on the event severity. You can see that for every event the method The code above also shows how you can turn an event into a human-readable, localized message that can be presented to a user. The It is possible to gather all events for a whole processing run so they can be evaluated afterwards. However, care should be taken about memory consumption since the events provide references to objects inside FOP which may themselves have references to other objects. So holding on to these objects may mean that whole object trees cannot be released! Adding an EventListenerTo register the event listener with FOP, get the Please note that this is done separately for each processing run, i.e. for each new user agent. An additional listener exampleHere's an additional example of an event listener: By default, FOP continues processing even if an image wasn't found. If you have more strict requirements and want FOP to stop if an image is not available, you can do something like the following in the simplest case: Increasing the event severity to FATAL will signal the event broadcaster to throw an exception and stop further processing. In the above case, all resource-related events will cause FOP to stop processing. You can also customize the exception to throw (you can may throw a RuntimeException or subclass yourself) and/or which event to respond to: This throws a The producer side (for FOP developers)This section is primarily for FOP and FOP plug-in developers. It describes how to use the event subsystem for producing events. Producing and sending an eventThe basics are very simple. Just instantiate an The The EventProducer interfaceTo simplify event production, the event subsystem provides the The event producer interface does not need to have any implementation. The implementation is produced at runtime by a dynamic proxy created by To simplify the code needed to get an instance of the event producer interface it is suggested to create a public inner provider class inside the interface. Here's an example of such an event producer interface: To produce the same event as in the first example above, you'd use the following code: The event modelInside an invocation handler for a dynamic proxy, there's no information about the names of each parameter. The JVM doesn't provide it. The only thing you know is the interface and method name. In order to properly fill the The event model XML files are generated during build by the Ant task mentioned above when running the "resourcegen" task. So just run Primarily, the QDox-based collector task records the parameters' names and types. Furthermore, it extracts additional attributes embedded as Javadoc comments from the methods. At the moment, the only such attribute is "@event.severity" which indicates the default event severity (which can be changed by event listeners). The example event producer above shows the Javadocs for an event method. There's one more information that is extracted from the event producer information for the event model: an optional primary exception. The first exception in the "throws" declaration of an event method is noted. It is used to throw an exception from the invocation handler if the event has an event severity of "FATAL" when all listeners have been called (listeners can update the event severity). Please note that an implementation of For a given application, there can be multiple event models active at the same time. In FOP, each renderer is considered to be a plug-in and provides its own specific event model. The individual event models are provided through an Event severityFour different levels of severity for events has been defined:
Event listeners can choose to ignore certain events based on their event severity. Please note that you may recieve an event "twice" in a specific case: if there is a fatal error an event is generated and sent to the listeners. After that an exception is thrown with the same information and processing stops. If the fatal event is shown to the user and the following exception is equally presented to the user it may appear that the event is duplicated. Of course, the same information is just published through two different channels. Plug-ins to the event subsystemThe event subsystem is extensible. There are a number of extension points:
The names in bold above are used as filenames for the service provider files that are placed in the Localization (L10n)One goal of the event subsystem was to have localized (translated) event messages. The The XML format used by the The example (extracted from the RTF handler's event producer) has message templates for two event methods. The class used to do variable replacement in the templates is "locator" is a template that is reused by the other message templates by referencing it through "{{locator}}". This is some kind of include command. Normal event parameters are accessed by name inside single curly braces, for example: "{node}". For objects, this format just uses the The single curly braces pattern supports additional features. For example, it is possible to do this: "{start,if,start,end}". "if" here is a special field modifier that evaluates "start" as a boolean and if that is true returns the text right after the second comma ("start"). Otherwise it returns the text after the third comma ("end"). The "equals" modifier is similar to "if" but it takes as an additional (comma-separated) parameter right after the "equals" modifier, a string that is compared to the value of the variable. An example: {severity,equals,EventSeverity:FATAL,,some text} (this adds "some text" if the severity is not FATAL). Additional such modifiers can be added by implementing the Square braces can be used to specify optional template sections. The whole section will be omitted if any of the variables used within are unavailable. Pipe (|) characters can be used to specify alternative sub-templates (see "locator" above for an example). Developers can also register a function (in the above example: |
| You are visitor 01402605 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |