---
apiVersion: v1
kind: List
items:
- apiVersion: v1
kind: ConfigMap
metadata:
labels:
funktion.fabric8.io/kind: Connector
provider: fabric8
project: connector-braintree
version: 1.1.23
group: io.fabric8.funktion.connector
name: braintree
data:
deployment.yml: |
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
labels:
funktion.fabric8.io/kind: Subscription
connector: braintree
spec:
replicas: 1
template:
metadata:
labels:
funktion.fabric8.io/kind: Subscription
connector: braintree
spec:
containers:
- image: fabric8/connector-braintree:1.1.23
name: connector
schema.yml: |
---
component:
kind: component
scheme: braintree
syntax: braintree:apiName/methodName
title: Braintree
description: The braintree component is used for integrating with the Braintree Payment System.
label: api,cloud,payment
deprecated: false
async: false
javaType: org.apache.camel.component.braintree.BraintreeComponent
groupId: org.apache.camel
artifactId: camel-braintree
version: 2.18.1
componentProperties:
configuration:
kind: property
type: object
javaType: org.apache.camel.component.braintree.BraintreeConfiguration
deprecated: false
secret: false
description: To use the shared configuration
properties:
apiName:
kind: path
group: common
required: true
type: string
javaType: org.apache.camel.component.braintree.internal.BraintreeApiName
enum:
- ADDON
- ADDRESS
- CLIENTTOKEN
- CREDITCARDVERIFICATION
- CUSTOMER
- DISCOUNT
- MERCHANTACCOUNT
- PAYMENTMETHOD
- PAYMENTMETHODNONCE
- PLAN
- SETTLEMENTBATCHSUMMARY
- SUBSCRIPTION
- TRANSACTION
- WEBHOOKNOTIFICATION
deprecated: false
secret: false
description: What kind of operation to perform
methodName:
kind: path
group: common
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: What sub operation to use for the selected operation
environment:
kind: parameter
group: common
required: true
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: The environment Either SANDBOX or PRODUCTION
inBody:
kind: parameter
group: common
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: Sets the name of a parameter to be passed in the exchange In Body
merchantId:
kind: parameter
group: common
required: true
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: The merchant id provided by Braintree.
privateKey:
kind: parameter
group: common
required: true
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: The private key provided by Braintree.
publicKey:
kind: parameter
group: common
required: true
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: The public key provided by Braintree.
bridgeErrorHandler:
kind: parameter
group: consumer
label: consumer
type: boolean
javaType: boolean
optionalPrefix: consumer.
deprecated: false
secret: false
defaultValue: false
description: Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
exceptionHandler:
kind: parameter
group: consumer (advanced)
label: consumer,advanced
type: object
javaType: org.apache.camel.spi.ExceptionHandler
optionalPrefix: consumer.
deprecated: false
secret: false
description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
exchangePattern:
kind: parameter
group: consumer (advanced)
label: consumer,advanced
type: string
javaType: org.apache.camel.ExchangePattern
enum:
- InOnly
- RobustInOnly
- InOut
- InOptionalOut
- OutOnly
- RobustOutOnly
- OutIn
- OutOptionalIn
deprecated: false
secret: false
description: Sets the exchange pattern when the consumer creates an exchange.
httpReadTimeout:
kind: parameter
group: advanced
label: advanced
required: false
type: integer
javaType: java.lang.Integer
deprecated: false
secret: false
description: Set read timeout for http calls.
synchronous:
kind: parameter
group: advanced
label: advanced
type: boolean
javaType: boolean
deprecated: false
secret: false
defaultValue: false
description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
httpLogLevel:
kind: parameter
group: logging
label: advanced,logging
required: false
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: Set logging level for http calls see java.util.logging.Level
proxyHost:
kind: parameter
group: proxy
label: proxy
required: false
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: The proxy host
proxyPort:
kind: parameter
group: proxy
label: proxy
required: false
type: integer
javaType: java.lang.Integer
deprecated: false
secret: false
description: The proxy port
documentation.adoc: |
[[Braintree-BraintreeComponent]]
Braintree Component
~~~~~~~~~~~~~~~~~~~
*Available as of Camel 2.17*
The Braintree component provides access to
https://www.braintreepayments.com/[Braintree Payments] trough through
theirs https://developers.braintreepayments.com/start/hello-server/java[Java
SDK].
All client applications need API credential in order to process
payments. In order to use camel-braintree with your account, you'll need
to create a new
https://www.braintreepayments.com/get-started[Sandbox]??or??https://www.braintreepayments.com/signup[Production]
account.
Maven users will need to add the following dependency to their pom.xml
for this component:
[source,xml]
--------------------------------------------
org.apache.camelcamel-braintree${camel-version}
--------------------------------------------
??
[[Braintree-Options]]
Braintree Options
^^^^^^^^^^^^^^^^^
// component options: START
The Braintree component supports 1 options which are listed below.
{% raw %}
[width="100%",cols="2,1m,7",options="header"]
|=======================================================================
| Name | Java Type | Description
| configuration | BraintreeConfiguration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
// endpoint options: START
The Braintree component supports 15 endpoint options which are listed below:
{% raw %}
[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
| Name | Group | Default | Java Type | Description
| apiName | common | | BraintreeApiName | *Required* What kind of operation to perform
| methodName | common | | String | What sub operation to use for the selected operation
| environment | common | | String | *Required* The environment Either SANDBOX or PRODUCTION
| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body
| merchantId | common | | String | *Required* The merchant id provided by Braintree.
| privateKey | common | | String | *Required* The private key provided by Braintree.
| publicKey | common | | String | *Required* The public key provided by Braintree.
| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
| httpReadTimeout | advanced | | Integer | Set read timeout for http calls.
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
| httpLogLevel | logging | | String | Set logging level for http calls see java.util.logging.Level
| proxyHost | proxy | | String | The proxy host
| proxyPort | proxy | | Integer | The proxy port
|=======================================================================
{% endraw %}
// endpoint options: END
[[Braintree-URIformat]]
URI format
^^^^^^^^^^
??
[source,java]
---------------------------------------------
braintree://endpoint-prefix/endpoint?[options]
---------------------------------------------
??
Endpoint prefix can be one of:
* addOn
* address
* clientToken
* creditCardverification
* customer
* discount
* merchantAccount
* paymentmethod
* paymentmethodNonce
* plan
* settlementBatchSummary
* subscription
* transaction
* webhookNotification
??
[[Braintree-BraintreeComponent.1]]
BraintreeComponent
^^^^^^^^^^^^^^^^^^
The Braintree Component can be configured with the options below. These
options can be provided using the component's bean
property??*configuration*??of
type??*org.apache.camel.component.braintree.BraintreeConfiguration*.
[cols="<,<,<",options="header",]
|=======================================================================
|Option |Type |Description
|environment |String |value that specifies where requests should be
directed ??? sandbox or production
|merchantId |String |a unique identifier for your gateway account, which
is different than your merchant account ID
|publicKey |String |user-specific public identifier
|privateKey |String |user-specific secure identifier that should not be
shared ??? even with us!
|=======================================================================
All the options above are provided by Braintree Payments
[[Braintree-ProducerEndpoints:]]
Producer Endpoints:
^^^^^^^^^^^^^^^^^^^
Producer endpoints can use endpoint prefixes followed by endpoint names
and associated options described next. A shorthand alias can be used for
some endpoints. The endpoint URI MUST contain a prefix.
Endpoint options that are not mandatory are denoted by []. When there
are no mandatory options for an endpoint, one of the set of [] options
MUST be provided. Producer endpoints can also use a special
option??*inBody*??that in turn should contain the name of the endpoint
option whose value will be contained in the Camel Exchange In message.
Any of the endpoint options can be provided in either the endpoint URI,
or dynamically in a message header. The message header name must be of
the format??*CamelBraintree.