java.lang.Object
- org.apache.camel.component.box.BoxConfiguration

Direct Known Subclasses:

BoxCollaborationsManagerEndpointConfiguration, BoxCommentsManagerEndpointConfiguration, BoxEventLogsManagerEndpointConfiguration, BoxEventsManagerEndpointConfiguration, BoxFilesManagerEndpointConfiguration, BoxFoldersManagerEndpointConfiguration, BoxGroupsManagerEndpointConfiguration, BoxSearchManagerEndpointConfiguration, BoxTasksManagerEndpointConfiguration, BoxUsersManagerEndpointConfiguration
```
@UriParams
@Configurer(extended=true)
public class BoxConfiguration
extends Object
```
Component configuration for Box component.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`APP_ENTERPRISE_AUTHENTICATION`	Authentication Types for Connection
`static String`	`APP_USER_AUTHENTICATION`
`static String`	`RSA_SHA_256`
`static String`	`RSA_SHA_384`
`static String`	`RSA_SHA_512`	Encryption Algorithm Types for Server Authentication.
`static String`	`STANDARD_AUTHENTICATION`

Constructor Summary

Constructors
Constructor Description

BoxConfiguration()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`com.box.sdk.IAccessTokenCache`	`getAccessTokenCache()`	Custom Access Token Cache for storing and retrieving access tokens.
`BoxApiName`	`getApiName()`	What kind of operation to perform
`String`	`getAuthenticationType()`	The type of authentication for connection.
`String`	`getClientId()`	Box application client ID
`String`	`getClientSecret()`	Box application client secret
`com.box.sdk.EncryptionAlgorithm`	`getEncryptionAlgorithm()`	The type of encryption algorithm for JWT.
`String`	`getEnterpriseId()`	The enterprise ID to use for an App Enterprise.
`Map<String,Object>`	`getHttpParams()`	Custom HTTP params for settings like proxy host
`int`	`getMaxCacheEntries()`	The maximum number of access tokens in cache.
`String`	`getMethodName()`	What sub operation to use for the selected operation
`String`	`getPrivateKeyFile()`	The private key for generating the JWT signature.
`String`	`getPrivateKeyPassword()`	The password for the private key.
`String`	`getPublicKeyId()`	The ID for public key for validating the JWT signature.
`org.apache.camel.support.jsse.SSLContextParameters`	`getSslContextParameters()`	To configure security using SSLContextParameters.
`String`	`getUserId()`	The user ID to use for an App User.
`String`	`getUserName()`	Box user name, MUST be provided
`String`	`getUserPassword()`	Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call
`int`	`hashCode()`
`void`	`setAccessTokenCache(com.box.sdk.IAccessTokenCache accessTokenCache)`	Custom Access Token Cache for storing and retrieving access tokens.
`void`	`setApiName(BoxApiName apiName)`	What kind of operation to perform
`void`	`setAuthenticationType(String authenticationType)`	The type of authentication for connection.
`void`	`setClientId(String clientId)`	Box application client ID
`void`	`setClientSecret(String clientSecret)`	Box application client secret
`void`	`setEncryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm)`	The type of encryption algorithm for JWT.
`void`	`setEncryptionAlgorithm(String encryptionAlgorithm)`
`void`	`setEnterpriseId(String enterpriseId)`	The enterprise ID to use for an App Enterprise.
`void`	`setHttpParams(Map<String,Object> httpParams)`	Custom HTTP params for settings like proxy host
`void`	`setMaxCacheEntries(int maxCacheEntries)`	The maximum number of access tokens in cache.
`void`	`setMaxCacheEntries(String maxCacheEntries)`
`void`	`setMethodName(String methodName)`	What sub operation to use for the selected operation
`void`	`setPrivateKeyFile(String privateKey)`	The private key for generating the JWT signature.
`void`	`setPrivateKeyPassword(String privateKeyPassword)`	The password for the private key.
`void`	`setPublicKeyId(String publicKeyId)`	The ID for public key for validating the JWT signature.
`void`	`setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)`	To configure security using SSLContextParameters.
`void`	`setUserId(String userId)`	The user ID to use for an App User.
`void`	`setUserName(String userName)`	Box user name, MUST be provided
`void`	`setUserPassword(String userPassword)`	Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - APP_ENTERPRISE_AUTHENTICATION
```
public static final String APP_ENTERPRISE_AUTHENTICATION
```
    Authentication Types for Connection
    
    See Also:
    
    Constant Field Values
  - APP_USER_AUTHENTICATION
```
public static final String APP_USER_AUTHENTICATION
```
    See Also:
    
    Constant Field Values
  - STANDARD_AUTHENTICATION
```
public static final String STANDARD_AUTHENTICATION
```
    See Also:
    
    Constant Field Values
  - RSA_SHA_512
```
public static final String RSA_SHA_512
```
    Encryption Algorithm Types for Server Authentication.
    
    See Also:
    
    Constant Field Values
  - RSA_SHA_384
```
public static final String RSA_SHA_384
```
    See Also:
    
    Constant Field Values
  - RSA_SHA_256
```
public static final String RSA_SHA_256
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BoxConfiguration
```
public BoxConfiguration()
```
- Method Detail
  - getApiName
```
public BoxApiName getApiName()
```
    What kind of operation to perform
    
    Returns:
    
    the API Name
  - setApiName
```
public void setApiName(BoxApiName apiName)
```
    What kind of operation to perform
    
    Parameters:
    
    apiName - the API Name to set
  - getMethodName
```
public String getMethodName()
```
    What sub operation to use for the selected operation
    
    Returns:
    
    the methodName
  - setMethodName
```
public void setMethodName(String methodName)
```
    What sub operation to use for the selected operation
    
    Parameters:
    
    methodName - the methodName to set
  - getEnterpriseId
```
public String getEnterpriseId()
```
    The enterprise ID to use for an App Enterprise.
    
    Returns:
    
    the enterpriseId
  - setEnterpriseId
```
public void setEnterpriseId(String enterpriseId)
```
    The enterprise ID to use for an App Enterprise.
    
    Parameters:
    
    enterpriseId - the enterpriseId to set
  - getUserId
```
public String getUserId()
```
    The user ID to use for an App User.
    
    Returns:
    
    the userId
  - setUserId
```
public void setUserId(String userId)
```
    The user ID to use for an App User.
    
    Parameters:
    
    userId - the userId to set
  - getPublicKeyId
```
public String getPublicKeyId()
```
    The ID for public key for validating the JWT signature.
    
    Returns:
    
    the publicKeyId
  - setPublicKeyId
```
public void setPublicKeyId(String publicKeyId)
```
    The ID for public key for validating the JWT signature.
    
    Parameters:
    
    publicKeyId - the publicKeyId to set
  - getPrivateKeyFile
```
public String getPrivateKeyFile()
```
    The private key for generating the JWT signature.
    
    Returns:
    
    the privateKey
  - setPrivateKeyFile
```
public void setPrivateKeyFile(String privateKey)
```
    The private key for generating the JWT signature.
    
    Parameters:
    
    privateKey - the privateKey to set
  - getPrivateKeyPassword
```
public String getPrivateKeyPassword()
```
    The password for the private key.
    
    Returns:
    
    the privateKeyPassword
  - setPrivateKeyPassword
```
public void setPrivateKeyPassword(String privateKeyPassword)
```
    The password for the private key.
    
    Parameters:
    
    privateKeyPassword - the privateKeyPassword to set
  - getMaxCacheEntries
```
public int getMaxCacheEntries()
```
    The maximum number of access tokens in cache.
    
    Returns:
    
    the maxCacheEntries
  - setMaxCacheEntries
```
public void setMaxCacheEntries(int maxCacheEntries)
```
    The maximum number of access tokens in cache.
    
    Parameters:
    
    maxCacheEntries - the maxCacheEntries to set
  - setMaxCacheEntries
```
public void setMaxCacheEntries(String maxCacheEntries)
```
  - getEncryptionAlgorithm
```
public com.box.sdk.EncryptionAlgorithm getEncryptionAlgorithm()
```
    The type of encryption algorithm for JWT.
    
    Returns:
    
    the encryptionAlgorithm
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm)
```
    The type of encryption algorithm for JWT.
    Supported Algorithms:
    
    RSA_SHA_256
    
    RSA_SHA_384
    
    RSA_SHA_512
    Parameters:
    
    encryptionAlgorithm - the encryptionAlgorithm to set
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(String encryptionAlgorithm)
```
  - getAuthenticationType
```
public String getAuthenticationType()
```
    The type of authentication for connection.
    Types of Authentication:
    
    STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged)
    
    SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens
    Returns:
    
    the authenticationType
  - setAuthenticationType
```
public void setAuthenticationType(String authenticationType)
```
    The type of authentication for connection.
    Types of Authentication:
    
    STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged)
    
    SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens
    Parameters:
    
    authenticationType - the authenticationType to set
  - getClientId
```
public String getClientId()
```
    Box application client ID
    
    Returns:
    
    the clientId
  - setClientId
```
public void setClientId(String clientId)
```
    Box application client ID
    
    Parameters:
    
    clientId - the clientId to set
  - getClientSecret
```
public String getClientSecret()
```
    Box application client secret
    
    Returns:
    
    the clientSecret
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    Box application client secret
    
    Parameters:
    
    clientSecret - the clientSecret to set
  - getUserName
```
public String getUserName()
```
    Box user name, MUST be provided
    
    Returns:
    
    the userName
  - setUserName
```
public void setUserName(String userName)
```
    Box user name, MUST be provided
    
    Parameters:
    
    userName - the userName to set
  - getUserPassword
```
public String getUserPassword()
```
    Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call
    
    Returns:
    
    the userPassword
  - setUserPassword
```
public void setUserPassword(String userPassword)
```
    Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call
    
    Parameters:
    
    userPassword - the userPassword to set
  - getHttpParams
```
public Map<String,Object> getHttpParams()
```
    Custom HTTP params for settings like proxy host
    
    Returns:
    
    the httpParams
  - setHttpParams
```
public void setHttpParams(Map<String,Object> httpParams)
```
    Custom HTTP params for settings like proxy host
    
    Parameters:
    
    httpParams - the httpParams to set
  - getSslContextParameters
```
public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()
```
    To configure security using SSLContextParameters.
    
    Returns:
    
    the sslContextParameters
  - setSslContextParameters
```
public void setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
```
    To configure security using SSLContextParameters.
    
    Parameters:
    
    sslContextParameters - the sslContextParameters to set
  - getAccessTokenCache
```
public com.box.sdk.IAccessTokenCache getAccessTokenCache()
```
    Custom Access Token Cache for storing and retrieving access tokens.
    
    Returns:
    
    Custom Access Token Cache
  - setAccessTokenCache
```
public void setAccessTokenCache(com.box.sdk.IAccessTokenCache accessTokenCache)
```
    Custom Access Token Cache for storing and retrieving access tokens.
    
    Parameters:
    
    accessTokenCache - - the Custom Access Token Cache
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class BoxConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APP_ENTERPRISE_AUTHENTICATION

APP_USER_AUTHENTICATION

STANDARD_AUTHENTICATION

RSA_SHA_512

RSA_SHA_384

RSA_SHA_256

Constructor Detail

BoxConfiguration

Method Detail

getApiName

setApiName

getMethodName

setMethodName

getEnterpriseId

setEnterpriseId

getUserId

setUserId

getPublicKeyId

setPublicKeyId

getPrivateKeyFile

setPrivateKeyFile

getPrivateKeyPassword

setPrivateKeyPassword

getMaxCacheEntries

setMaxCacheEntries

setMaxCacheEntries

getEncryptionAlgorithm

setEncryptionAlgorithm

setEncryptionAlgorithm

getAuthenticationType

setAuthenticationType

getClientId

setClientId

getClientSecret

setClientSecret

getUserName

setUserName

getUserPassword

setUserPassword

getHttpParams

setHttpParams

getSslContextParameters

setSslContextParameters

getAccessTokenCache

setAccessTokenCache

equals

hashCode