com.tivoli.zce.actions.libs
Class SendTecEvent

java.lang.Object
  extended bycom.tivoli.zce.actions.DefaultActionHandler
      extended bycom.tivoli.zce.actions.libs.SendTecEvent
All Implemented Interfaces:
IAction, com.tivoli.zce.IEventProcessor, com.tivoli.zce.IEventSender

public class SendTecEvent
extends DefaultActionHandler

Prepares an event for sending to TEC

When an event is passed back to EEIF (either gateway or adapter), the string representation of the event kept in the event.original field is sent to TEC for better performance. In order for updates made during state correlation to pass back to TEC, the snapshot kept in the event.original field must be updated as part of the last action in a rule. The SendEvent action performs the snapshot update and forwards the event by calling TecEventUtil.forwardTecEvent().

See Also:
DefaultActionHandler, TecEventUtil

Field Summary
 
Fields inherited from class com.tivoli.zce.actions.DefaultActionHandler
aloneEventProcessor, aloneEventProcessorId, eventProcessors
 
Fields inherited from interface com.tivoli.zce.IEventProcessor
IBM_Copyright
 
Fields inherited from interface com.tivoli.zce.IEventSender
IBM_Copyright
 
Constructor Summary
SendTecEvent()
           
 
Method Summary
 java.lang.Object doParse(IRule rule, java.lang.String paramSz)
          Parses any parameters which are part of the action definition
 void processEvent(Event event)
          Refreshes the snapshot of the event information kept in the event.original field and forwards the event.
 void processEvents(EventList eventList)
          Processes a list of events
 
Methods inherited from class com.tivoli.zce.actions.DefaultActionHandler
addEventProcessor, banner, forward, forward, getEventProcessor, IBM_Copyright, removeEventProcessor, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SendTecEvent

public SendTecEvent()
Method Detail

processEvents

public void processEvents(EventList eventList)
                   throws java.lang.Exception
Processes a list of events

Takes the provided list of events and processes each event individually by passing it to this actions processEvent() method.

The event list represents the collection of events needed to trigger a rule by the State Correlation Engine. This method is typically called when a state based rule is used and the event list contains the events from the event which triggered the state machine for the rule to the last events processed by the state machine.

Parameters:
eventList - the list of events to process
Throws:
java.lang.Exception
See Also:
processEvent(com.tivoli.zce.engine.Event), DefaultActionHandler, EventList

processEvent

public void processEvent(Event event)
                  throws java.lang.Exception
Refreshes the snapshot of the event information kept in the event.original field and forwards the event.

Updates the event snapshot and handles persistence updates by calling the TecEventUtil.forwardTecEvent() utility method. The event is then forwarded.

Parameters:
event - the event to process
Throws:
java.lang.Exception
See Also:
processEvents(com.tivoli.zce.engine.EventList), DefaultActionHandler, Event, TecEventUtil

doParse

public java.lang.Object doParse(IRule rule,
                                java.lang.String paramSz)
                         throws ParserException
Parses any parameters which are part of the action definition

All parameters defined in the rule XML for this action are passed in the string paramSz. For this particular action, no parameters are expected so no parsing is done.

This method is called once for each rule containing this action. If the action is shared ( singleInstance="true") then this method is only called once.

Parameters:
rule - the specific instance of the rule containing this action
paramSz - the parameters defined for this action in this rule instance
Returns:
the action itself
Throws:
ParserException
See Also:
DefaultActionHandler, IRule