com.itextpdf.kernel.counter

Class EventCounterHandler

java.lang.Object

com.itextpdf.kernel.counter.EventCounterHandler

public class EventCounterHandler
extends Object

Manager that works with IEventCounterFactory. Create EventCounter for each registered IEventCounterFactory and send corresponding events when calling onEvent(IEvent, IMetaInfo, Class) method.

You can implement your own IEventCounterFactory and register them with register(IEventCounterFactory) Or implement EventCounter and register it with SimpleEventCounterFactory like this: EventCounterHandler.getInstance().register(new SimpleEventCounterFactory(new SystemOutEventCounter()); SystemOutEventCounter is just an example of a EventCounter implementation.

This functionality can be used to create metrics in a SaaS context.

Method Summary

Modifier and Type	Method and Description
static EventCounterHandler	getInstance()
boolean	isRegistered(IEventCounterFactory factory) Checks whether the specified IEventCounterFactory is registered.
void	onEvent(IEvent event, IMetaInfo metaInfo, Class<?> caller) Triggers all registered IEventCounterFactory to produce EventCounter instance and count the event.
void	register(IEventCounterFactory factory) Register new IEventCounterFactory.
boolean	unregister(IEventCounterFactory factory) Unregister specified IEventCounterFactory.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static EventCounterHandler getInstance()

Returns:

the singleton instance of the factory.

onEvent

public void onEvent(IEvent event,
                    IMetaInfo metaInfo,
                    Class<?> caller)

Triggers all registered IEventCounterFactory to produce EventCounter instance and count the event.

Parameters:

event - IEvent to be counted

metaInfo - IMetaInfo object that can holds information about instance that throws the event

caller - the class that throws the event

register

public void register(IEventCounterFactory factory)

Register new IEventCounterFactory. Does nothing if same factory was already registered.

Parameters:

factory - IEventCounterFactory to be registered

isRegistered

public boolean isRegistered(IEventCounterFactory factory)

Checks whether the specified IEventCounterFactory is registered.

Parameters:

factory - IEventCounterFactory to be checked

Returns:

true if the specified factory is registered

unregister

public boolean unregister(IEventCounterFactory factory)

Unregister specified IEventCounterFactory. Does nothing if this factory wasn't registered first.

Parameters:

factory - IEventCounterFactory to be unregistered

Returns:

true if specified factory was registered first