com.ibm.events.emitter
Interface EmitterFactory


public interface EmitterFactory

This interface is used by event sources to create emitter instances.

For information on how to obtain emitter factory instances refer to the Common Event Infrastructure Developer's Guide.

Since:
5.1.0
Version:
1.15 6/8/04

Method Summary
 Emitter getEmitter()
          Obtains an emitter instance.
 Emitter getEmitter(java.lang.String jmsUsername, java.lang.String jmsPassword)
          Obtains an Emitter instance.
 

Method Detail

getEmitter

public Emitter getEmitter()
                   throws EventsException

Obtains an emitter instance.

Returns:
An event emitter that is ready to send events to the event bus.
Throws:
EmitterException - If the emitter factory encountered an error when creating an emitter instance. The nested cause exception provides further details on why this the failure has occurred.

getEmitter

public Emitter getEmitter(java.lang.String jmsUsername,
                          java.lang.String jmsPassword)
                   throws EventsException

Obtains an Emitter instance.

The specification of a JMS username and password is required when a J2EE client application running in a secure environment uses emitter profiles that contain asynchronous transmission profile JNDI names.

Parameters:
jmsUsername - The JMS username to be used to create the JMS queue connection.
jmsPassword - The JMS password to be used to create the JMS queue connection.
Returns:
An event emitter that is ready to send events to the event bus.
Throws:
EmitterException - If the emitter factory encountered an error when creating an emitter instance. The nested cause exception provides further details on why this the failure has occurred.