com.ampro.robinhood.endpoint.authorize

Class AuthorizationData

java.lang.Object

com.ampro.robinhood.endpoint.authorize.AuthorizationData

All Implemented Interfaces:

ApiElement

public class AuthorizationData
extends java.lang.Object
implements ApiElement

A wrapper for both possible API login responses. It holds a token String, multifactor auth type and whether multifactor is required for the account.
MultifactorAuthorization (or Two-factor Authorization) is referred to as mfa by the Robinhood Api. (Robinhood calls it Two-Factor, but the Api calls it multifactor...).

Since:

0.8.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizationData.MultifactorType A wrapper for the types of multifactor authorizations.
static class	AuthorizationData.Token A wrapper for deserializing token strings from Robinhood

Constructor Summary

Constructors

Constructor and Description
AuthorizationData()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMfaCode()
AuthorizationData.MultifactorType	getMfaType()
java.lang.String	getToken()
boolean	mfaRequired()
void	setMfaCode(java.lang.String mfaCode)
void	setToken(AuthorizationData.Token newToken) Set the token used to authorize private ApiMethods.
void	setToken(java.lang.String newToken) Set the token used to authorize private ApiMethods.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ampro.robinhood.endpoint.ApiElement

requiresAuth

Constructor Detail

AuthorizationData

public AuthorizationData()

Method Detail

getToken

public java.lang.String getToken()

Returns:

The authorization token used to authorize private ApiMethods

setToken

public void setToken(java.lang.String newToken)

Set the token used to authorize private ApiMethods.

Parameters:

newToken - The new token

setToken

public void setToken(AuthorizationData.Token newToken)

Set the token used to authorize private ApiMethods.

Parameters:

newToken - The new token

setMfaCode

public void setMfaCode(java.lang.String mfaCode)

Parameters:

mfaCode - The new multifactor authorization code

getMfaCode

public java.lang.String getMfaCode()

Returns:

The code used to login with multifactor authorization

mfaRequired

public boolean mfaRequired()

Returns:

Whether multifactor authorization is required to log in

getMfaType

public AuthorizationData.MultifactorType getMfaType()

Returns:

The AuthorizationData.MultifactorType needed to login

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

[TOKEN=%s][MFA_CODE=%s][MFA_TYPE=%s][MFA_REQUIRED=%s]