com.bea.alsb.resources.custom
Interface ResourceProviderListener


public interface ResourceProviderListener

Resource provider may choose to implement this interface to perform additional operations in react to ALSB change notifications.


Method Summary
 void beginChangeNotification(String session, Map scratchPadForChangeNotifications)
          Signals the listener that a set of notifications are about to be sent.
 void changesCommitted(String session, Map scratchPadForChangeNotifications)
          Signals that the changes have been committed (made persistent, and activated)
 void changesRolledback(String session, Map scratchPadForChangeNotifications)
          Signals that the changes have been rolledback.
 void endChangeNotification(String session, Map scratchPadForChangeNotifications)
          Signals that all change notifications have been sent.
 void onCreate(String session, Ref ref, ResourceInstanceData rid, Map scratchPadForChangeNotifications)
          Signals that a resource has been created.
 void onDelete(String session, Ref ref, ResourceInstanceData rid, Map scratchPadForChangeNotifications)
          Signals that a resource has been deleted.
 void onIdentityChange(String session, Ref oldIdentity, Ref newIdentity, Map scratchPadForChangeNotifications)
          Signals that a resource has been moved and/or renamed, but not modified.
 void onUpdate(String session, Ref ref, ResourceInstanceData oldRid, ResourceInstanceData newRid, Map scratchPadForChangeNotifications)
          Signals that a resource has been updated but not renamed/moved.
 void onUpdateAndIdentityChange(String session, Ref oldIdentity, Ref newIdentity, ResourceInstanceData oldRid, ResourceInstanceData newRid, Map scratchPadForChangeNotifications)
          Signals that a resource has been updated and renamed/moved at the same time.
 

Method Detail

beginChangeNotification

void beginChangeNotification(String session,
                             Map scratchPadForChangeNotifications)
                             throws Exception
Signals the listener that a set of notifications are about to be sent. The implementations of this method can perform initializations which can then be used in the onXXX methods.

Parameters:
session - the session context - reserved for future use, will always be null now
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

onCreate

void onCreate(String session,
              Ref ref,
              ResourceInstanceData rid,
              Map scratchPadForChangeNotifications)
              throws Exception
Signals that a resource has been created.

Parameters:
session - the session context - reserved for future use, will always be null now
ref - the object Ref
rid - the ResourceInstanceData object
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

onDelete

void onDelete(String session,
              Ref ref,
              ResourceInstanceData rid,
              Map scratchPadForChangeNotifications)
              throws Exception
Signals that a resource has been deleted.

Parameters:
session - the session context - reserved for future use, will always be null now
ref - the object Ref
rid - the ResourceInstanceData object
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

onUpdate

void onUpdate(String session,
              Ref ref,
              ResourceInstanceData oldRid,
              ResourceInstanceData newRid,
              Map scratchPadForChangeNotifications)
              throws Exception
Signals that a resource has been updated but not renamed/moved.

Parameters:
session - the session context - reserved for future use, will always be null now
ref - the object Ref
oldRid - old ResourceInstanceData
newRid - new ResourceInstanceData
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

onIdentityChange

void onIdentityChange(String session,
                      Ref oldIdentity,
                      Ref newIdentity,
                      Map scratchPadForChangeNotifications)
                      throws Exception
Signals that a resource has been moved and/or renamed, but not modified.

Parameters:
session - the session context - reserved for future use, will always be null now
oldIdentity - old identity
newIdentity - new identity
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

onUpdateAndIdentityChange

void onUpdateAndIdentityChange(String session,
                               Ref oldIdentity,
                               Ref newIdentity,
                               ResourceInstanceData oldRid,
                               ResourceInstanceData newRid,
                               Map scratchPadForChangeNotifications)
                               throws Exception
Signals that a resource has been updated and renamed/moved at the same time.

Parameters:
session - the session context - reserved for future use, will always be null now
oldRid - old ResourceInstanceData
newRid - new ResourceInstanceData
oldIdentity - old identity
newIdentity - new identity
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

endChangeNotification

void endChangeNotification(String session,
                           Map scratchPadForChangeNotifications)
                           throws Exception
Signals that all change notifications have been sent.

Parameters:
session - the session context - reserved for future use, will always be null now
scratchPadForChangeNotifications - the scratch pad object
Throws:
Exception - on error

changesCommitted

void changesCommitted(String session,
                      Map scratchPadForChangeNotifications)
Signals that the changes have been committed (made persistent, and activated)

Parameters:
session - the session context - reserved for future use, will always be null now
scratchPadForChangeNotifications - the scratch pad object

changesRolledback

void changesRolledback(String session,
                       Map scratchPadForChangeNotifications)
Signals that the changes have been rolledback. It is the responsibility of the implementors to undo (rollback) and work that has been performed by the onXXX methods.

Parameters:
session - the session context - reserved for future use, will always be null now
scratchPadForChangeNotifications - the scratch pad object