Package org.apache.camel.component.box
Class BoxConfiguration
java.lang.Object
org.apache.camel.component.box.BoxConfiguration
- Direct Known Subclasses:
BoxCollaborationsManagerEndpointConfiguration,BoxCommentsManagerEndpointConfiguration,BoxEventLogsManagerEndpointConfiguration,BoxEventsManagerEndpointConfiguration,BoxFilesManagerEndpointConfiguration,BoxFoldersManagerEndpointConfiguration,BoxGroupsManagerEndpointConfiguration,BoxSearchManagerEndpointConfiguration,BoxTasksManagerEndpointConfiguration,BoxUsersManagerEndpointConfiguration
Component configuration for Box component.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancom.box.sdk.IAccessTokenCacheCustom Access Token Cache for storing and retrieving access tokens.What kind of operation to performThe type of authentication for connection.Box application client IDBox application client secretcom.box.sdk.EncryptionAlgorithmThe type of encryption algorithm for JWT.The enterprise ID to use for an App Enterprise.Custom HTTP params for settings like proxy hostintThe maximum number of access tokens in cache.What sub operation to use for the selected operationThe private key for generating the JWT signature.The password for the private key.The ID for public key for validating the JWT signature.org.apache.camel.support.jsse.SSLContextParametersTo configure security using SSLContextParameters.The user ID to use for an App User.Box user name, MUST be providedBox user password, MUST be provided if authSecureStorage is not set, or returns null on first callinthashCode()voidsetAccessTokenCache(com.box.sdk.IAccessTokenCache accessTokenCache) Custom Access Token Cache for storing and retrieving access tokens.voidsetApiName(BoxApiName apiName) What kind of operation to performvoidsetAuthenticationType(String authenticationType) The type of authentication for connection.voidsetClientId(String clientId) Box application client IDvoidsetClientSecret(String clientSecret) Box application client secretvoidsetEncryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm) The type of encryption algorithm for JWT.voidsetEncryptionAlgorithm(String encryptionAlgorithm) voidsetEnterpriseId(String enterpriseId) The enterprise ID to use for an App Enterprise.voidsetHttpParams(Map<String, Object> httpParams) Custom HTTP params for settings like proxy hostvoidsetMaxCacheEntries(int maxCacheEntries) The maximum number of access tokens in cache.voidsetMaxCacheEntries(String maxCacheEntries) voidsetMethodName(String methodName) What sub operation to use for the selected operationvoidsetPrivateKeyFile(String privateKey) The private key for generating the JWT signature.voidsetPrivateKeyPassword(String privateKeyPassword) The password for the private key.voidsetPublicKeyId(String publicKeyId) The ID for public key for validating the JWT signature.voidsetSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.voidThe user ID to use for an App User.voidsetUserName(String userName) Box user name, MUST be providedvoidsetUserPassword(String userPassword) Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call
-
Field Details
-
APP_ENTERPRISE_AUTHENTICATION
Authentication Types for Connection- See Also:
-
APP_USER_AUTHENTICATION
- See Also:
-
STANDARD_AUTHENTICATION
- See Also:
-
RSA_SHA_512
Encryption Algorithm Types for Server Authentication.- See Also:
-
RSA_SHA_384
- See Also:
-
RSA_SHA_256
- See Also:
-
-
Constructor Details
-
BoxConfiguration
public BoxConfiguration()
-
-
Method Details
-
getApiName
What kind of operation to perform- Returns:
- the API Name
-
setApiName
What kind of operation to perform- Parameters:
apiName- the API Name to set
-
getMethodName
What sub operation to use for the selected operation- Returns:
- the methodName
-
setMethodName
What sub operation to use for the selected operation- Parameters:
methodName- the methodName to set
-
getEnterpriseId
The enterprise ID to use for an App Enterprise.- Returns:
- the enterpriseId
-
setEnterpriseId
The enterprise ID to use for an App Enterprise.- Parameters:
enterpriseId- the enterpriseId to set
-
getUserId
The user ID to use for an App User.- Returns:
- the userId
-
setUserId
The user ID to use for an App User.- Parameters:
userId- the userId to set
-
getPublicKeyId
The ID for public key for validating the JWT signature.- Returns:
- the publicKeyId
-
setPublicKeyId
The ID for public key for validating the JWT signature.- Parameters:
publicKeyId- the publicKeyId to set
-
getPrivateKeyFile
The private key for generating the JWT signature.- Returns:
- the privateKey
-
setPrivateKeyFile
The private key for generating the JWT signature.- Parameters:
privateKey- the privateKey to set
-
getPrivateKeyPassword
The password for the private key.- Returns:
- the privateKeyPassword
-
setPrivateKeyPassword
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
-
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
-
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
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
Box application client ID- Returns:
- the clientId
-
setClientId
Box application client ID- Parameters:
clientId- the clientId to set
-
getClientSecret
Box application client secret- Returns:
- the clientSecret
-
setClientSecret
Box application client secret- Parameters:
clientSecret- the clientSecret to set
-
getUserName
Box user name, MUST be provided- Returns:
- the userName
-
setUserName
Box user name, MUST be provided- Parameters:
userName- the userName to set
-
getUserPassword
Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call- Returns:
- the userPassword
-
setUserPassword
Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call- Parameters:
userPassword- the userPassword to set
-
getHttpParams
Custom HTTP params for settings like proxy host- Returns:
- the httpParams
-
setHttpParams
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
-
hashCode
public int hashCode()
-