com.box.sdkgen.box.jwtauth

Class JWTConfig

Object

JWTConfig

public class JWTConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JWTConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
EnumWrapper<JwtAlgorithm>	algorithm
String	clientId App client ID
String	clientSecret App client secret
String	enterpriseId Enterprise ID
String	jwtKeyId Public key ID
String	privateKey Private key
PrivateKeyDecryptor	privateKeyDecryptor
String	privateKeyPassphrase Passphrase
TokenStorage	tokenStorage
String	userId User ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JWTConfig(JWTConfig.Builder builder)
	JWTConfig(String clientId, String clientSecret, String jwtKeyId, String privateKey, String privateKeyPassphrase)

Method Summary

Modifier and Type	Method and Description
static JWTConfig	fromConfigFile(String configFilePath) Create an auth instance as defined by a JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigFile(String configFilePath, PrivateKeyDecryptor privateKeyDecryptor) Create an auth instance as defined by a JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigFile(String configFilePath, TokenStorage tokenStorage) Create an auth instance as defined by a JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigFile(String configFilePath, TokenStorage tokenStorage, PrivateKeyDecryptor privateKeyDecryptor) Create an auth instance as defined by a JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigJsonString(String configJsonString) Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigJsonString(String configJsonString, PrivateKeyDecryptor privateKeyDecryptor) Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigJsonString(String configJsonString, TokenStorage tokenStorage) Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console.
static JWTConfig	fromConfigJsonString(String configJsonString, TokenStorage tokenStorage, PrivateKeyDecryptor privateKeyDecryptor) Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console.
EnumWrapper<JwtAlgorithm>	getAlgorithm()
String	getClientId()
String	getClientSecret()
String	getEnterpriseId()
String	getJwtKeyId()
String	getPrivateKey()
PrivateKeyDecryptor	getPrivateKeyDecryptor()
String	getPrivateKeyPassphrase()
TokenStorage	getTokenStorage()
String	getUserId()

Methods inherited from class Object

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

Field Detail

clientId

public final String clientId

App client ID

clientSecret

public final String clientSecret

App client secret

jwtKeyId

public final String jwtKeyId

Public key ID

privateKey

public final String privateKey

Private key

privateKeyPassphrase

public final String privateKeyPassphrase

Passphrase

enterpriseId

public String enterpriseId

Enterprise ID

userId

public String userId

User ID

algorithm

public EnumWrapper<JwtAlgorithm> algorithm

tokenStorage

public TokenStorage tokenStorage

privateKeyDecryptor

public PrivateKeyDecryptor privateKeyDecryptor

Constructor Detail

JWTConfig

public JWTConfig(String clientId,
                 String clientSecret,
                 String jwtKeyId,
                 String privateKey,
                 String privateKeyPassphrase)

JWTConfig

protected JWTConfig(JWTConfig.Builder builder)

Method Detail

fromConfigJsonString

public static JWTConfig fromConfigJsonString(String configJsonString)

Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configJsonString - String content of JSON file containing the configuration.

fromConfigJsonString

public static JWTConfig fromConfigJsonString(String configJsonString,
                                             TokenStorage tokenStorage)

Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configJsonString - String content of JSON file containing the configuration.

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

fromConfigJsonString

public static JWTConfig fromConfigJsonString(String configJsonString,
                                             PrivateKeyDecryptor privateKeyDecryptor)

Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configJsonString - String content of JSON file containing the configuration.

privateKeyDecryptor - Object responsible for decrypting private key for jwt auth. If no custom implementation provided, the DefaultPrivateKeyDecryptor will be used.

fromConfigJsonString

public static JWTConfig fromConfigJsonString(String configJsonString,
                                             TokenStorage tokenStorage,
                                             PrivateKeyDecryptor privateKeyDecryptor)

Create an auth instance as defined by a string content of JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configJsonString - String content of JSON file containing the configuration.

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

privateKeyDecryptor - Object responsible for decrypting private key for jwt auth. If no custom implementation provided, the DefaultPrivateKeyDecryptor will be used.

fromConfigFile

public static JWTConfig fromConfigFile(String configFilePath)

Create an auth instance as defined by a JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configFilePath - Path to the JSON file containing the configuration.

fromConfigFile

public static JWTConfig fromConfigFile(String configFilePath,
                                       TokenStorage tokenStorage)

Create an auth instance as defined by a JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configFilePath - Path to the JSON file containing the configuration.

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

fromConfigFile

public static JWTConfig fromConfigFile(String configFilePath,
                                       PrivateKeyDecryptor privateKeyDecryptor)

Create an auth instance as defined by a JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configFilePath - Path to the JSON file containing the configuration.

privateKeyDecryptor - Object responsible for decrypting private key for jwt auth. If no custom implementation provided, the DefaultPrivateKeyDecryptor will be used.

fromConfigFile

public static JWTConfig fromConfigFile(String configFilePath,
                                       TokenStorage tokenStorage,
                                       PrivateKeyDecryptor privateKeyDecryptor)

Create an auth instance as defined by a JSON file downloaded from the Box Developer Console. See https://developer.box.com/en/guides/authentication/jwt/ for more information.

Parameters:

configFilePath - Path to the JSON file containing the configuration.

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

privateKeyDecryptor - Object responsible for decrypting private key for jwt auth. If no custom implementation provided, the DefaultPrivateKeyDecryptor will be used.

getClientId

public String getClientId()

getClientSecret

public String getClientSecret()

getJwtKeyId

public String getJwtKeyId()

getPrivateKey

public String getPrivateKey()

getPrivateKeyPassphrase

public String getPrivateKeyPassphrase()

getEnterpriseId

public String getEnterpriseId()

getUserId

public String getUserId()

getAlgorithm

public EnumWrapper<JwtAlgorithm> getAlgorithm()

getTokenStorage

public TokenStorage getTokenStorage()

getPrivateKeyDecryptor

public PrivateKeyDecryptor getPrivateKeyDecryptor()