com.box.sdkgen.box.ccgauth

Class BoxCCGAuth

Object

BoxCCGAuth

All Implemented Interfaces:

Authentication

public class BoxCCGAuth
extends Object
implements Authentication

Field Summary

Fields

Modifier and Type	Field and Description
CCGConfig	config Configuration object of Client Credentials Grant auth.
String	subjectId The ID of the user or enterprise to authenticate as.
EnumWrapper<PostOAuth2TokenBoxSubjectTypeField>	subjectType The type of the subject ID provided.
TokenStorage	tokenStorage An object responsible for storing token.

Constructor Summary

Constructors

Constructor and Description
BoxCCGAuth(CCGConfig 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.
TokenStorage	getTokenStorage()
AccessToken	refreshToken() Get a new access token using CCG auth
AccessToken	refreshToken(NetworkSession networkSession) Get a new access token using CCG auth
String	retrieveAuthorizationHeader()
String	retrieveAuthorizationHeader(NetworkSession networkSession)
AccessToken	retrieveToken() Return a current token or get a new one when not available.
AccessToken	retrieveToken(NetworkSession networkSession) Return a current token or get a new one when not available.
void	revokeToken() Revoke the current access token and remove it from token storage.
void	revokeToken(NetworkSession networkSession) Revoke the current access token and remove it from token storage.
BoxCCGAuth	withEnterpriseSubject(String enterpriseId) Create a new BoxCCGAuth instance that uses the provided enterprise ID as the subject ID.
BoxCCGAuth	withEnterpriseSubject(String enterpriseId, TokenStorage tokenStorage) Create a new BoxCCGAuth instance that uses the provided enterprise ID as the subject ID.
BoxCCGAuth	withUserSubject(String userId) Create a new BoxCCGAuth instance that uses the provided user ID as the subject ID.
BoxCCGAuth	withUserSubject(String userId, TokenStorage tokenStorage) Create a new BoxCCGAuth instance that uses the provided user ID as the subject ID.

Methods inherited from class Object

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

Field Detail

config

public final CCGConfig config

Configuration object of Client Credentials Grant auth.

tokenStorage

public final TokenStorage tokenStorage

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

subjectId

public String subjectId

The ID of the user or enterprise to authenticate as. If not provided, defaults to the enterprise ID if set, otherwise defaults to the user ID.

subjectType

public EnumWrapper<PostOAuth2TokenBoxSubjectTypeField> subjectType

The type of the subject ID provided. Must be either 'user' or 'enterprise'.

Constructor Detail

BoxCCGAuth

public BoxCCGAuth(CCGConfig config)

Method Detail

refreshToken

public AccessToken refreshToken()

Get a new access token using CCG auth

Specified by:

refreshToken in interface Authentication

refreshToken

public AccessToken refreshToken(NetworkSession networkSession)

Get a new access token using CCG auth

Specified by:

refreshToken in interface Authentication

Parameters:

networkSession - An object to keep network session state

retrieveToken

public AccessToken retrieveToken()

Return a current token or get a new one when not available.

Specified by:

retrieveToken in interface Authentication

retrieveToken

public AccessToken retrieveToken(NetworkSession networkSession)

Return a current token or get a new one when not available.

Specified by:

retrieveToken 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

withUserSubject

public BoxCCGAuth withUserSubject(String userId)

Create a new BoxCCGAuth instance that uses the provided user ID as the subject ID. May be one of this application's created App User. Depending on the configured User Access Level, may also be any other App User or Managed User in the enterprise. <https://developer.box.com/en/guides/applications/> <https://developer.box.com/en/guides/authentication/select/>

Parameters:

userId - The id of the user to authenticate

withUserSubject

public BoxCCGAuth withUserSubject(String userId,
                                  TokenStorage tokenStorage)

Create a new BoxCCGAuth instance that uses the provided user ID as the subject ID. May be one of this application's created App User. Depending on the configured User Access Level, may also be any other App User or Managed User in the enterprise. <https://developer.box.com/en/guides/applications/> <https://developer.box.com/en/guides/authentication/select/>

Parameters:

userId - The id of the user to authenticate

tokenStorage - Object responsible for storing token in newly created BoxCCGAuth. If no custom implementation provided, the token will be stored in memory.

withEnterpriseSubject

public BoxCCGAuth withEnterpriseSubject(String enterpriseId)

Create a new BoxCCGAuth instance that uses the provided enterprise ID as the subject ID.

Parameters:

enterpriseId - The id of the enterprise to authenticate

withEnterpriseSubject

public BoxCCGAuth withEnterpriseSubject(String enterpriseId,
                                        TokenStorage tokenStorage)

Create a new BoxCCGAuth instance that uses the provided enterprise ID as the subject ID.

Parameters:

enterpriseId - The id of the enterprise to authenticate

tokenStorage - Object responsible for storing token in newly created BoxCCGAuth. If no custom implementation provided, the token will be stored in memory.

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

revokeToken

public void revokeToken()

Revoke the current access token and remove it from token storage.

Specified by:

revokeToken in interface Authentication

revokeToken

public void revokeToken(NetworkSession networkSession)

Revoke the current access token and remove it from token storage.

Specified by:

revokeToken in interface Authentication

Parameters:

networkSession - An object to keep network session state

getTokenStorage

public TokenStorage getTokenStorage()