com.evolveum.midpoint.provisioning.api
Interface ResourceObjectChangeListener

All Known Subinterfaces:
ChangeNotificationDispatcher
All Known Implementing Classes:
ChangeNotificationDispatcherImpl, SynchronizationService

public interface ResourceObjectChangeListener

Author:
Radovan Semancik

Field Summary
static java.lang.String CHECK_SITUATION
           
static java.lang.String CLASS_NAME_WITH_DOT
           
static java.lang.String NOTIFY_CHANGE
           
 
Method Summary
 java.lang.String getName()
          Returns a short name of the listener for debugging purposes.
 void notifyChange(ResourceObjectShadowChangeDescription change, Task task, OperationResult parentResult)
          Submits notification about a specific change that happened on the resource.
 void notifyFailure(ResourceObjectShadowFailureDescription failureDescription, Task task, OperationResult parentResult)
          Submits notification about a failure to apply a change on resource.
 

Field Detail

CLASS_NAME_WITH_DOT

static final java.lang.String CLASS_NAME_WITH_DOT

NOTIFY_CHANGE

static final java.lang.String NOTIFY_CHANGE

CHECK_SITUATION

static final java.lang.String CHECK_SITUATION
Method Detail

notifyChange

void notifyChange(ResourceObjectShadowChangeDescription change,
                  Task task,
                  OperationResult parentResult)
Submits notification about a specific change that happened on the resource. This describes the change that has already happened on the resource. The upper layers are notified to take that change into an account (synchronize it). The call should return without a major delay. It means that the implementation can do calls to repository, but it should not (synchronously) initiate a long-running process or provisioning request. This operation may be called multiple times with the same change, e.g. in case of failures in IDM or on the resource. The implementation must be able to handle such duplicates.

Parameters:
change - change description

notifyFailure

void notifyFailure(ResourceObjectShadowFailureDescription failureDescription,
                   Task task,
                   OperationResult parentResult)
Submits notification about a failure to apply a change on resource. This describes the change that should have been executed on the resource but that never happened because a failure was detected. The upper layers are notified to take handle that failure (e.g. notify the administrator). This should be called for operations that were done asynchronously and failed to execute. It should NOT be called for synchronous operations. Direct return value should be used instead. The call should return without a major delay. It means that the implementation can do calls to repository, but it should not (synchronously) initiate a long-running process or provisioning request.


getName

java.lang.String getName()
Returns a short name of the listener for debugging purposes. E.g. "model synchronization service". This name is used in log and error messages.



Copyright © 2012 evolveum. All Rights Reserved.