com.unboundid.directory.sdk.ds.types

Enum NotificationDeliveryResult

java.lang.Object

java.lang.Enum<NotificationDeliveryResult>

com.unboundid.directory.sdk.ds.types.NotificationDeliveryResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NotificationDeliveryResult>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum NotificationDeliveryResult
extends java.lang.Enum<NotificationDeliveryResult>

This class implements an enumeration that may be used to define the ways in which an attribute may be indexed within the directory server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILURE The notification could not be delivered and delivery should not be retried.
RETRY The notification could not be delivered but delivery should be retried.
SUCCESS The notification was successfully delivered.

Method Summary

Modifier and Type	Method and Description
static NotificationDeliveryResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NotificationDeliveryResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final NotificationDeliveryResult SUCCESS

The notification was successfully delivered.

FAILURE

public static final NotificationDeliveryResult FAILURE

The notification could not be delivered and delivery should not be retried.

RETRY

public static final NotificationDeliveryResult RETRY

The notification could not be delivered but delivery should be retried. Notification manager implementations should be careful not to return RETRY when all future attempts of the notification delivery will fail, e.g. a remote change failing due to a schema violation. If the extension can determine that the remote service is completely unavailable, then it is fine to continue to retry, but if the service is available and only failing for some changes, then continuing to retry is dangerous. There are methods on the Notification interface to determine how many attempts have been made and for how long attempts have been made. Above some threshold, the extension should return FAILURE instead of RETRY.

Method Detail

values

public static NotificationDeliveryResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NotificationDeliveryResult c : NotificationDeliveryResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NotificationDeliveryResult valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null