com.evolveum.midpoint.notifications.impl

Class AccountOperationListener

java.lang.Object

com.evolveum.midpoint.notifications.impl.AccountOperationListener

All Implemented Interfaces:

ProvisioningListener, ResourceOperationListener

@Component
public class AccountOperationListener
extends Object
implements ResourceOperationListener

Author:

mederly

Constructor Summary

Constructors

Constructor and Description
AccountOperationListener()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns a short name of the listener for debugging purposes.
void	init()
void	notifyFailure(ResourceOperationDescription operationDescription, Task task, OperationResult parentResult) Submits notification about a failure of provisioning operation.
void	notifyInProgress(ResourceOperationDescription operationDescription, Task task, OperationResult parentResult) Submits notification about provisioning operation that is in progress.
void	notifySuccess(ResourceOperationDescription operationDescription, Task task, OperationResult parentResult) Submits notification about a success of a provisioning operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountOperationListener

public AccountOperationListener()

Method Detail

init

@PostConstruct
public void init()

getName

public String getName()

Description copied from interface: ProvisioningListener

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

Specified by:

getName in interface ProvisioningListener

notifySuccess

public void notifySuccess(ResourceOperationDescription operationDescription,
                 Task task,
                 OperationResult parentResult)

Description copied from interface: ResourceOperationListener

Submits notification about a success of a provisioning operation. This describes the operation that was executed on the resource and it was successful. The upper layers are notified to post-process the result. It should be called for both synchronous and asynchronous operations. For synchronous operations it should provide the same result as is returned from the operation.

Specified by:

notifySuccess in interface ResourceOperationListener

parentResult - the result that can be used to collect subresults of the listener execution. It is NOT the result of the operation that succeeded. That result is inside the operationDescription structure.

notifyInProgress

public void notifyInProgress(ResourceOperationDescription operationDescription,
                    Task task,
                    OperationResult parentResult)

Description copied from interface: ResourceOperationListener

Submits notification about provisioning operation that is in progress. This describes the operation that was tried to be executed on the resource but cannot be executed immediately. This may be caused by the resource being down (communication error), it may be caused by the mode of resource operation (e.g. asynchronous processing) or by any similar cause. This should be called after each attempt that the operation was tried. The number of attempts already tried in indicated inside operationDescription structure. This can be used e.g. to detect a first attempt to send mail to admin only once. This should NOT be called for the final result of the operation. Methods notifySuccess and notifyFailure should be used instead.

Specified by:

notifyInProgress in interface ResourceOperationListener

parentResult - the result that can be used to collect subresults of the listener execution. It is NOT the result of the operation that is in progress. That result is inside the operationDescription structure.

notifyFailure

public void notifyFailure(ResourceOperationDescription operationDescription,
                 Task task,
                 OperationResult parentResult)

Description copied from interface: ResourceOperationListener

Submits notification about a failure of provisioning operation. This describes the operation that was executed on the resource and it failed. The upper layers are notified to handle that failure. This should be called for operations that were executed and failed to execute. This should be called only for the FINAL result. E.g. if the system will never again try the operation. If the operation has been just tried and there is an intermediary failure (e.g. a timeout) then this operation should NOT be called. notifyInProgress is used for that purpose. However, this operation should be called even for timeout-like errors if the system stops trying and will no longer attempt to retry the operation (e.g. if the attempt counter hits the maximum attempts limit). It should be called for both synchronous and asynchronous operations. For synchronous operations it should provide the same result as is returned from the operation.

Specified by:

notifyFailure in interface ResourceOperationListener

parentResult - the result that can be used to collect subresults of the listener execution. It is NOT the result of the operation that failed. That result is inside the operationDescription structure.