com.adaptris.core

Interface EventHandler

All Superinterfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

All Known Implementing Classes:

DefaultEventHandler, EventHandlerBase

public interface EventHandler
extends AdaptrisComponent, StateManagedComponent, ComponentLifecycleExtension

Defines behaviour related to sending and receiving Events using other standard framework components.

Method Summary

Modifier and Type	Method and Description
void	registerSourceId(java.lang.String sourceId) Sets the source id for this EventHandler.
java.lang.String	retrieveSourceId() Retrieve the source id for this EventHandler.
void	send(Event evt) Send an Event to the configured default destination.
void	send(Event evt, java.util.Map<java.lang.String,java.lang.String> properties) Send an Event to the configured default destination.
void	send(Event evt, ProduceDestination destination) Deprecated. since 3.8.2; events should really be explicitly configured, will be removed with no replacement

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init, start, stop

Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension

prepare

Method Detail

send

void send(Event evt)
   throws CoreException

Send an Event to the configured default destination.

Parameters:

evt - the Event to send

Throws:

CoreException - wrapping any underlying Exceptions

send

void send(Event evt,
          java.util.Map<java.lang.String,java.lang.String> properties)
   throws CoreException

Send an Event to the configured default destination.

Parameters:

evt - the Event to send

properties - any additional properties that should be sent if possible.

Throws:

CoreException - wrapping any underlying Exceptions

send

@Deprecated
 @Removal(version="3.10.0")
void send(Event evt,
                                                  ProduceDestination destination)
                                           throws CoreException

Deprecated. since 3.8.2; events should really be explicitly configured, will be removed with no replacement

Send an Event to the specified destination.

Parameters:

evt - the Event to send

destination - the ProduceDestination to send to

Throws:

CoreException - wrapping any underlying Exceptions

registerSourceId

void registerSourceId(java.lang.String sourceId)

Sets the source id for this EventHandler. The source id may be used for routing or replying to events and is generally the unique id of the Adapter.

Parameters:

sourceId - the source id to be sent as part of the Event

retrieveSourceId

java.lang.String retrieveSourceId()

Retrieve the source id for this EventHandler. The source id may be used for routing or replying to events and is generally the unique id of the Adapter.