Enum Class FluxzeroErrorCode

java.lang.Object
java.lang.Enum<FluxzeroErrorCode>
io.fluxzero.sdk.common.exception.FluxzeroErrorCode
All Implemented Interfaces:
Serializable, Comparable<FluxzeroErrorCode>, Constable
public enum FluxzeroErrorCode extends Enum<FluxzeroErrorCode>
Stable identifiers for Fluxzero SDK errors.

The textual message may evolve to become more helpful, but the code should remain stable so application logs, support playbooks, and Fluxzero documentation can refer to the same problem over time.

Published codes are part of the SDK support contract: do not renumber, rename, or reuse them for a different meaning. Add a new code when introducing a distinct error category.

  • Enum Constant Details

    • FLUXZERO_INSTANCE_MISSING

      public static final FluxzeroErrorCode FLUXZERO_INSTANCE_MISSING
      No Fluxzero instance is available for the current call.

    • REQUEST_TIMED_OUT

      public static final FluxzeroErrorCode REQUEST_TIMED_OUT
      A request was sent, but no matching response arrived before the timeout elapsed.

    • HANDLER_INVOCATION_FAILED

      public static final FluxzeroErrorCode HANDLER_INVOCATION_FAILED
      A handler failed while processing a message.

    • RESPONSE_DISPATCH_FAILED

      public static final FluxzeroErrorCode RESPONSE_DISPATCH_FAILED
      A response could not be published back to the requester.

    • THREAD_INTERRUPTED

      public static final FluxzeroErrorCode THREAD_INTERRUPTED
      A blocking wait was interrupted before Fluxzero could complete it.

    • MESSAGE_DISPATCH_FAILED

      public static final FluxzeroErrorCode MESSAGE_DISPATCH_FAILED
      One or more messages could not be dispatched.

    • USER_PROVIDER_MISSING

      public static final FluxzeroErrorCode USER_PROVIDER_MISSING
      A user was attached to a message without a configured user provider.

    • TRACKING_CONFIGURATION_INVALID

      public static final FluxzeroErrorCode TRACKING_CONFIGURATION_INVALID
      Tracking could not start because consumer configuration is incomplete or conflicting.

    • PERIODIC_SCHEDULE_INVALID

      public static final FluxzeroErrorCode PERIODIC_SCHEDULE_INVALID
      A periodic schedule annotation is missing the required timing configuration.

    • TRACKING_RUNTIME_FAILED

      public static final FluxzeroErrorCode TRACKING_RUNTIME_FAILED
      Tracking failed while storing position or managing tracker state.

  • Field Details

    • DOCUMENTATION_BASE_URL

      public static final String DOCUMENTATION_BASE_URL
      Default documentation root for SDK error pages.
      See Also:

  • Method Details

    • values

      public static FluxzeroErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FluxzeroErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public String getCode()
      Returns the stable machine-readable error code.

    • getDocumentationUrl

      public String getDocumentationUrl()
      Returns the canonical documentation URL for this error.