com.dropbox.core.DbxException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropbox-core-sdk Show documentation

Official Java client library for the Dropbox API.

There is a newer version: 7.0.0

package com.dropbox.core;

import java.io.IOException;

/**
 * The base exception thrown by Dropbox API calls.  Normally, you'll need to do something specific
 * for {@link InvalidAccessTokenException} and possibly for {@link RetryException}.  The rest you
 * should probably just log and investigate manually.
 */
public class DbxException extends Exception {
    private static final long serialVersionUID = 0L;

    private final String requestId;

    public DbxException(String message) {
        this(null, message);
    }

    public DbxException(String requestId, String message) {
        super(message);
        this.requestId = requestId;
    }

    public DbxException(String message, Throwable cause) {
        this(null, message, cause);
    }

    public DbxException(String requestId, String message, Throwable cause) {
        super(message, cause);
        this.requestId = requestId;
    }

    /**
     * Return the unique ID associated with the request that triggered this exception.
     *
     *  The ID may be {@code null} if we could not receive a response from the Dropbox servers
     * (e.g. from a {@link NetworkIOException}).
     *
     *  Please use this ID when filing bug reports.
     *
     * @return unique ID associated with the request that caused this exception, or {@code null} if
     * one is not available.
     */
    public String getRequestId() {
        return requestId;
    }
}