Package com.dropbox.core

Class RetryException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.dropbox.core.DbxException

com.dropbox.core.RetryException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RateLimitException

public class RetryException
extends DbxException

A transient exception has occurred and the request should be retried. Clients should only retry requests after waiting the requested backoff duration (see getBackoffMillis()).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RetryException(String requestId, String message)	Creates an instance of this exception with no retry backoff.
RetryException(String requestId, String message, long backoff, TimeUnit unit)	Creates an instance of this exception with the given retry backoff.

Method Summary

Modifier and Type	Method	Description
long	getBackoffMillis()	Returns the number of milliseconds the client should backoff before retrying the request.

Methods inherited from class com.dropbox.core.DbxException

getRequestId

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RetryException

public RetryException(String requestId,
 String message)

Creates an instance of this exception with no retry backoff.

Parameters:

requestId - ID assigned to request by Dropbox servers

message - Error message

RetryException

public RetryException(String requestId,
 String message,
 long backoff,
 TimeUnit unit)

Creates an instance of this exception with the given retry backoff.

Parameters:

requestId - ID assigned to request by Dropbox servers

message - Error message

backoff - amount of time to backoff before retrying the request

unit - unit of time for backoff

Method Details

getBackoffMillis

public long getBackoffMillis()

Returns the number of milliseconds the client should backoff before retrying the request.

Returns:

backoff time, in milliseconds, before retrying the request, or 0 if the request can be retried immediately.