Package com.dropbox.core.v2.auth

Class AuthError

java.lang.Object

com.dropbox.core.v2.auth.AuthError

public final class AuthError
extends Object

Errors occurred during authentication.

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthError.Serializer	For internal use only.
static enum	AuthError.Tag	Discriminating tag type for AuthError.

Field Summary

Fields

Modifier and Type	Field	Description
static final AuthError	EXPIRED_ACCESS_TOKEN	The access token has expired.
static final AuthError	INVALID_ACCESS_TOKEN	The access token is invalid.
static final AuthError	INVALID_SELECT_ADMIN	The user specified in 'Dropbox-API-Select-Admin' is not a Dropbox Business team admin.
static final AuthError	INVALID_SELECT_USER	The user specified in 'Dropbox-API-Select-User' is no longer on the team.
static final AuthError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final AuthError	ROUTE_ACCESS_DENIED	The route is not available to public.
static final AuthError	USER_SUSPENDED	The user has been suspended.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
TokenScopeError	getMissingScopeValue()	The access token does not have the required scope to access the route.
int	hashCode()
boolean	isExpiredAccessToken()	Returns true if this instance has the tag AuthError.Tag.EXPIRED_ACCESS_TOKEN, false otherwise.
boolean	isInvalidAccessToken()	Returns true if this instance has the tag AuthError.Tag.INVALID_ACCESS_TOKEN, false otherwise.
boolean	isInvalidSelectAdmin()	Returns true if this instance has the tag AuthError.Tag.INVALID_SELECT_ADMIN, false otherwise.
boolean	isInvalidSelectUser()	Returns true if this instance has the tag AuthError.Tag.INVALID_SELECT_USER, false otherwise.
boolean	isMissingScope()	Returns true if this instance has the tag AuthError.Tag.MISSING_SCOPE, false otherwise.
boolean	isOther()	Returns true if this instance has the tag AuthError.Tag.OTHER, false otherwise.
boolean	isRouteAccessDenied()	Returns true if this instance has the tag AuthError.Tag.ROUTE_ACCESS_DENIED, false otherwise.
boolean	isUserSuspended()	Returns true if this instance has the tag AuthError.Tag.USER_SUSPENDED, false otherwise.
static AuthError	missingScope(TokenScopeError value)	Returns an instance of AuthError that has its tag set to AuthError.Tag.MISSING_SCOPE.
AuthError.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INVALID_ACCESS_TOKEN

public static final AuthError INVALID_ACCESS_TOKEN

The access token is invalid.

INVALID_SELECT_USER

public static final AuthError INVALID_SELECT_USER

The user specified in 'Dropbox-API-Select-User' is no longer on the team.

INVALID_SELECT_ADMIN

public static final AuthError INVALID_SELECT_ADMIN

The user specified in 'Dropbox-API-Select-Admin' is not a Dropbox Business team admin.

USER_SUSPENDED

public static final AuthError USER_SUSPENDED

The user has been suspended.

EXPIRED_ACCESS_TOKEN

public static final AuthError EXPIRED_ACCESS_TOKEN

The access token has expired.

ROUTE_ACCESS_DENIED

public static final AuthError ROUTE_ACCESS_DENIED

The route is not available to public.

OTHER

public static final AuthError OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

public AuthError.Tag tag()

Returns the tag for this instance.

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this AuthError.

If a tag returned by the server is unrecognized by this SDK, the AuthError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isInvalidAccessToken

public boolean isInvalidAccessToken()

Returns true if this instance has the tag AuthError.Tag.INVALID_ACCESS_TOKEN, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.INVALID_ACCESS_TOKEN, false otherwise.

isInvalidSelectUser

public boolean isInvalidSelectUser()

Returns true if this instance has the tag AuthError.Tag.INVALID_SELECT_USER, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.INVALID_SELECT_USER, false otherwise.

isInvalidSelectAdmin

public boolean isInvalidSelectAdmin()

Returns true if this instance has the tag AuthError.Tag.INVALID_SELECT_ADMIN, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.INVALID_SELECT_ADMIN, false otherwise.

isUserSuspended

public boolean isUserSuspended()

Returns true if this instance has the tag AuthError.Tag.USER_SUSPENDED, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.USER_SUSPENDED, false otherwise.

isExpiredAccessToken

public boolean isExpiredAccessToken()

Returns true if this instance has the tag AuthError.Tag.EXPIRED_ACCESS_TOKEN, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.EXPIRED_ACCESS_TOKEN, false otherwise.

isMissingScope

public boolean isMissingScope()

Returns true if this instance has the tag AuthError.Tag.MISSING_SCOPE, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.MISSING_SCOPE, false otherwise.

missingScope

public static AuthError missingScope(TokenScopeError value)

Returns an instance of AuthError that has its tag set to AuthError.Tag.MISSING_SCOPE.

The access token does not have the required scope to access the route.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AuthError with its tag set to AuthError.Tag.MISSING_SCOPE.

Throws:

IllegalArgumentException - if value is null.

getMissingScopeValue

public TokenScopeError getMissingScopeValue()

The access token does not have the required scope to access the route.

This instance must be tagged as AuthError.Tag.MISSING_SCOPE.

Returns:

The TokenScopeError value associated with this instance if isMissingScope() is true.

Throws:

IllegalStateException - If isMissingScope() is false.

isRouteAccessDenied

public boolean isRouteAccessDenied()

Returns true if this instance has the tag AuthError.Tag.ROUTE_ACCESS_DENIED, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.ROUTE_ACCESS_DENIED, false otherwise.

isOther

public boolean isOther()

Returns true if this instance has the tag AuthError.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as AuthError.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object