javax.slee.facilities
Interface EventLookupFacility


public interface EventLookupFacility

The Event Lookup Facility is used by resource adaptors to obtain information about the event types that it may fire to the SLEE. A resource adaptor may obtain an instance of the Event Lookup Facility via the ResourceAdaptorContext.getEventLookupFacility() method.

Since:
SLEE 1.1

Method Summary
 FireableEventType getFireableEventType(EventTypeID eventType)
          Get a FireableEventType object for a given event type.
 

Method Detail

getFireableEventType

FireableEventType getFireableEventType(EventTypeID eventType)
                                       throws java.lang.NullPointerException,
                                              UnrecognizedEventException,
                                              FacilityException
Get a FireableEventType object for a given event type. The FireableEventType object is used to identify the type of an event fired to the SLEE by a resource adaptor.

The SLEE need only provide a resource adaptor with information about the event types that the resource adaptor may fire. Generally this is limited to the resource adaptor types implemented by the resource adaptor. However a resource adaptor may be able to fire events of any type if its deployment descriptor has disabled this limitation, and in such cases the Event Lookup Facility should provide the resource adaptor with information about all the event types that are installed in the SLEE.

This method is a non-transactional method.

Parameters:
eventType - the event type component identifier for the event type.
Returns:
a FireableEventType object for the event type.
Throws:
java.lang.NullPointerException - if eventType is null.
UnrecognizedEventException - if eventType does not identify an event type installed in the SLEE. This exception may also be thrown if the event type is not referenced by any of the resource adaptor types implemented by the resource adaptor (and is hence theorectically unrecognizable to that resource adaptor) unless this check has been disabled in the resource adaptor's deployment descriptor.
FacilityException - if the FireableEventType object could not be obtained due to a system-level failure.


Copyright © 2009. All Rights Reserved.