org.da.protoframework.eventlogger

Class EventLoggerFactory

java.lang.Object

org.da.protoframework.eventlogger.EventLoggerFactory

public class EventLoggerFactory
extends java.lang.Object

The factory which creates an event engine.

Since:

0.6.28

Method Summary

Modifier and Type	Method and Description
EventEngine	createEngine() Create the engine, using the getEngineURL() URL.
java.net.URL	getEngineURL() Return the URL of the engine.
static EventLoggerFactory	getInstance()
static boolean	hasFactory() Return true if the factory is not null.
static void	invoke(NamespaceKey service, int id, ModuleKey fromModule) Called when one invocation event must be recorded.
static boolean	isActive() Return true if the factory is not null and its engine is active.
boolean	isAutoStart() Return true if the engine must be autostarted.
static void	notified(NamespaceKey service, int id, ModuleKey fromModule, ModuleKey toModule) Called when one notification event must be recorded.
void	setAutoStart(boolean autoStart) Called if the engine must be autostarted at the start of the framework.
void	setEngineURL(java.net.URL url) Set the URL of the engine.
void	setEventsURL(java.net.URL url) Set the events URL.
void	setFramework(Framework framework) Set the framework.
static void	setStartTimeStamp(long startTimeStamp) Called when the engine must be started.
static void	start() Called when the engine must be started.
static void	stop() Called when the engine must be stopped.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static EventLoggerFactory getInstance()

hasFactory

public static boolean hasFactory()

Return true if the factory is not null.

Returns:

true if the factory is not null

isActive

public static boolean isActive()

Return true if the factory is not null and its engine is active.

Returns:

true if the factory is not null and its engine is active

setStartTimeStamp

public static void setStartTimeStamp(long startTimeStamp)

Called when the engine must be started.

Parameters:

startTimeStamp - the starting time stamp

setAutoStart

public void setAutoStart(boolean autoStart)

Called if the engine must be autostarted at the start of the framework.

Parameters:

autoStart - true if the engine must be autostarted at the start of the framework

isAutoStart

public boolean isAutoStart()

Return true if the engine must be autostarted.

Returns:

true if the engine must be autostarted

start

public static void start()

Called when the engine must be started.

stop

public static void stop()

Called when the engine must be stopped.

invoke

public static void invoke(NamespaceKey service,
                          int id,
                          ModuleKey fromModule)

Called when one invocation event must be recorded.

Parameters:

service - the service key

id - the event id

fromModule - the key of the module which invokes the event

notified

public static void notified(NamespaceKey service,
                            int id,
                            ModuleKey fromModule,
                            ModuleKey toModule)

Called when one notification event must be recorded.

Parameters:

service - the service key

id - the event id

fromModule - the key of the module which invokes the event

toModule - the key of the module which is notified from the event

setFramework

public void setFramework(Framework framework)

Set the framework.

Parameters:

framework - the framework

setEventsURL

public void setEventsURL(java.net.URL url)

Set the events URL.

Parameters:

url - the URL

setEngineURL

public void setEngineURL(java.net.URL url)

Set the URL of the engine. Th URL must be a Jar file containing the classes foe the engine. The Jar manifest must have a "Engine" key with the classpath of the engine. The Engine must be an instance of the EventEngine interface.

Parameters:

url - the URL

getEngineURL

public java.net.URL getEngineURL()

Return the URL of the engine.

Returns:

the URL

createEngine

public EventEngine createEngine()

Create the engine, using the getEngineURL() URL.

Returns:

the engine