com.ampro.robinhood

Class Configuration

java.lang.Object

com.ampro.robinhood.Configuration

public class Configuration
extends java.lang.Object

The Configuration stores authorization information about an instance of the RobinhoodApi.

Many things (mostly ApiMethods) require a Configuration to function

Constructor Summary

Constructors

Constructor and Description
Configuration() Construct a Configuration with no data

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all user data from the Configuration.
java.lang.String	getAccountNumber()
java.lang.String	getAccountUrl() Method returning the Account URL for the logged in user.
AuthorizationData	getAuthData()
static Configuration	getDefault()
static long	getRatelimit()
java.lang.String	getToken() Method which gets the saved authorization token if the user is logged in.
boolean	hasToken() Whether or not an authToken exists.
void	setAccountNumber(java.lang.String accountNumber)
void	setAuthData(AuthorizationData authData)
void	setAuthToken(java.lang.String token) Method which registers the authToken for the user into the Configuration Manager
static void	setRatelimit(int newRateLimitValue) Set a new ratelimit (in milliseconds)

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Construct a Configuration with no data

Method Detail

getAuthData

public AuthorizationData getAuthData()

Returns:

The saved AuthorizationData

setAuthData

public void setAuthData(AuthorizationData authData)

Parameters:

authData - The new AuthorizationData

hasToken

public boolean hasToken()

Whether or not an authToken exists. If an authToken does not exist than there is no current logged in user.

Returns:

true if an authToken exists

getToken

public java.lang.String getToken()

Method which gets the saved authorization token if the user is logged in. If one does not exist, it throws an error reminding the user to run the login functions first.

Returns:

the saved Token for the logged in user

Throws:

NotLoggedInException - if there is no stored Token. This must be populated by the setToken() method first

setAuthToken

public void setAuthToken(java.lang.String token)

Method which registers the authToken for the user into the Configuration Manager

Parameters:

token - verified Authorization Token for the user

getAccountNumber

public java.lang.String getAccountNumber()

Returns:

The account number

Throws:

NotLoggedInException - If the Configuration is not logged in

setAccountNumber

public void setAccountNumber(java.lang.String accountNumber)

getAccountUrl

public java.lang.String getAccountUrl()

Method returning the Account URL for the logged in user. This is created by appending the account number to a base URL. This is valid in most order requests.

Returns:

the account URL

Throws:

NotLoggedInException - If the Configuration is not logged in

getDefault

public static Configuration getDefault()

Returns:

The default Configuration (i.e. with no account data)

getRatelimit

public static long getRatelimit()

Returns:

the current ratelimit. By default, this is 500 milliseconds (.5 seconds)

setRatelimit

public static void setRatelimit(int newRateLimitValue)

Set a new ratelimit (in milliseconds)

Parameters:

newRateLimitValue - The new RateLimit in milliseconds

clear

public void clear()

Clears all user data from the Configuration.