Package com.unboundid.directory.sdk.sync.types

Enum PostStepResult

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PostStepResult>
    public enum PostStepResult
extends java.lang.Enum<PostStepResult>
    This result is returned by plugins that are invoked after step of the synchronization processing. It directs the core synchronization processing code how to continue processing the operation.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABORT_OPERATION
      This result indicates that the current operation should be aborted without any additional processing.
      CONTINUE
      This result indicates that processing should continue with the current step.
      RETRY_OPERATION_LIMITED
      This result indicates that there was some error processing the current operation in the plugin and that it should be retried a limited number of times.
      RETRY_OPERATION_UNLIMITED
      This result indicates that there was some error processing the current operation in the plugin and that it should be retried an unlimited number of times.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PostStepResult valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PostStepResult[] 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

      • CONTINUE

        public static final PostStepResult CONTINUE
        This result indicates that processing should continue with the current step.

      • ABORT_OPERATION

        public static final PostStepResult ABORT_OPERATION
        This result indicates that the current operation should be aborted without any additional processing.

      • RETRY_OPERATION_LIMITED

        public static final PostStepResult RETRY_OPERATION_LIMITED
        This result indicates that there was some error processing the current operation in the plugin and that it should be retried a limited number of times.

      • RETRY_OPERATION_UNLIMITED

        public static final PostStepResult RETRY_OPERATION_UNLIMITED
        This result indicates that there was some error processing the current operation in the plugin and that it should be retried an unlimited number of times. Be very careful returning this value as it can stall all in-flight operations until the operation completes. This should only be used in situations where a remote service (e.g. the LDAP server) is unavailable.

    • Method Detail

      • values

        public static PostStepResult[] 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 (PostStepResult c : PostStepResult.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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