src/org/lwes/emitter/EventEmitter.java

   1 package org.lwes.emitter;
   2
   3 import java.io.IOException;
   4 import java.io.InputStream;
   5
   6 import org.lwes.Event;
   7 import org.lwes.EventSystemException;
   8
   9 /**
  10  * EventEmitter is the interface that defines a component that takes an Event and performs an emit task
  11  * on that event.  This may emit the event to the network, to a disk, or to a database.
  12  *
  13  * @author      Michael P. Lum
  14  * @author      Anthony Molinaro
  15  */
  16 public interface EventEmitter {
  17         /**
  18          * Sets the ESF file used for event validation.
  19          * @param esfFilePath the path of the ESF file
  20          */
  21         public void setESFFilePath(String esfFilePath);
  22
  23         /**
  24          * Gets the ESF file used for event validation
  25          * @return the ESF file path
  26          */
  27         public String getESFFilePath();
  28
  29         /**
  30          * Sets an InputStream to be used for event validation.
  31          * @param esfInputStream an InputStream used for event validation
  32          */
  33         public void setESFInputStream(InputStream esfInputStream);
  34
  35         /**
  36          * Gets the InputStream being used for event validation.
  37          * @return the InputStream of the ESF validator
  38          */
  39         public InputStream getESFInputStream();
  40
  41         /**
  42          * Called before the system is started.  Allows for initialization of data and creation
  43          * of network sockets, where applicable.
  44          *
  45          * @throws IOException if an I/O error occurs during initialization
  46          */
  47         public void initialize() throws IOException;
  48
  49         /**
  50          * Called before the system is shut down.  Allows for cleanup of data and destruction of
  51          * network sockets, where applicable.
  52          *
  53          * @throws IOException if an I/O error occurs during initialization
  54          */
  55         public void shutdown() throws IOException;
  56
  57         /**
  58          * Create an event with name <tt>eventName</tt>
  59          * @param eventName the name of the event to create
  60          * @return the Event object
  61          * @throws EventSystemException if an error occurs during event creation
  62          */
  63         public Event createEvent(String eventName) throws EventSystemException;
  64
  65         /**
  66          * Create an event with name <tt>eventName</tt>, optionally validating it against an EventTemplateDB
  67          * @param eventName the name of the event
  68          * @param validate whether or not to validate the event against the EventTemplateDB
  69          * @return the Event object
  70          * @throws EventSystemException if an error occurs during event creation
  71          */
  72         public Event createEvent(String eventName, boolean validate) throws EventSystemException;
  73
  74         /**
  75          * Emits an Event object to the destination
  76          *
  77          * @param  event  the event being emitted
  78          * @throws IOException if an I/O error occurs
  79          */
  80         public void emit(Event event) throws IOException;
  81 }