Package org.craftercms.commons.config.profiles.box

Class BoxProfile

java.lang.Object

org.craftercms.commons.config.profiles.ConfigurationProfile

org.craftercms.commons.config.profiles.box.BoxProfile

public class BoxProfile
extends ConfigurationProfile

Holds the credentials to open a connection using the Box API. All values are provided by the Box Developer Console.

Author:

joseross

See Also:

Official Box API documentation

Field Summary

Fields

Modifier and Type	Field	Description
protected String	clientId	Box API Client ID
protected String	clientSecret	Box API Client Secret
protected String	enterpriseId	Box API Enterprise ID
protected String	privateKey	RSA Private Key, the encrypted private key
protected String	privateKeyPassword	RSA Public Key Password, used to decrypt the private key
protected String	publicKeyId	RSA Public Key ID, the public key can be uploaded or generated from the Box Developer Console
protected String	uploadFolder	Folder where the files will be uploaded, it will be created if it doesn't exist

Fields inherited from class org.craftercms.commons.config.profiles.ConfigurationProfile

profileId

Constructor Summary

Constructors

Constructor	Description
BoxProfile()

Method Summary

Modifier and Type	Method	Description
String	getClientId()
String	getClientSecret()
String	getEnterpriseId()
String	getPrivateKey()
String	getPrivateKeyPassword()
String	getPublicKeyId()
String	getUploadFolder()
void	setClientId(String clientId)
void	setClientSecret(String clientSecret)
void	setEnterpriseId(String enterpriseId)
void	setPrivateKey(String privateKey)
void	setPrivateKeyPassword(String privateKeyPassword)
void	setPublicKeyId(String publicKeyId)
void	setUploadFolder(String uploadFolder)

Methods inherited from class org.craftercms.commons.config.profiles.ConfigurationProfile

equals, getProfileId, hashCode, setProfileId

Methods inherited from class java.lang.Object

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

Field Detail

clientId

protected String clientId

Box API Client ID

clientSecret

protected String clientSecret

Box API Client Secret

enterpriseId

protected String enterpriseId

Box API Enterprise ID

publicKeyId

protected String publicKeyId

RSA Public Key ID, the public key can be uploaded or generated from the Box Developer Console

privateKey

protected String privateKey

RSA Private Key, the encrypted private key

privateKeyPassword

protected String privateKeyPassword

RSA Public Key Password, used to decrypt the private key

uploadFolder

protected String uploadFolder

Folder where the files will be uploaded, it will be created if it doesn't exist

Constructor Detail

BoxProfile

public BoxProfile()

Method Detail

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getClientSecret

public String getClientSecret()

setClientSecret

public void setClientSecret(String clientSecret)

getEnterpriseId

public String getEnterpriseId()

setEnterpriseId

public void setEnterpriseId(String enterpriseId)

getPublicKeyId

public String getPublicKeyId()

setPublicKeyId

public void setPublicKeyId(String publicKeyId)

getPrivateKey

public String getPrivateKey()

setPrivateKey

public void setPrivateKey(String privateKey)

getPrivateKeyPassword

public String getPrivateKeyPassword()

setPrivateKeyPassword

public void setPrivateKeyPassword(String privateKeyPassword)

getUploadFolder

public String getUploadFolder()

setUploadFolder

public void setUploadFolder(String uploadFolder)