This is an automated email from the ASF dual-hosted git repository. Croway pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit 293d5af0f5f718ab30c002df191934f3c9c3b947 Author: croway <[email protected]> AuthorDate: Tue Sep 15 13:40:58 2026 +0200 Add camel-ai-resource-starter camel-ai-resource registers Camel routes as read-only AI resources in the shared AiResourceRegistry but never got a Spring Boot starter. Generate it with starter-create and regenerate the docs, catalog and dependencies BOM entries. Add a smoke test verifying camel.component.ai-resource.* Spring Boot properties are copied onto the component's nested AiResourceConfiguration. Co-Authored-By: Claude Sonnet 5 <[email protected]> --- .../camel/springboot/catalog/components.properties | 1 + .../springboot/catalog/components/ai-resource.json | 47 +++++ .../camel-ai-resource-starter/pom.xml | 48 +++++ .../src/main/docs/ai-resource.json | 83 +++++++++ .../AiResourceComponentAutoConfiguration.java | 74 ++++++++ .../AiResourceComponentConfiguration.java | 162 ++++++++++++++++ .../springboot/AiResourceComponentConverter.java | 53 ++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 ++ ...rk.boot.autoconfigure.AutoConfiguration.imports | 18 ++ .../AiResourceComponentAutoConfigurationTest.java | 55 ++++++ components-starter/pom.xml | 1 + docs/spring-boot/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages/starters/ai-resource.adoc | 40 ++++ tooling/camel-spring-boot-dependencies/pom.xml | 5 + 15 files changed, 802 insertions(+) diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties index e2c864f336f..23d447d7cca 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties @@ -1,6 +1,7 @@ a2a activemq activemq6 +ai-resource ai-tool alibaba-eventbridge alibaba-fc diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ai-resource.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ai-resource.json new file mode 100644 index 00000000000..18004cc166c --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ai-resource.json @@ -0,0 +1,47 @@ +{ + "component": { + "kind": "component", + "name": "ai-resource", + "title": "AI Resource", + "description": "Framework-agnostic consumer endpoint that registers a Camel route as a read-only AI resource in the shared AiResourceRegistry.", + "deprecated": false, + "firstVersion": "4.23.0", + "label": "ai", + "javaType": "org.apache.camel.component.ai.resource.AiResourceComponent", + "supportLevel": "Preview", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-ai-resource-starter", + "version": "4.23.0-SNAPSHOT", + "scheme": "ai-resource", + "extendsScheme": "", + "syntax": "ai-resource:resourceName", + "async": false, + "api": false, + "consumerOnly": true, + "producerOnly": false, + "lenientProperties": false, + "browsable": false, + "remote": false + }, + "componentProperties": { + "bridgeErrorHandler": { "index": 0, "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the like [...] + "configuration": { "index": 1, "kind": "property", "displayName": "Configuration", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" }, + "description": { "index": 2, "kind": "property", "displayName": "Description", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "Human-readable description of what this resource contains. Passed verbatim [...] + "mimeType": { "index": 3, "kind": "property", "displayName": "Mime Type", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "text\/plain", "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "MIME type of the content the route produces. Typ [...] + "resourceUri": { "index": 4, "kind": "property", "displayName": "Resource Uri", "group": "consumer", "label": "consumer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "The resource uri clients use to read this resource, for example camel:\/\/ [...] + "tags": { "index": 5, "kind": "property", "displayName": "Tags", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "Comma-separated list of tags used to group resources. Adapters filter the registry by th [...] + "title": { "index": 6, "kind": "property", "displayName": "Title", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "Optional display title for resource listings. Advisory hint for clients only." }, + "autowiredEnabled": { "index": 7, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 t [...] + }, + "properties": { + "resourceName": { "index": 0, "kind": "path", "displayName": "Resource Name", "group": "consumer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The resource name. This is the human-readable label clients see in resource listings." }, + "description": { "index": 1, "kind": "parameter", "displayName": "Description", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "Human-readable description of what this resource contains. Passed verbati [...] + "mimeType": { "index": 2, "kind": "parameter", "displayName": "Mime Type", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "text\/plain", "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "MIME type of the content the route produces. Ty [...] + "resourceUri": { "index": 3, "kind": "parameter", "displayName": "Resource Uri", "group": "consumer", "label": "consumer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "The resource uri clients use to read this resource, for example camel:\/\ [...] + "tags": { "index": 4, "kind": "parameter", "displayName": "Tags", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "Comma-separated list of tags used to group resources. Adapters filter the registry by t [...] + "title": { "index": 5, "kind": "parameter", "displayName": "Title", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ai.resource.AiResourceConfiguration", "configurationField": "configuration", "description": "Optional display title for resource listings. Advisory hint for clients only." }, + "bridgeErrorHandler": { "index": 6, "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming [...] + "exceptionHandler": { "index": 7, "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By def [...] + "exchangePattern": { "index": 8, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "enum", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." } + } +} diff --git a/components-starter/camel-ai-resource-starter/pom.xml b/components-starter/camel-ai-resource-starter/pom.xml new file mode 100644 index 00000000000..815392e1bf5 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/pom.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>components-starter</artifactId> + <version>4.23.0-SNAPSHOT</version> + </parent> + <artifactId>camel-ai-resource-starter</artifactId> + <packaging>jar</packaging> + <name>Camel SB Starters :: ai-resource</name> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-ai-resource</artifactId> + <version>${camel-version}</version> + </dependency> + <!--START OF GENERATED CODE--> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-core-starter</artifactId> + </dependency> + <!--END OF GENERATED CODE--> + </dependencies> +</project> diff --git a/components-starter/camel-ai-resource-starter/src/main/docs/ai-resource.json b/components-starter/camel-ai-resource-starter/src/main/docs/ai-resource.json new file mode 100644 index 00000000000..67d44f4fd60 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/docs/ai-resource.json @@ -0,0 +1,83 @@ +{ + "groups": [ + { + "name": "camel.component.ai-resource", + "type": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + }, + { + "name": "camel.component.ai-resource.customizer", + "type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration", + "sourceMethod": "getCustomizer()" + } + ], + "properties": [ + { + "name": "camel.component.ai-resource.autowired-enabled", + "type": "java.lang.Boolean", + "description": "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.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration", + "defaultValue": true + }, + { + "name": "camel.component.ai-resource.bridge-error-handler", + "type": "java.lang.Boolean", + "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is n [...] + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration", + "defaultValue": false + }, + { + "name": "camel.component.ai-resource.configuration", + "type": "org.apache.camel.component.ai.resource.AiResourceConfiguration", + "description": "The component configuration. The option is a org.apache.camel.component.ai.resource.AiResourceConfiguration type.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + }, + { + "name": "camel.component.ai-resource.customizer.enabled", + "type": "java.lang.Boolean", + "sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties" + }, + { + "name": "camel.component.ai-resource.description", + "type": "java.lang.String", + "description": "Human-readable description of what this resource contains. Passed verbatim to the client. When omitted, defaults to the resource name.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + }, + { + "name": "camel.component.ai-resource.enabled", + "type": "java.lang.Boolean", + "description": "Whether to enable auto configuration of the ai-resource component. This is enabled by default.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + }, + { + "name": "camel.component.ai-resource.mime-type", + "type": "java.lang.String", + "description": "MIME type of the content the route produces. Types denoting text, such as any text subtype, application\/json, and any subtype ending in json, xml or yaml, are read as a string. Every other type is read as raw bytes and delivered to clients as a binary blob.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration", + "defaultValue": "text\/plain" + }, + { + "name": "camel.component.ai-resource.resource-uri", + "type": "java.lang.String", + "description": "The resource uri clients use to read this resource, for example camel:\/\/\/config\/app.json or s3:\/\/reports\/latest.pdf. It must be unique within the CamelContext and is what an MCP client sends in a resources\/read request.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + }, + { + "name": "camel.component.ai-resource.tags", + "type": "java.lang.String", + "description": "Comma-separated list of tags used to group resources. Adapters filter the registry by these tags to select which resources to expose. When omitted, the resource goes into a default pool which camel-mcp-server never exposes.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + }, + { + "name": "camel.component.ai-resource.title", + "type": "java.lang.String", + "description": "Optional display title for resource listings. Advisory hint for clients only.", + "sourceType": "org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration" + } + ], + "hints": [], + "ignored": { + "properties": [] + } +} \ No newline at end of file diff --git a/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentAutoConfiguration.java b/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentAutoConfiguration.java new file mode 100644 index 00000000000..00d5fc76e00 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentAutoConfiguration.java @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.ai.resource.springboot; + +import org.apache.camel.CamelContext; +import org.apache.camel.Component; +import org.apache.camel.component.ai.resource.AiResourceComponent; +import org.apache.camel.spi.ComponentCustomizer; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.spring.boot.ComponentConfigurationProperties; +import org.apache.camel.spring.boot.util.CamelPropertiesHelper; +import org.apache.camel.spring.boot.util.ConditionalOnCamelContextAndAutoConfigurationBeans; +import org.apache.camel.spring.boot.util.ConditionalOnHierarchicalProperties; +import org.apache.camel.spring.boot.util.HierarchicalPropertiesEvaluator; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Lazy; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@AutoConfiguration(after = {CamelAutoConfiguration.class, AiResourceComponentConverter.class}) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({ComponentConfigurationProperties.class,AiResourceComponentConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.component", "camel.component.ai-resource"}) +public class AiResourceComponentAutoConfiguration { + + private final ApplicationContext applicationContext; + private final AiResourceComponentConfiguration configuration; + + public AiResourceComponentAutoConfiguration( + org.springframework.context.ApplicationContext applicationContext, + org.apache.camel.component.ai.resource.springboot.AiResourceComponentConfiguration configuration) { + this.applicationContext = applicationContext; + this.configuration = configuration; + } + + @Lazy + @Bean + public ComponentCustomizer configureAiResourceComponent() { + return new ComponentCustomizer() { + @Override + public void configure(String name, Component target) { + CamelPropertiesHelper.copyConfigurationProperties(target.getCamelContext(), applicationContext, + "camel.component.ai-resource", configuration, target); + } + @Override + public boolean isEnabled(String name, Component target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.component.customizer", + "camel.component.ai-resource.customizer") + && target instanceof AiResourceComponent; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentConfiguration.java b/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentConfiguration.java new file mode 100644 index 00000000000..2de10e9e341 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentConfiguration.java @@ -0,0 +1,162 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.ai.resource.springboot; + +import org.apache.camel.component.ai.resource.AiResourceConfiguration; +import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Framework-agnostic consumer endpoint that registers a Camel route as a + * read-only AI resource in the shared AiResourceRegistry. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@ConfigurationProperties(prefix = "camel.component.ai-resource") +public class AiResourceComponentConfiguration + extends + ComponentConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the ai-resource component. This + * is enabled by default. + */ + private Boolean enabled; + /** + * Allows for bridging the consumer to the Camel routing Error Handler, + * which mean any exceptions (if possible) occurred while the Camel consumer + * is trying to pickup incoming messages, or the likes, will now be + * processed as a message and handled by the routing Error Handler. + * Important: This is only possible if the 3rd party component allows Camel + * to be alerted if an exception was thrown. Some components handle this + * internally only, and therefore bridgeErrorHandler is not possible. In + * other situations we may improve the Camel component to hook into the 3rd + * party component and make this possible for future releases. By default + * the consumer will use the org.apache.camel.spi.ExceptionHandler to deal + * with exceptions, that will be logged at WARN or ERROR level and ignored. + */ + private Boolean bridgeErrorHandler = false; + /** + * The component configuration. The option is a + * org.apache.camel.component.ai.resource.AiResourceConfiguration type. + */ + private AiResourceConfiguration configuration; + /** + * Human-readable description of what this resource contains. Passed + * verbatim to the client. When omitted, defaults to the resource name. + */ + private String description; + /** + * MIME type of the content the route produces. Types denoting text, such as + * any text subtype, application/json, and any subtype ending in json, xml + * or yaml, are read as a string. Every other type is read as raw bytes and + * delivered to clients as a binary blob. + */ + private String mimeType = "text/plain"; + /** + * The resource uri clients use to read this resource, for example + * camel:///config/app.json or s3://reports/latest.pdf. It must be unique + * within the CamelContext and is what an MCP client sends in a + * resources/read request. + */ + private String resourceUri; + /** + * Comma-separated list of tags used to group resources. Adapters filter the + * registry by these tags to select which resources to expose. When omitted, + * the resource goes into a default pool which camel-mcp-server never + * exposes. + */ + private String tags; + /** + * Optional display title for resource listings. Advisory hint for clients + * only. + */ + private String title; + /** + * 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. + */ + private Boolean autowiredEnabled = true; + + public Boolean getBridgeErrorHandler() { + return bridgeErrorHandler; + } + + public void setBridgeErrorHandler(Boolean bridgeErrorHandler) { + this.bridgeErrorHandler = bridgeErrorHandler; + } + + public AiResourceConfiguration getConfiguration() { + return configuration; + } + + public void setConfiguration(AiResourceConfiguration configuration) { + this.configuration = configuration; + } + + public String getDescription() { + return description; + } + + public void setDescription(String description) { + this.description = description; + } + + public String getMimeType() { + return mimeType; + } + + public void setMimeType(String mimeType) { + this.mimeType = mimeType; + } + + public String getResourceUri() { + return resourceUri; + } + + public void setResourceUri(String resourceUri) { + this.resourceUri = resourceUri; + } + + public String getTags() { + return tags; + } + + public void setTags(String tags) { + this.tags = tags; + } + + public String getTitle() { + return title; + } + + public void setTitle(String title) { + this.title = title; + } + + public Boolean getAutowiredEnabled() { + return autowiredEnabled; + } + + public void setAutowiredEnabled(Boolean autowiredEnabled) { + this.autowiredEnabled = autowiredEnabled; + } +} \ No newline at end of file diff --git a/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentConverter.java b/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentConverter.java new file mode 100644 index 00000000000..37dbdd79d85 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentConverter.java @@ -0,0 +1,53 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.ai.resource.springboot; + +import java.util.LinkedHashSet; +import java.util.Set; +import org.apache.camel.spring.boot.util.BeanReferenceHelper; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.ConfigurationPropertiesBinding; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.convert.TypeDescriptor; +import org.springframework.core.convert.converter.GenericConverter; +import org.springframework.stereotype.Component; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Configuration(proxyBeanMethods = false) +@ConfigurationPropertiesBinding +@Component +public class AiResourceComponentConverter implements GenericConverter { + + @Autowired + private ApplicationContext applicationContext; + + public Set<ConvertiblePair> getConvertibleTypes() { + Set<ConvertiblePair> answer = new LinkedHashSet<>(); + answer.add(new ConvertiblePair(String.class, org.apache.camel.component.ai.resource.AiResourceConfiguration.class)); + return answer; + } + + public Object convert( + Object source, + TypeDescriptor sourceType, + TypeDescriptor targetType) { + return BeanReferenceHelper.resolveBeanReference(applicationContext, source, targetType, "camel.component.ai-resource"); + } +} \ No newline at end of file diff --git a/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 00000000000..eb8cc6f39f6 --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,18 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- +org.apache.camel.component.ai.resource.springboot.AiResourceComponentConverter +org.apache.camel.component.ai.resource.springboot.AiResourceComponentAutoConfiguration diff --git a/components-starter/camel-ai-resource-starter/src/test/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentAutoConfigurationTest.java b/components-starter/camel-ai-resource-starter/src/test/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentAutoConfigurationTest.java new file mode 100644 index 00000000000..9f59814cf3a --- /dev/null +++ b/components-starter/camel-ai-resource-starter/src/test/java/org/apache/camel/component/ai/resource/springboot/AiResourceComponentAutoConfigurationTest.java @@ -0,0 +1,55 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.ai.resource.springboot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +import org.apache.camel.CamelContext; +import org.apache.camel.component.ai.resource.AiResourceComponent; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.test.spring.junit6.CamelSpringBootTest; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; + +@DirtiesContext +@CamelSpringBootTest +@SpringBootTest(classes = { CamelAutoConfiguration.class, AiResourceComponentAutoConfiguration.class }, + properties = { + "camel.component.ai-resource.mime-type = application/json", + "camel.component.ai-resource.tags = demo" }) +public class AiResourceComponentAutoConfigurationTest { + + @Autowired + CamelContext context; + + @Test + public void componentIsAutoConfigured() { + AiResourceComponent component + = assertInstanceOf(AiResourceComponent.class, context.getComponent("ai-resource")); + + // set through camel.component.ai-resource.*, so this asserts the Spring Boot + // properties are copied onto the component's nested AiResourceConfiguration by + // the starter + assertEquals("application/json", component.getConfiguration().getMimeType()); + assertEquals("demo", component.getConfiguration().getTags()); + } +} diff --git a/components-starter/pom.xml b/components-starter/pom.xml index 3d17ba47aa0..3d39d7cf0ea 100644 --- a/components-starter/pom.xml +++ b/components-starter/pom.xml @@ -109,6 +109,7 @@ <module>camel-activemq-starter</module> <module>camel-activemq6-starter</module> <module>camel-ai-observability-starter</module> + <module>camel-ai-resource-starter</module> <module>camel-ai-tool-starter</module> <module>camel-alibaba-eventbridge-starter</module> <module>camel-alibaba-fc-starter</module> diff --git a/docs/spring-boot/modules/ROOT/nav.adoc b/docs/spring-boot/modules/ROOT/nav.adoc index 7840d3172db..46212af7f9d 100644 --- a/docs/spring-boot/modules/ROOT/nav.adoc +++ b/docs/spring-boot/modules/ROOT/nav.adoc @@ -8,6 +8,7 @@ ** xref:starters/activemq.adoc[ActiveMQ 5.x] ** xref:starters/activemq6.adoc[ActiveMQ 6.x] ** xref:starters/ai-observability.adoc[Ai Observability] +** xref:starters/ai-resource.adoc[AI Resource] ** xref:starters/ai-tool.adoc[AI Tool] ** xref:starters/alibaba-eventbridge.adoc[Alibaba EventBridge] ** xref:starters/alibaba-fc.adoc[Alibaba Function Compute (FC)] diff --git a/docs/spring-boot/modules/ROOT/pages/starters/ai-resource.adoc b/docs/spring-boot/modules/ROOT/pages/starters/ai-resource.adoc new file mode 100644 index 00000000000..1928c4f1b0b --- /dev/null +++ b/docs/spring-boot/modules/ROOT/pages/starters/ai-resource.adoc @@ -0,0 +1,40 @@ +// Do not edit directly! +// This file was generated by camel-spring-boot-generator-maven-plugin += AI Resource +:artifactid: camel-ai-resource-starter + +Framework-agnostic consumer endpoint that registers a Camel route as a read-only AI resource in the shared AiResourceRegistry. + +== What's inside + +* xref:{csb-camel-components}::ai-resource-component.adoc[AI Resource component], URI syntax: `ai-resource:resourceName` + +Please refer to the above links for usage and configuration details. + +== Maven coordinates + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-ai-resource-starter</artifactId> +</dependency> +---- + +== Spring Boot Auto-Configuration + +The starter supports 9 options, which are listed below. + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| camel.component.ai-resource.autowired-enabled | 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 +| camel.component.ai-resource.bridge-error-handler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and th [...] +| camel.component.ai-resource.configuration | The component configuration. The option is a org.apache.camel.component.ai.resource.AiResourceConfiguration type. | | AiResourceConfiguration +| camel.component.ai-resource.description | Human-readable description of what this resource contains. Passed verbatim to the client. When omitted, defaults to the resource name. | | String +| camel.component.ai-resource.enabled | Whether to enable auto configuration of the ai-resource component. This is enabled by default. | | Boolean +| camel.component.ai-resource.mime-type | MIME type of the content the route produces. Types denoting text, such as any text subtype, application/json, and any subtype ending in json, xml or yaml, are read as a string. Every other type is read as raw bytes and delivered to clients as a binary blob. | text/plain | String +| camel.component.ai-resource.resource-uri | The resource uri clients use to read this resource, for example camel:///config/app.json or s3://reports/latest.pdf. It must be unique within the CamelContext and is what an MCP client sends in a resources/read request. | | String +| camel.component.ai-resource.tags | Comma-separated list of tags used to group resources. Adapters filter the registry by these tags to select which resources to expose. When omitted, the resource goes into a default pool which camel-mcp-server never exposes. | | String +| camel.component.ai-resource.title | Optional display title for resource listings. Advisory hint for clients only. | | String +|=== diff --git a/tooling/camel-spring-boot-dependencies/pom.xml b/tooling/camel-spring-boot-dependencies/pom.xml index bcab2876dfb..fa6142e09e0 100644 --- a/tooling/camel-spring-boot-dependencies/pom.xml +++ b/tooling/camel-spring-boot-dependencies/pom.xml @@ -372,6 +372,11 @@ <artifactId>camel-ai-observability-starter</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-ai-resource-starter</artifactId> + <version>${project.version}</version> + </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-ai-tool-starter</artifactId>
