com.unboundid.directory.sdk.sync.types
Enum CompletionStatus

java.lang.Object
  java.lang.Enum<CompletionStatus>
      com.unboundid.directory.sdk.sync.types.CompletionStatus

All Implemented Interfaces:

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

public enum CompletionStatus
extends java.lang.Enum<CompletionStatus>

This class contains the possible completion reasons for a synchronization operation. This information is returned in a DatabaseChangeRecord after it is acknowledged back to the sync source.

Enum Constant Summary

COMPLETED_ABORTED_BY_PLUGIN
The operation was aborted by a custom sync plugin.

COMPLETED_ENTRY_ALREADY_EXISTS
The operation was unsuccessful because the entry already existed at the destination (applies only to CREATE operations).

COMPLETED_FAILED_AT_RESOURCE
The operation was unsuccessful because there was a failure at one of the endpoint resources.

COMPLETED_FAILED_DURING_MAPPING
The operation was unsuccessful because there was a failure during attribute or DN mapping.

COMPLETED_FAILED_IN_PLUGIN
The operation was unsuccessful because it there was a failure during plugin processing.

COMPLETED_FAILED_UNEXPECTED_EXCEPTION
The operation was unsuccessful because there was an unexpected exception during processing (e.g.

COMPLETED_MULTIPLE_MATCHES_FOUND
The operation was unsuccessful because multiple matches for a source entry were found at the destination.

COMPLETED_NO_CHANGE_NEEDED
No change was necessary because the destination entry was already in sync.

COMPLETED_NO_MATCH_FOUND
The operation was unsuccessful because no matching destination entry could be found (applies only to MODIFY and DELETE operations).

COMPLETED_OP_TYPE_NOT_SYNCED
The change was dropped because the operation type (e.g.

COMPLETED_OUT_OF_SCOPE
The operation was dropped because it was out of scope (did not match any sync classes).

COMPLETED_SUCCESS
The operation completed successfully.

Method Summary

static CompletionStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CompletionStatus[]	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

COMPLETED_SUCCESS

public static final CompletionStatus COMPLETED_SUCCESS

The operation completed successfully.

COMPLETED_OUT_OF_SCOPE

public static final CompletionStatus COMPLETED_OUT_OF_SCOPE

The operation was dropped because it was out of scope (did not match any sync classes).

COMPLETED_OP_TYPE_NOT_SYNCED

public static final CompletionStatus COMPLETED_OP_TYPE_NOT_SYNCED

The change was dropped because the operation type (e.g. create) is not synchronized.

COMPLETED_NO_CHANGE_NEEDED

public static final CompletionStatus COMPLETED_NO_CHANGE_NEEDED

No change was necessary because the destination entry was already in sync.

COMPLETED_ABORTED_BY_PLUGIN

public static final CompletionStatus COMPLETED_ABORTED_BY_PLUGIN

The operation was aborted by a custom sync plugin.

COMPLETED_ENTRY_ALREADY_EXISTS

public static final CompletionStatus COMPLETED_ENTRY_ALREADY_EXISTS

The operation was unsuccessful because the entry already existed at the destination (applies only to CREATE operations).

COMPLETED_NO_MATCH_FOUND

public static final CompletionStatus COMPLETED_NO_MATCH_FOUND

The operation was unsuccessful because no matching destination entry could be found (applies only to MODIFY and DELETE operations).

COMPLETED_MULTIPLE_MATCHES_FOUND

public static final CompletionStatus COMPLETED_MULTIPLE_MATCHES_FOUND

The operation was unsuccessful because multiple matches for a source entry were found at the destination.

COMPLETED_FAILED_DURING_MAPPING

public static final CompletionStatus COMPLETED_FAILED_DURING_MAPPING

The operation was unsuccessful because there was a failure during attribute or DN mapping.

COMPLETED_FAILED_AT_RESOURCE

public static final CompletionStatus COMPLETED_FAILED_AT_RESOURCE

The operation was unsuccessful because there was a failure at one of the endpoint resources.

COMPLETED_FAILED_IN_PLUGIN

public static final CompletionStatus COMPLETED_FAILED_IN_PLUGIN

The operation was unsuccessful because it there was a failure during plugin processing.

COMPLETED_FAILED_UNEXPECTED_EXCEPTION

public static final CompletionStatus COMPLETED_FAILED_UNEXPECTED_EXCEPTION

The operation was unsuccessful because there was an unexpected exception during processing (e.g. a RunTimeException).

Method Detail

values

public static CompletionStatus[] 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 (CompletionStatus c : CompletionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompletionStatus 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