com.box.sdkgen.box.developertokenauth

Class BoxDeveloperTokenAuth

Object

BoxDeveloperTokenAuth

All Implemented Interfaces:

Authentication

public class BoxDeveloperTokenAuth
extends Object
implements Authentication

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxDeveloperTokenAuth.Builder

Field Summary

Fields

Modifier and Type	Field and Description
DeveloperTokenConfig	config Configuration object of DeveloperTokenAuth.
String	token
TokenStorage	tokenStorage An object responsible for storing token.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BoxDeveloperTokenAuth(BoxDeveloperTokenAuth.Builder builder)
	BoxDeveloperTokenAuth(String token)

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.
TokenStorage	getTokenStorage()
AccessToken	refreshToken() Developer token cannot be refreshed
AccessToken	refreshToken(NetworkSession networkSession) Developer token cannot be refreshed
String	retrieveAuthorizationHeader()
String	retrieveAuthorizationHeader(NetworkSession networkSession)
AccessToken	retrieveToken() Retrieves stored developer token
AccessToken	retrieveToken(NetworkSession networkSession) Retrieves stored developer 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

token

public final String token

config

public DeveloperTokenConfig config

Configuration object of DeveloperTokenAuth.

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

BoxDeveloperTokenAuth

public BoxDeveloperTokenAuth(String token)

BoxDeveloperTokenAuth

protected BoxDeveloperTokenAuth(BoxDeveloperTokenAuth.Builder builder)

Method Detail

retrieveToken

public AccessToken retrieveToken()

Retrieves stored developer token

Specified by:

retrieveToken in interface Authentication

retrieveToken

public AccessToken retrieveToken(NetworkSession networkSession)

Retrieves stored developer token

Specified by:

retrieveToken in interface Authentication

Parameters:

networkSession - An object to keep network session state

refreshToken

public AccessToken refreshToken()

Developer token cannot be refreshed

Specified by:

refreshToken in interface Authentication

refreshToken

public AccessToken refreshToken(NetworkSession networkSession)

Developer token cannot be refreshed

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()