Alibaba Function Compute (FC)
Since Camel 4.23
Only producer is supported
The Alibaba Cloud Function Compute (FC) component allows you to invoke functions and retrieve function metadata.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-alibaba-fc</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency> Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.
For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
You can configure components using:
-
the Component DSL.
-
in a configuration file (
application.properties,*.yamlfiles, etc). -
directly in the Java code.
Configuring Endpoint Options
You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.
A good practice when configuring options is to use Property Placeholders.
Property placeholders provide a few benefits:
-
They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.
-
They allow externalizing the configuration from the code.
-
They help the code to become more flexible and reusable.
The following two sections list all the options, firstly for the component followed by the endpoint.
Component Options
The Alibaba Function Compute (FC) component supports the following options which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean | |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean | |
Used for enabling or disabling all consumer based health checks from this component. | true | boolean | |
Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. | true | boolean |
Endpoint Options
The Alibaba Function Compute (FC) endpoint is configured using URI syntax:
alibaba-fc:operation
With the following path and query parameters:
Path Parameters
| Name | Description | Default | Type |
|---|---|---|---|
Required The operation that the producer performs. The CamelAlibabaFcOperation header replaces this option for a request that the producer sends. If that header is not set, an exchange property of the same name replaces this option. Enum values:
| String |
Query Parameters
| Name | Description | Default | Type |
|---|---|---|---|
The endpoint of Function Compute, which is a host name without http:// or https://. The producer sends requests to it over HTTPS. If not set, the region option determines the endpoint, and one of the two is required. Not used when the fcClient option is set or autowired. | String | ||
The name of the function. The CamelAlibabaFcFunctionName header replaces this option for a request that the producer sends. If that header is not set, an exchange property of the same name replaces this option. One of the three is required. | String | ||
The version or alias of the service. The CamelAlibabaFcQualifier header replaces this option for a request that the producer sends. If that header is not set, an exchange property of the same name replaces this option. If none of the three is set, the producer adds no version or alias to the request. | String | ||
Required The region ID of Function Compute, for example cn-hangzhou. Only used when the endpoint option is not set, to build the endpoint of Function Compute. Not used when the fcClient option is set or autowired. | String | ||
The name of the service that contains the function. The CamelAlibabaFcServiceName header replaces this option for a request that the producer sends. If that header is not set, an exchange property of the same name replaces this option. One of the three is required. | String | ||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean | |
Autowired To use a custom com.aliyun.fc_open20210406.Client. The producer sends its requests with this client, and the region, endpoint, accessKey, secretKey and serviceKeys options are not used. If no client is set or autowired, the Camel endpoint creates a client from these options. It creates this client when the producer processes its first message. | Client | ||
The AccessKey ID of the AccessKey pair for the requests that the producer sends to Function Compute. If not set, the accessKey of the serviceKeys option is used, and one of the two is required. Not used when the fcClient option is set or autowired. | String | ||
The AccessKey secret of the AccessKey pair for the requests that the producer sends to Function Compute. If not set, the secretKey of the serviceKeys option is used, and one of the two is required. Not used when the fcClient option is set or autowired. | String | ||
The AccessKey pair as an org.apache.camel.component.alibaba.common.models.ServiceKeys. Its accessKey is the AccessKey ID and its secretKey is the AccessKey secret. Each of the two is used when the option of the same name is not set. Not used when the fcClient option is set or autowired. | ServiceKeys |
Message Headers
The Alibaba Function Compute (FC) component supports the following message header(s), which is/are listed below:
| Name | Description | Default | Type |
|---|---|---|---|
CamelAlibabaFcServiceName (producer) Constant: | The name of the service that contains the function. This header replaces the serviceName option. If this header is not set, an exchange property of the same name replaces the serviceName option. | String | |
CamelAlibabaFcFunctionName (producer) Constant: | The name of the function. This header replaces the functionName option. If this header is not set, an exchange property of the same name replaces the functionName option. | String | |
CamelAlibabaFcQualifier (producer) Constant: | The version or alias of the service. This header replaces the qualifier option. If this header is not set, an exchange property of the same name replaces the qualifier option. | String | |
CamelAlibabaFcRequestId (producer) Constant: | The request ID that Function Compute returns in the response to invokeFunction. The producer sets it for invokeFunction, unless the exchange fails. | String | |
CamelAlibabaFcStatusCode (producer) Constant: | The HTTP status code of the response to the operation. The producer sets it, unless the exchange fails. | Integer |
Message Body
The message body at each side of the Alibaba Function Compute (FC) component: Consumer is the body of the messages the consumer creates, Consumer reply the bodies a consumer that answers its caller can reply with, Producer input the bodies the producer can send or write, and Producer output the body after the producer.
| Side | Body | Description |
|---|---|---|
Producer input |
| invokeFunction sends the body as the payload of the function: text in UTF-8, bytes as they are, a stream or a file as its bytes, so binary data is kept, and no body as an empty payload. A Map or a POJO fails, as it does not convert to bytes, so marshal it first. getFunction does not use the body.
|
Producer output |
| A Map: for invokeFunction the statusCode, the headers and the body of the response, which holds the payload the function returns as bytes, with the status code in the CamelAlibabaFcStatusCode header too; for getFunction the fields of the function, such as functionName, runtime and handler. |
The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers, the sides and the tools that use them are described in Message Body Types.
Usage
Operations
The component supports the following operations:
-
invokeFunction- invoke a function with a payload (producer) -
getFunction- retrieve function metadata (producer)
Payload of invokeFunction
The message body is the payload of the function. A String is sent in UTF-8, and a byte[], an InputStream or a file is sent as its bytes, so binary data is kept. Without a body the function is invoked with an empty payload. A Map or a POJO does not convert to bytes and fails with an InvalidPayloadException, so marshal it first, for example to JSON with marshal().json().
Producer example
-
Java
-
YAML
from("direct:start")
.setBody(constant("{\"name\":\"camel\"}"))
.to("alibaba-fc:invokeFunction?serviceName=my-service&functionName=my-function®ion=cn-hangzhou&accessKey=RAW(accessKey)&secretKey=RAW(secretKey)"); - route:
from:
uri: direct:start
steps:
- setBody:
expression:
constant:
expression: '{"name":"camel"}'
- to:
uri: alibaba-fc:invokeFunction
parameters:
serviceName: my-service
functionName: my-function
region: cn-hangzhou
accessKey: "{{alibaba.access-key}}"
secretKey: "{{alibaba.secret-key}}"