Add component definition: once

This commit is contained in:
gitea_admin 2026-10-12 02:42:15 +00:00
parent bd07dc2207
commit 998dbb4033

314
component.json Normal file
View File

@ -0,0 +1,314 @@
{
"component": {
"kind": "component",
"name": "once",
"title": "Once",
"description": "Trigger a single message only once at startup (useful for development and testing purposes).",
"deprecated": false,
"firstVersion": "3.31.0",
"label": "core,scheduling",
"javaType": "org.apache.camel.component.once.OnceComponent",
"supportLevel": "Stable",
"nativeSupported": true,
"metadata": {
"quarkusVersion": "3.36.0",
"camelArtifact": "org.apache.camel:camel-once",
"camelVersion": "4.20.0"
},
"groupId": "org.apache.camel.quarkus",
"artifactId": "camel-quarkus-once",
"version": "4.20.0 (CEQ 3.36.0)",
"scheme": "once",
"extendsScheme": "",
"syntax": "once:name",
"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 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."
},
"autowiredEnabled": {
"index": 1,
"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 type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc."
},
"delay": {
"index": 2,
"kind": "property",
"displayName": "Delay",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1000,
"description": "The number of milliseconds to wait before triggering. Use 0 or negative to fire as soon as possible. The default value is 1000."
},
"languages": {
"index": 3,
"kind": "property",
"displayName": "Languages",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Whether Camel languages are supported such as simple,groovy."
}
},
"properties": {
"name": {
"index": 0,
"kind": "path",
"displayName": "Name",
"group": "consumer",
"label": "",
"required": true,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The logical name"
},
"body": {
"index": 1,
"kind": "parameter",
"displayName": "Body",
"group": "consumer",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"supportFileReference": true,
"description": "The data to use as message body. You can externalize the data by using file: or classpath: as prefix and specify the location of the file."
},
"headers": {
"index": 2,
"kind": "parameter",
"displayName": "Headers",
"group": "consumer",
"label": "",
"required": false,
"type": "object",
"javaType": "java.util.Map<java.lang.String, java.lang.String>",
"prefix": "header.",
"multiValue": true,
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"supportFileReference": true,
"description": "The data to use as message headers as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: header."
},
"bridgeErrorHandler": {
"index": 3,
"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 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."
},
"exceptionHandler": {
"index": 4,
"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 default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."
},
"exchangePattern": {
"index": 5,
"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."
},
"delay": {
"index": 6,
"kind": "parameter",
"displayName": "Delay",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1000,
"description": "The number of milliseconds to wait before triggering. The default value is 1000."
},
"exchangeProperties": {
"index": 7,
"kind": "parameter",
"displayName": "Exchange Properties",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "java.util.Map<java.lang.String, java.lang.String>",
"prefix": "exchangeProperty.",
"multiValue": true,
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"supportFileReference": true,
"description": "The data to use as exchange properties as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: exchangeProperty."
},
"variables": {
"index": 8,
"kind": "parameter",
"displayName": "Variables",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "java.util.Map<java.lang.String, java.lang.String>",
"prefix": "variable.",
"multiValue": true,
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"supportFileReference": true,
"description": "The data to use as exchange variables as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: variable."
}
},
"propertiesSchema": {
"properties": {
"name": {
"title": "Name",
"description": "The logical name",
"type": "string",
"$comment": "group:consumer"
},
"body": {
"title": "Body",
"description": "The data to use as message body. You can externalize the data by using file: or classpath: as prefix and specify the location of the file.",
"type": "string",
"$comment": "group:consumer"
},
"headers": {
"title": "Headers",
"description": "The data to use as message headers as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: header.",
"type": "object",
"$comment": "group:consumer"
},
"bridgeErrorHandler": {
"title": "Bridge Error Handler",
"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 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.",
"type": "boolean",
"$comment": "group:consumer (advanced)",
"default": false
},
"exceptionHandler": {
"title": "Exception Handler",
"description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.",
"type": "string",
"$comment": "group:consumer (advanced)",
"format": "bean:org.apache.camel.spi.ExceptionHandler"
},
"exchangePattern": {
"title": "Exchange Pattern",
"description": "Sets the exchange pattern when the consumer creates an exchange.",
"type": "string",
"enum": [
"InOnly",
"InOut"
],
"$comment": "group:consumer (advanced)"
},
"delay": {
"title": "Delay",
"description": "The number of milliseconds to wait before triggering. The default value is 1000.",
"type": "integer",
"$comment": "group:advanced",
"default": 1000
},
"exchangeProperties": {
"title": "Exchange Properties",
"description": "The data to use as exchange properties as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: exchangeProperty.",
"type": "object",
"$comment": "group:advanced"
},
"variables": {
"title": "Variables",
"description": "The data to use as exchange variables as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: variable.",
"type": "object",
"$comment": "group:advanced"
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"name"
]
}
}