Package org.identityconnectors.framework.common.exceptions

Class RetryableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.identityconnectors.framework.common.exceptions.ConnectorException

org.identityconnectors.framework.common.exceptions.RetryableException

All Implemented Interfaces:

Serializable

public class RetryableException
extends ConnectorException

RetryableException indicates that a failure may be temporary, and that retrying the same request may be able to succeed in the future.

Since:

1.4

Author:

Laszlo Hordos

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static RetryableException	wrap(String message, Throwable cause)	If Exception parameter passed in is a RetryableException it is simply returned.
static RetryableException	wrap(String message, Uid uid)	Constructs a new RetryableException which signals partial success of create operation.

Methods inherited from class org.identityconnectors.framework.common.exceptions.ConnectorException

rethrow, wrap

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

wrap

public static RetryableException wrap(String message,
                                      Throwable cause)

If Exception parameter passed in is a RetryableException it is simply returned. Otherwise the Exception is wrapped in a RetryableException and returned.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - Exception to wrap or cast and return.

Returns:

a RuntimeException that either is the specified exception or contains the specified exception.

wrap

public static RetryableException wrap(String message,
                                      Uid uid)

Constructs a new RetryableException which signals partial success of create operation. This should be called inside CreateOp.create(org.identityconnectors.framework.common.objects.ObjectClass, java.util.Set, org.identityconnectors.framework.common.objects.OperationOptions) implementation to signal that the create was not completed but the object was created with Uid and Application should call the UpdateOp.update(org.identityconnectors.framework.common.objects.ObjectClass, org.identityconnectors.framework.common.objects.Uid, java.util.Set, org.identityconnectors.framework.common.objects.OperationOptions) method now.

Use this only if the created object can not be deleted. The best-practice should always be the Connector implementation reverts the changes if the operation failed.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

uid - the new object's Uid.

Returns:

a RetryableException that either is the specified exception or contains the specified exception.