com.rollbar.notifier.sender.SenderFailureStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rollbar-java Show documentation

For connecting your applications built on the JVM to Rollbar for Error Reporting

There is a newer version: 2.0.0-alpha.1

package com.rollbar.notifier.sender;

import com.rollbar.api.payload.Payload;
import com.rollbar.notifier.sender.result.Response;

import java.io.Closeable;

/**
 * Interface for strategy classes to deal with sending failures.
 * 
 * A SenderFailureStrategy determines the action to take when a payload cannot be sent, for example
 * to suspend the sending of occurrences while the network is down.
 * 
 */
public interface SenderFailureStrategy extends Closeable {
  /**
   * Get the action to perform after the payload has been sent.
   *
   * @param payload The payload that was sent
   * @param response The server's response
   * @return Non-null Action instance
   */
  PayloadAction getAction(Payload payload, Response response);

  /**
   * Get the action to perform after the error.
   *
   * @param payload The payload that the sender attempted to send
   * @param error The error that occurred
   * @return Non-null Action instance
   */
  PayloadAction getAction(Payload payload, Exception error);

  /**
   * Is sending of occurrences currently suspended.
   *
   * @return true if sending occurrences is currently suspended
   */
  boolean isSendingSuspended();

  enum PayloadAction {
    /**
     * No further action on the payload is necessary.
     */
    NONE,
    /**
     * 
     *     Sending the occurrence wasn't successful for a reason that warrants a retry (eg. a
     *     network connection wasn't available at the time.)
     * 
     * 
     *     Note the sender might still choose not to retry for other reasons, eg. there have been
     *     too many attempts to send the same payload.
     * 
     */
    CAN_BE_RETRIED
  }
}