com.box.sdkgen.box.oauth

Class BoxOAuth

Object

BoxOAuth

All Implemented Interfaces:

Authentication

public class BoxOAuth
extends Object
implements Authentication

Field Summary

Fields

Modifier and Type	Field and Description
OAuthConfig	config Configuration object of OAuth.
TokenStorage	tokenStorage An object responsible for storing token.

Constructor Summary

Constructors

Constructor and Description
BoxOAuth(OAuthConfig config)

Method Summary

Modifier and Type	Method and Description
AccessToken	downscopeToken(List<String> scopes, String resource, String sharedLink, NetworkSession networkSession) Downscope access token to the provided scopes.
String	getAuthorizeUrl() Get the authorization URL for the app user.
String	getAuthorizeUrl(GetAuthorizeUrlOptions options) Get the authorization URL for the app user.
AccessToken	getTokensAuthorizationCodeGrant(String authorizationCode) Acquires token info using an authorization code.
AccessToken	getTokensAuthorizationCodeGrant(String authorizationCode, NetworkSession networkSession) Acquires token info using an authorization code.
TokenStorage	getTokenStorage()
AccessToken	refreshToken() Get a new access token for the platform app user.
AccessToken	refreshToken(NetworkSession networkSession) Get a new access token for the platform app user.
String	retrieveAuthorizationHeader()
String	retrieveAuthorizationHeader(NetworkSession networkSession)
AccessToken	retrieveToken() Get the current access token.
AccessToken	retrieveToken(NetworkSession networkSession) Get the current access token.
void	revokeToken() Revoke an active Access Token, effectively logging a user out that has been previously authenticated.
void	revokeToken(NetworkSession networkSession) Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Methods inherited from class Object

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

Field Detail

config

public final OAuthConfig config

Configuration object of OAuth.

tokenStorage

public final TokenStorage tokenStorage

An object responsible for storing token. If no custom implementation provided, the token will be stored in memory.

Constructor Detail

BoxOAuth

public BoxOAuth(OAuthConfig config)

Method Detail

getAuthorizeUrl

public String getAuthorizeUrl()

Get the authorization URL for the app user.

getAuthorizeUrl

public String getAuthorizeUrl(GetAuthorizeUrlOptions options)

Get the authorization URL for the app user.

Parameters:

options - The options parameter

getTokensAuthorizationCodeGrant

public AccessToken getTokensAuthorizationCodeGrant(String authorizationCode)

Acquires token info using an authorization code.

Parameters:

authorizationCode - The authorization code to use to get tokens.

getTokensAuthorizationCodeGrant

public AccessToken getTokensAuthorizationCodeGrant(String authorizationCode,
                                                   NetworkSession networkSession)

Acquires token info using an authorization code.

Parameters:

authorizationCode - The authorization code to use to get tokens.

networkSession - An object to keep network session state

retrieveToken

public AccessToken retrieveToken()

Get the current access token. If the current access token is expired or not found, this method will attempt to refresh the token.

Specified by:

retrieveToken in interface Authentication

retrieveToken

public AccessToken retrieveToken(NetworkSession networkSession)

Get the current access token. If the current access token is expired or not found, this method will attempt to refresh the token.

Specified by:

retrieveToken in interface Authentication

Parameters:

networkSession - An object to keep network session state

refreshToken

public AccessToken refreshToken()

Get a new access token for the platform app user.

Specified by:

refreshToken in interface Authentication

refreshToken

public AccessToken refreshToken(NetworkSession networkSession)

Get a new access token for the platform app user.

Specified by:

refreshToken in interface Authentication

Parameters:

networkSession - An object to keep network session state

retrieveAuthorizationHeader

public String retrieveAuthorizationHeader()

Specified by:

retrieveAuthorizationHeader in interface Authentication

retrieveAuthorizationHeader

public String retrieveAuthorizationHeader(NetworkSession networkSession)

Specified by:

retrieveAuthorizationHeader in interface Authentication

revokeToken

public void revokeToken()

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Specified by:

revokeToken in interface Authentication

revokeToken

public void revokeToken(NetworkSession networkSession)

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Specified by:

revokeToken in interface Authentication

Parameters:

networkSession - An object to keep network session state

downscopeToken

public AccessToken downscopeToken(List<String> scopes,
                                  String resource,
                                  String sharedLink,
                                  NetworkSession networkSession)

Downscope access token to the provided scopes. Returning a new access token with the provided scopes, with the original access token unchanged.

Specified by:

downscopeToken in interface Authentication

Parameters:

scopes - The scope(s) to apply to the resulting token.

resource - The file or folder to get a downscoped token for. If None and shared_link None, the resulting token will not be scoped down to just a single item. The resource should be a full URL to an item, e.g. https://api.box.com/2.0/files/123456.

sharedLink - The shared link to get a downscoped token for. If None and item None, the resulting token will not be scoped down to just a single item.

networkSession - An object to keep network session state

getTokenStorage

public TokenStorage getTokenStorage()