com.dropbox.core

Class DbxAppInfo

java.lang.Object

com.dropbox.core.util.Dumpable

com.dropbox.core.DbxAppInfo

All Implemented Interfaces:

Serializable

public class DbxAppInfo
extends Dumpable
implements Serializable

Identifying information about your application.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
DbxHost	host This is almost always DbxHost.Default.
String	key Your Dropbox app key (OAuth calls this the consumer key).
static JsonReader<String>	KeyReader
static JsonReader<DbxAppInfo>	Reader
String	secret Your Dropbox app secret (OAuth calls this the consumer secret).
static JsonReader<String>	SecretReader
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
DbxAppInfo(String key, String secret)
DbxAppInfo(String key, String secret, DbxHost host)

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkKeyArg(String key)
static void	checkSecretArg(String secret)
protected void	dumpFields(DumpWriter out)
static String	getKeyFormatError(String key) If they key's format looks correct, return null.
static String	getSecretFormatError(String key) If they secret's format looks correct, return null.
static String	getTokenPartError(String s)

Methods inherited from class com.dropbox.core.util.Dumpable

getTypeName, toString, toString, toStringMultiline, toStringMultiline

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

key

public final String key

Your Dropbox app key (OAuth calls this the consumer key). You can create an app key and secret on the Dropbox developer website.

secret

public final String secret

Your Dropbox app secret (OAuth calls this the consumer secret). You can create an app key and secret on the Dropbox developer website.

Make sure that this is kept a secret. Someone with your app secret can impesonate your application. People sometimes ask for help on the Dropbox API forums and copy/paste their code, which sometimes includes their app secret. Do not do that.

host

public final DbxHost host

This is almost always DbxHost.Default. This is only set differently for testing purposes.

Reader

public static final JsonReader<DbxAppInfo> Reader

KeyReader

public static final JsonReader<String> KeyReader

SecretReader

public static final JsonReader<String> SecretReader

Constructor Detail

DbxAppInfo

public DbxAppInfo(String key,
          String secret)

Parameters:

key - key

secret - secret

DbxAppInfo

public DbxAppInfo(String key,
          String secret,
          DbxHost host)

Parameters:

key - key

secret - secret

host - host

Method Detail

dumpFields

protected void dumpFields(DumpWriter out)

Specified by:

dumpFields in class Dumpable

getKeyFormatError

public static String getKeyFormatError(String key)

If they key's format looks correct, return null. Otherwise return a string that describes what the problem is.

NOTE: This function only performs some cursory checks on the format of the key. Even if it returns null (which means "no problem"), it doesn't mean that what you passed in is an actual valid Dropbox API app key.

getSecretFormatError

public static String getSecretFormatError(String key)

If they secret's format looks correct, return null. Otherwise return a string that describes what the problem is.

NOTE: This function only performs some cursory checks on the format. Even if it returns null (which means "no problem"), it doesn't mean that what you passed in is an actual valid Dropbox API app key.

getTokenPartError

public static String getTokenPartError(String s)

checkKeyArg

public static void checkKeyArg(String key)

checkSecretArg

public static void checkSecretArg(String secret)